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
,
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 _set_from_options_callback(
126 option
, opt_str
, value
, parser
,
127 delim
=',', allowed_values
=None, process
=str.lower
, aliases
={}):
128 current
= getattr(parser
.values
, option
.dest
)
129 values
= [process(value
)] if delim
is None else process(value
).split(delim
)[::-1]
131 actual_val
= val
= values
.pop()
133 current
.update(allowed_values
)
137 values
.extend(aliases
[val
])
143 current
.update([val
])
144 if allowed_values
is not None and val
not in allowed_values
:
145 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {actual_val}')
147 setattr(parser
.values
, option
.dest
, current
)
149 def _dict_from_options_callback(
150 option
, opt_str
, value
, parser
,
151 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True):
153 out_dict
= getattr(parser
.values
, option
.dest
)
155 allowed_keys
= r
'(%s)(,(%s))*' % (allowed_keys
, allowed_keys
)
156 mobj
= re
.match(r
'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
158 keys
= [k
.strip() for k
in mobj
.group('keys').lower().split(',')]
159 val
= mobj
.group('val')
160 elif default_key
is not None:
161 keys
, val
= [default_key
], value
163 raise optparse
.OptionValueError(
164 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
166 val
= process(val
) if process
else val
167 except Exception as err
:
168 raise optparse
.OptionValueError(
169 'wrong %s formatting; %s' % (opt_str
, err
))
173 # No need to wrap help messages if we're on a wide console
174 columns
= compat_get_terminal_size().columns
175 max_width
= columns
if columns
else 80
176 # 47% is chosen because that is how README.md is currently formatted
177 # and moving help text even further to the right is undesirable.
178 # This can be reduced in the future to get a prettier output
179 max_help_position
= int(0.47 * max_width
)
181 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
182 fmt
.format_option_strings
= _format_option_string
185 'version': __version__
,
187 'usage': '%prog [OPTIONS] URL [URL...]',
188 'conflict_handler': 'resolve',
191 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
193 general
= optparse
.OptionGroup(parser
, 'General Options')
197 help='Print this help text and exit')
201 help='Print program version and exit')
204 action
='store_true', dest
='update_self',
205 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
207 '-i', '--ignore-errors', '--no-abort-on-error',
208 action
='store_true', dest
='ignoreerrors', default
=None,
209 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
211 '--abort-on-error', '--no-ignore-errors',
212 action
='store_false', dest
='ignoreerrors',
213 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
216 action
='store_true', dest
='dump_user_agent', default
=False,
217 help='Display the current user-agent and exit')
220 action
='store_true', dest
='list_extractors', default
=False,
221 help='List all supported extractors and exit')
223 '--extractor-descriptions',
224 action
='store_true', dest
='list_extractor_descriptions', default
=False,
225 help='Output descriptions of all supported extractors and exit')
227 '--force-generic-extractor',
228 action
='store_true', dest
='force_generic_extractor', default
=False,
229 help='Force extraction to use the generic extractor')
232 dest
='default_search', metavar
='PREFIX',
233 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')
235 '--ignore-config', '--no-config',
238 'Disable loading any configuration files except the one provided by --config-location. '
239 'When given inside a configuration file, no further configuration files are loaded. '
240 'Additionally, (for backward compatibility) if this option is found inside the '
241 'system configuration file, the user configuration is not loaded'))
244 dest
='config_location', metavar
='PATH',
245 help='Location of the main configuration file; either the path to the config or its containing directory')
248 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
249 help='Do not extract the videos of a playlist, only list them')
251 '--no-flat-playlist',
252 action
='store_false', dest
='extract_flat',
253 help='Extract the videos of a playlist')
256 action
='store_true', dest
='mark_watched', default
=False,
257 help='Mark videos watched (YouTube only)')
260 action
='store_false', dest
='mark_watched',
261 help='Do not mark videos watched (default)')
264 action
='store_true', dest
='no_color', default
=False,
265 help='Do not emit color codes in output')
268 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
269 action
='callback', callback
=_set_from_options_callback
,
272 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
273 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
274 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json',
275 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs',
278 'youtube-dl': ['-multistreams', 'all'],
279 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
282 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
283 'configurations by reverting some of the changes made in yt-dlp. '
284 'See "Differences in default behavior" for details'))
286 network
= optparse
.OptionGroup(parser
, 'Network Options')
288 '--proxy', dest
='proxy',
289 default
=None, metavar
='URL',
291 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
292 'SOCKS proxy, specify a proper scheme. For example '
293 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
294 'for direct connection'))
297 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
298 help='Time to wait before giving up, in seconds')
301 metavar
='IP', dest
='source_address', default
=None,
302 help='Client-side IP address to bind to',
305 '-4', '--force-ipv4',
306 action
='store_const', const
='0.0.0.0', dest
='source_address',
307 help='Make all connections via IPv4',
310 '-6', '--force-ipv6',
311 action
='store_const', const
='::', dest
='source_address',
312 help='Make all connections via IPv6',
315 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
317 '--geo-verification-proxy',
318 dest
='geo_verification_proxy', default
=None, metavar
='URL',
320 'Use this proxy to verify the IP address for some geo-restricted sites. '
321 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
323 '--cn-verification-proxy',
324 dest
='cn_verification_proxy', default
=None, metavar
='URL',
325 help=optparse
.SUPPRESS_HELP
)
328 action
='store_true', dest
='geo_bypass', default
=True,
329 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
332 action
='store_false', dest
='geo_bypass', default
=True,
333 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
335 '--geo-bypass-country', metavar
='CODE',
336 dest
='geo_bypass_country', default
=None,
337 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
339 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
340 dest
='geo_bypass_ip_block', default
=None,
341 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
343 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
344 selection
.add_option(
346 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
347 help='Playlist video to start at (default is %default)')
348 selection
.add_option(
350 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
351 help='Playlist video to end at (default is last)')
352 selection
.add_option(
354 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
355 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')
356 selection
.add_option(
358 dest
='matchtitle', metavar
='REGEX',
359 help='Download only matching titles (regex or caseless sub-string)')
360 selection
.add_option(
362 dest
='rejecttitle', metavar
='REGEX',
363 help='Skip download for matching titles (regex or caseless sub-string)')
364 selection
.add_option(
366 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
367 help='Abort after downloading NUMBER files')
368 selection
.add_option(
370 metavar
='SIZE', dest
='min_filesize', default
=None,
371 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
372 selection
.add_option(
374 metavar
='SIZE', dest
='max_filesize', default
=None,
375 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
376 selection
.add_option(
378 metavar
='DATE', dest
='date', default
=None,
380 'Download only videos uploaded in this date. '
381 'The date can be "YYYYMMDD" or in the format '
382 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
383 selection
.add_option(
385 metavar
='DATE', dest
='datebefore', default
=None,
387 'Download only videos uploaded on or before this date. '
388 'The date formats accepted is the same as --date'))
389 selection
.add_option(
391 metavar
='DATE', dest
='dateafter', default
=None,
393 'Download only videos uploaded on or after this date. '
394 'The date formats accepted is the same as --date'))
395 selection
.add_option(
397 metavar
='COUNT', dest
='min_views', default
=None, type=int,
398 help='Do not download any videos with less than COUNT views')
399 selection
.add_option(
401 metavar
='COUNT', dest
='max_views', default
=None, type=int,
402 help='Do not download any videos with more than COUNT views')
403 selection
.add_option(
405 metavar
='FILTER', dest
='match_filter', default
=None,
407 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
408 'number or a string using the operators defined in "Filtering formats". '
409 'You can also simply specify a field to match if the field is present '
410 'and "!field" to check if the field is not present. In addition, '
411 'Python style regular expression matching can be done using "~=", '
412 'and multiple filters can be checked with "&". '
413 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
414 r
'"!is_live & like_count>?100 & description~=\'(?i
)\bcats \
& dogs
\b\'" '
415 'matches only videos that are not live, has a like count more than 100 '
416 '(or the like field is not available), and also has a description '
417 'that contains the phrase "cats
& dogs
" (ignoring case)'))
418 selection.add_option(
420 metavar='FILTER', dest='match_filter', action='store_const', const=None,
421 help='Do not use generic video filter (default)')
422 selection.add_option(
424 action='store_true', dest='noplaylist', default=False,
425 help='Download only the video, if the URL refers to a video and a playlist')
426 selection.add_option(
428 action='store_false', dest='noplaylist',
429 help='Download the playlist, if the URL refers to a video and a playlist')
430 selection.add_option(
432 metavar='YEARS', dest='age_limit', default=None, type=int,
433 help='Download only videos suitable for the given age')
434 selection.add_option(
435 '--download-archive', metavar='FILE',
436 dest='download_archive',
437 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
438 selection.add_option(
439 '--break-on-existing',
440 action='store_true', dest='break_on_existing', default=False,
441 help='Stop the download process when encountering a file that is in the archive')
442 selection.add_option(
444 action='store_true', dest='break_on_reject', default=False,
445 help='Stop the download process when encountering a file that has been filtered out')
446 selection.add_option(
447 '--skip-playlist-after-errors', metavar='N',
448 dest='skip_playlist_after_errors', default=None, type=int,
449 help='Number of allowed failures until the rest of the playlist is skipped')
450 selection.add_option(
451 '--no-download-archive',
452 dest='download_archive', action="store_const
", const=None,
453 help='Do not use archive file (default)')
454 selection.add_option(
456 dest='include_ads', action='store_true',
457 help=optparse.SUPPRESS_HELP)
458 selection.add_option(
460 dest='include_ads', action='store_false',
461 help=optparse.SUPPRESS_HELP)
463 authentication = optparse.OptionGroup(parser, 'Authentication Options')
464 authentication.add_option(
466 dest='username', metavar='USERNAME',
467 help='Login with this account ID')
468 authentication.add_option(
470 dest='password', metavar='PASSWORD',
471 help='Account password. If this option is left out, yt-dlp will ask interactively')
472 authentication.add_option(
474 dest='twofactor', metavar='TWOFACTOR',
475 help='Two-factor authentication code')
476 authentication.add_option(
478 action='store_true', dest='usenetrc', default=False,
479 help='Use .netrc authentication data')
480 authentication.add_option(
482 dest='videopassword', metavar='PASSWORD',
483 help='Video password (vimeo, youku)')
484 authentication.add_option(
486 dest='ap_mso', metavar='MSO',
487 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
488 authentication.add_option(
490 dest='ap_username', metavar='USERNAME',
491 help='Multiple-system operator account login')
492 authentication.add_option(
494 dest='ap_password', metavar='PASSWORD',
495 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
496 authentication.add_option(
498 action='store_true', dest='ap_list_mso', default=False,
499 help='List all supported multiple-system operators')
501 video_format = optparse.OptionGroup(parser, 'Video Format Options')
502 video_format.add_option(
504 action='store', dest='format', metavar='FORMAT', default=None,
505 help='Video format code, see "FORMAT SELECTION
" for more details')
506 video_format.add_option(
507 '-S', '--format-sort', metavar='SORTORDER',
508 dest='format_sort', default=[], type='str', action='callback',
509 callback=_list_from_options_callback, callback_kwargs={'append': -1},
510 help='Sort the formats by the fields given, see "Sorting Formats
" for more details')
511 video_format.add_option(
512 '--format-sort-force', '--S-force',
513 action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
515 'Force user specified sort order to have precedence over all fields, '
516 'see "Sorting Formats
" for more details'))
517 video_format.add_option(
518 '--no-format-sort-force',
519 action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
521 'Some fields have precedence over the user specified sort order (default), '
522 'see "Sorting Formats
" for more details'))
523 video_format.add_option(
524 '--video-multistreams',
525 action='store_true', dest='allow_multiple_video_streams', default=None,
526 help='Allow multiple video streams to be merged into a single file')
527 video_format.add_option(
528 '--no-video-multistreams',
529 action='store_false', dest='allow_multiple_video_streams',
530 help='Only one video stream is downloaded for each output file (default)')
531 video_format.add_option(
532 '--audio-multistreams',
533 action='store_true', dest='allow_multiple_audio_streams', default=None,
534 help='Allow multiple audio streams to be merged into a single file')
535 video_format.add_option(
536 '--no-audio-multistreams',
537 action='store_false', dest='allow_multiple_audio_streams',
538 help='Only one audio stream is downloaded for each output file (default)')
539 video_format.add_option(
541 action='store_const', dest='format', const='all',
542 help=optparse.SUPPRESS_HELP)
543 video_format.add_option(
544 '--prefer-free-formats',
545 action='store_true', dest='prefer_free_formats', default=False,
547 'Prefer video formats with free containers over non-free ones of same quality. '
548 'Use with "-S ext
" to strictly prefer free containers irrespective of quality'))
549 video_format.add_option(
550 '--no-prefer-free-formats',
551 action='store_true', dest='prefer_free_formats', default=False,
552 help="Don
't give any special preference to free containers (default)")
553 video_format.add_option(
555 action='store_true
', dest='check_formats
', default=None,
556 help='Check that the formats selected are actually downloadable
')
557 video_format.add_option(
558 '--no
-check
-formats
',
559 action='store_false
', dest='check_formats
',
560 help='Do
not check that the formats selected are actually downloadable
')
561 video_format.add_option(
562 '-F
', '--list-formats
',
563 action='store_true
', dest='listformats
',
564 help='List available formats of each video
. Simulate unless
--no
-simulate
is used
')
565 video_format.add_option(
566 '--list-formats
-as-table
',
567 action='store_true
', dest='listformats_table
', default=True,
568 help=optparse.SUPPRESS_HELP)
569 video_format.add_option(
570 '--list-formats
-old
', '--no
-list-formats
-as-table
',
571 action='store_false
', dest='listformats_table
',
572 help=optparse.SUPPRESS_HELP)
573 video_format.add_option(
574 '--merge
-output
-format
',
575 action='store
', dest='merge_output_format
', metavar='FORMAT
', default=None,
577 'If a merge
is required (e
.g
. bestvideo
+bestaudio
), '
578 'output to given container format
. One of mkv
, mp4
, ogg
, webm
, flv
. '
579 'Ignored
if no merge
is required
'))
580 video_format.add_option(
581 '--allow
-unplayable
-formats
',
582 action='store_true
', dest='allow_unplayable_formats
', default=False,
584 'Allow unplayable formats to be listed
and downloaded
. '
585 'All video post
-processing will also be turned off
'))
586 video_format.add_option(
587 '--no
-allow
-unplayable
-formats
',
588 action='store_false
', dest='allow_unplayable_formats
',
589 help='Do
not allow unplayable formats to be listed
or downloaded (default
)')
591 subtitles = optparse.OptionGroup(parser, 'Subtitle Options
')
592 subtitles.add_option(
593 '--write
-subs
', '--write
-srt
',
594 action='store_true
', dest='writesubtitles
', default=False,
595 help='Write subtitle
file')
596 subtitles.add_option(
597 '--no
-write
-subs
', '--no
-write
-srt
',
598 action='store_false
', dest='writesubtitles
',
599 help='Do
not write subtitle
file (default
)')
600 subtitles.add_option(
601 '--write
-auto
-subs
', '--write
-automatic
-subs
',
602 action='store_true
', dest='writeautomaticsub
', default=False,
603 help='Write automatically generated subtitle
file (Alias
: --write
-automatic
-subs
)')
604 subtitles.add_option(
605 '--no
-write
-auto
-subs
', '--no
-write
-automatic
-subs
',
606 action='store_false
', dest='writeautomaticsub
', default=False,
607 help='Do
not write auto
-generated
subtitles (default
) (Alias
: --no
-write
-automatic
-subs
)')
608 subtitles.add_option(
610 action='store_true
', dest='allsubtitles
', default=False,
611 help=optparse.SUPPRESS_HELP)
612 subtitles.add_option(
614 action='store_true
', dest='listsubtitles
', default=False,
615 help='List available subtitles of each video
. Simulate unless
--no
-simulate
is used
')
616 subtitles.add_option(
618 action='store
', dest='subtitlesformat
', metavar='FORMAT
', default='best
',
619 help='Subtitle format
, accepts formats preference
, for example
: "srt" or "ass/srt/best"')
620 subtitles.add_option(
621 '--sub
-langs
', '--srt
-langs
',
622 action='callback
', dest='subtitleslangs
', metavar='LANGS
', type='str',
623 default=[], callback=_list_from_options_callback,
625 'Languages of the subtitles to
download (can be regex
) or "all" separated by commas
. (Eg
: --sub
-langs en
.*,ja
) '
626 'You can prefix the language code
with a
"-" to exempt it
from the requested languages
. (Eg
: --sub
-langs all
,-live_chat
) '
627 'Use
--list-subs
for a
list of available language tags
'))
629 downloader = optparse.OptionGroup(parser, 'Download Options
')
630 downloader.add_option(
631 '-N
', '--concurrent
-fragments
',
632 dest='concurrent_fragment_downloads
', metavar='N
', default=1, type=int,
633 help='Number of fragments of a dash
/hlsnative video that should be download
concurrently (default
is %default
)')
634 downloader.add_option(
635 '-r
', '--limit
-rate
', '--rate
-limit
',
636 dest='ratelimit
', metavar='RATE
',
637 help='Maximum download rate
in bytes per
second (e
.g
. 50K
or 4.2M
)')
638 downloader.add_option(
640 dest='throttledratelimit
', metavar='RATE
',
641 help='Minimum download rate
in bytes per second below which throttling
is assumed
and the video data
is re
-extracted (e
.g
. 100K
)')
642 downloader.add_option(
644 dest='retries
', metavar='RETRIES
', default=10,
645 help='Number of
retries (default
is %default
), or "infinite"')
646 downloader.add_option(
647 '--fragment
-retries
',
648 dest='fragment_retries
', metavar='RETRIES
', default=10,
649 help='Number of retries
for a
fragment (default
is %default
), or "infinite" (DASH
, hlsnative
and ISM
)')
650 downloader.add_option(
651 '--skip
-unavailable
-fragments
', '--no
-abort
-on
-unavailable
-fragment
',
652 action='store_true
', dest='skip_unavailable_fragments
', default=True,
653 help='Skip unavailable fragments
for DASH
, hlsnative
and ISM (default
) (Alias
: --no
-abort
-on
-unavailable
-fragment
)')
654 downloader.add_option(
655 '--abort
-on
-unavailable
-fragment
', '--no
-skip
-unavailable
-fragments
',
656 action='store_false
', dest='skip_unavailable_fragments
',
657 help='Abort downloading
if a fragment
is unavailable (Alias
: --no
-skip
-unavailable
-fragments
)')
658 downloader.add_option(
660 action='store_true
', dest='keep_fragments
', default=False,
661 help='Keep downloaded fragments on disk after downloading
is finished
')
662 downloader.add_option(
663 '--no
-keep
-fragments
',
664 action='store_false
', dest='keep_fragments
',
665 help='Delete downloaded fragments after downloading
is finished (default
)')
666 downloader.add_option(
668 dest='buffersize
', metavar='SIZE
', default='1024',
669 help='Size of download
buffer (e
.g
. 1024 or 16K
) (default
is %default
)')
670 downloader.add_option(
672 action='store_false
', dest='noresizebuffer
',
673 help='The
buffer size
is automatically resized
from an initial value of
--buffer-size (default
)')
674 downloader.add_option(
675 '--no
-resize
-buffer',
676 action='store_true
', dest='noresizebuffer
', default=False,
677 help='Do
not automatically adjust the
buffer size
')
678 downloader.add_option(
680 dest='http_chunk_size
', metavar='SIZE
', default=None,
682 'Size of a chunk
for chunk
-based HTTP
downloading (e
.g
. 10485760 or 10M
) (default
is disabled
). '
683 'May be useful
for bypassing bandwidth throttling imposed by a
webserver (experimental
)'))
684 downloader.add_option(
686 action='store_true
', dest='test
', default=False,
687 help=optparse.SUPPRESS_HELP)
688 downloader.add_option(
689 '--playlist
-reverse
',
691 help='Download playlist videos
in reverse order
')
692 downloader.add_option(
693 '--no
-playlist
-reverse
',
694 action='store_false
', dest='playlist_reverse
',
695 help='Download playlist videos
in default
order (default
)')
696 downloader.add_option(
699 help='Download playlist videos
in random order
')
700 downloader.add_option(
701 '--xattr
-set-filesize
',
702 dest='xattr_set_filesize
', action='store_true
',
703 help='Set
file xattribute ytdl
.filesize
with expected
file size
')
704 downloader.add_option(
705 '--hls
-prefer
-native
',
706 dest='hls_prefer_native
', action='store_true
', default=None,
707 help=optparse.SUPPRESS_HELP)
708 downloader.add_option(
709 '--hls
-prefer
-ffmpeg
',
710 dest='hls_prefer_native
', action='store_false
', default=None,
711 help=optparse.SUPPRESS_HELP)
712 downloader.add_option(
714 dest='hls_use_mpegts
', action='store_true
', default=None,
716 'Use the mpegts container
for HLS videos
; '
717 'allowing some players to play the video
while downloading
, '
718 'and reducing the chance of
file corruption
if download
is interrupted
. '
719 'This
is enabled by default
for live streams
'))
720 downloader.add_option(
721 '--no
-hls
-use
-mpegts
',
722 dest='hls_use_mpegts
', action='store_false
',
724 'Do
not use the mpegts container
for HLS videos
. '
725 'This
is default when
not downloading live streams
'))
726 downloader.add_option(
727 '--downloader
', '--external
-downloader
',
728 dest='external_downloader
', metavar='[PROTO
:]NAME
', default={}, type='str',
729 action='callback
', callback=_dict_from_options_callback,
731 'allowed_keys
': 'http|ftp|m3u8|dash|rtsp|rtmp|mms
',
732 'default_key
': 'default
',
735 'Name
or path of the external downloader to
use (optionally
) prefixed by
'
736 'the
protocols (http
, ftp
, m3u8
, dash
, rstp
, rtmp
, mms
) to use it
for. '
737 'Currently supports native
, %s (Recommended
: aria2c
). '
738 'You can use this option multiple times to
set different downloaders
for different protocols
. '
739 'For example
, --downloader aria2c
--downloader
"dash,m3u8:native" will use
'
740 'aria2c
for http
/ftp downloads
, and the native downloader
for dash
/m3u8 downloads
'
741 '(Alias
: --external
-downloader
)' % ', '.join(list_external_downloaders())))
742 downloader.add_option(
743 '--downloader
-args
', '--external
-downloader
-args
',
744 metavar='NAME
:ARGS
', dest='external_downloader_args
', default={}, type='str',
745 action='callback
', callback=_dict_from_options_callback,
747 'allowed_keys
': '|
'.join(list_external_downloaders()),
748 'default_key
': 'default
',
749 'process
': compat_shlex_split
751 'Give these arguments to the external downloader
. '
752 'Specify the downloader name
and the arguments separated by a colon
":". '
753 'You can use this option multiple times to give different arguments to different downloaders
'
754 '(Alias
: --external
-downloader
-args
)'))
756 workarounds = optparse.OptionGroup(parser, 'Workarounds
')
757 workarounds.add_option(
759 dest='encoding
', metavar='ENCODING
',
760 help='Force the specified
encoding (experimental
)')
761 workarounds.add_option(
762 '--no
-check
-certificate
',
763 action='store_true
', dest='no_check_certificate
', default=False,
764 help='Suppress HTTPS certificate validation
')
765 workarounds.add_option(
766 '--prefer
-insecure
', '--prefer
-unsecure
',
767 action='store_true
', dest='prefer_insecure
',
768 help='Use an unencrypted connection to retrieve information about the
video (Currently supported only
for YouTube
)')
769 workarounds.add_option(
771 metavar='UA
', dest='user_agent
',
772 help='Specify a custom user agent
')
773 workarounds.add_option(
775 metavar='URL
', dest='referer
', default=None,
776 help='Specify a custom referer
, use
if the video access
is restricted to one domain
',
778 workarounds.add_option(
780 metavar='FIELD
:VALUE
', dest='headers
', default={}, type='str',
781 action='callback
', callback=_dict_from_options_callback,
782 callback_kwargs={'multiple_keys': False},
783 help='Specify a custom HTTP header
and its value
, separated by a colon
":". You can use this option multiple times
',
785 workarounds.add_option(
787 dest='bidi_workaround
', action='store_true
',
788 help='Work around terminals that lack bidirectional text support
. Requires bidiv
or fribidi executable
in PATH
')
789 workarounds.add_option(
790 '--sleep
-requests
', metavar='SECONDS
',
791 dest='sleep_interval_requests
', type=float,
792 help='Number of seconds to sleep between requests during data extraction
')
793 workarounds.add_option(
794 '--sleep
-interval
', '--min-sleep
-interval
', metavar='SECONDS
',
795 dest='sleep_interval
', type=float,
797 'Number of seconds to sleep before each download
. '
798 'This
is the minimum time to sleep when used along
with --max-sleep
-interval
'
799 '(Alias
: --min-sleep
-interval
)'))
800 workarounds.add_option(
801 '--max-sleep
-interval
', metavar='SECONDS
',
802 dest='max_sleep_interval
', type=float,
803 help='Maximum number of seconds to sleep
. Can only be used along
with --min-sleep
-interval
')
804 workarounds.add_option(
805 '--sleep
-subtitles
', metavar='SECONDS
',
806 dest='sleep_interval_subtitles
', default=0, type=int,
807 help='Number of seconds to sleep before each subtitle download
')
809 verbosity = optparse.OptionGroup(parser, 'Verbosity
and Simulation Options
')
810 verbosity.add_option(
812 action='store_true
', dest='quiet
', default=False,
813 help='Activate quiet mode
. If used
with --verbose
, print the log to stderr
')
814 verbosity.add_option(
816 dest='no_warnings
', action='store_true
', default=False,
817 help='Ignore warnings
')
818 verbosity.add_option(
820 action='store_true
', dest='simulate
', default=None,
821 help='Do
not download the video
and do
not write anything to disk
')
822 verbosity.add_option(
824 action='store_false
', dest='simulate
',
825 help='Download the video even
if printing
/listing options are used
')
826 verbosity.add_option(
827 '--ignore
-no
-formats
-error
',
828 action='store_true
', dest='ignore_no_formats_error
', default=False,
830 'Ignore
"No video formats" error
. Usefull
for extracting metadata
'
831 'even
if the videos are
not actually available
for download (experimental
)'))
832 verbosity.add_option(
833 '--no
-ignore
-no
-formats
-error
',
834 action='store_false
', dest='ignore_no_formats_error
',
835 help='Throw error when no downloadable video formats are
found (default
)')
836 verbosity.add_option(
837 '--skip
-download
', '--no
-download
',
838 action='store_true
', dest='skip_download
', default=False,
839 help='Do
not download the video but write all related
files (Alias
: --no
-download
)')
840 verbosity.add_option(
842 metavar='TEMPLATE
', action='append
', dest='forceprint
',
844 'Quiet
, but
print the given fields
for each video
. Simulate unless
--no
-simulate
is used
. '
845 'Either a field name
or same syntax
as the output template can be used
'))
846 verbosity.add_option(
848 action='store_true
', dest='geturl
', default=False,
849 help=optparse.SUPPRESS_HELP)
850 verbosity.add_option(
852 action='store_true
', dest='gettitle
', default=False,
853 help=optparse.SUPPRESS_HELP)
854 verbosity.add_option(
856 action='store_true
', dest='getid
', default=False,
857 help=optparse.SUPPRESS_HELP)
858 verbosity.add_option(
860 action='store_true
', dest='getthumbnail
', default=False,
861 help=optparse.SUPPRESS_HELP)
862 verbosity.add_option(
864 action='store_true
', dest='getdescription
', default=False,
865 help=optparse.SUPPRESS_HELP)
866 verbosity.add_option(
868 action='store_true
', dest='getduration
', default=False,
869 help=optparse.SUPPRESS_HELP)
870 verbosity.add_option(
872 action='store_true
', dest='getfilename
', default=False,
873 help=optparse.SUPPRESS_HELP)
874 verbosity.add_option(
876 action='store_true
', dest='getformat
', default=False,
877 help=optparse.SUPPRESS_HELP)
878 verbosity.add_option(
880 action='store_true
', dest='dumpjson
', default=False,
881 help='Quiet
, but
print JSON information
for each video
. Simulate unless
--no
-simulate
is used
. See
"OUTPUT TEMPLATE" for a description of available keys
')
882 verbosity.add_option(
883 '-J
', '--dump
-single
-json
',
884 action='store_true
', dest='dump_single_json
', default=False,
886 'Quiet
, but
print JSON information
for each url
or infojson passed
. Simulate unless
--no
-simulate
is used
. '
887 'If the URL refers to a playlist
, the whole playlist information
is dumped
in a single line
'))
888 verbosity.add_option(
890 action='store_true
', dest='print_json
', default=False,
891 help=optparse.SUPPRESS_HELP)
892 verbosity.add_option(
893 '--force
-write
-archive
', '--force
-write
-download
-archive
', '--force
-download
-archive
',
894 action='store_true
', dest='force_write_download_archive
', default=False,
896 'Force download archive entries to be written
as far
as no errors occur
, '
897 'even
if -s
or another simulation option
is used (Alias
: --force
-download
-archive
)'))
898 verbosity.add_option(
900 action='store_true
', dest='progress_with_newline
', default=False,
901 help='Output progress bar
as new lines
')
902 verbosity.add_option(
904 action='store_true
', dest='noprogress
', default=False,
905 help='Do
not print progress bar
')
906 verbosity.add_option(
908 action='store_true
', dest='consoletitle
', default=False,
909 help='Display progress
in console titlebar
')
910 verbosity.add_option(
912 action='store_true
', dest='verbose
', default=False,
913 help='Print various debugging information
')
914 verbosity.add_option(
915 '--dump
-pages
', '--dump
-intermediate
-pages
',
916 action='store_true
', dest='dump_intermediate_pages
', default=False,
917 help='Print downloaded pages encoded using base64 to debug
problems (very verbose
)')
918 verbosity.add_option(
920 action='store_true
', dest='write_pages
', default=False,
921 help='Write downloaded intermediary pages to files
in the current directory to debug problems
')
922 verbosity.add_option(
923 '--youtube
-print-sig
-code
',
924 action='store_true
', dest='youtube_print_sig_code
', default=False,
925 help=optparse.SUPPRESS_HELP)
926 verbosity.add_option(
927 '--print-traffic
', '--dump
-headers
',
928 dest='debug_printtraffic
', action='store_true
', default=False,
929 help='Display sent
and read HTTP traffic
')
930 verbosity.add_option(
932 dest='call_home
', action='store_true
', default=False,
933 # help='[Broken
] Contact the yt
-dlp server
for debugging
')
934 help=optparse.SUPPRESS_HELP)
935 verbosity.add_option(
937 dest='call_home
', action='store_false
',
938 # help='Do
not contact the yt
-dlp server
for debugging (default
)')
939 help=optparse.SUPPRESS_HELP)
941 filesystem = optparse.OptionGroup(parser, 'Filesystem Options
')
942 filesystem.add_option(
943 '-a
', '--batch
-file',
944 dest='batchfile
', metavar='FILE
',
945 help="File containing URLs to download ('-' for stdin), one URL per line. "
946 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
947 filesystem
.add_option(
948 '--id', default
=False,
949 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
950 filesystem
.add_option(
952 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
953 action
='callback', callback
=_dict_from_options_callback
,
955 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
956 'default_key': 'home'
958 'The paths where the files should be downloaded. '
959 'Specify the type of file and the path separated by a colon ":". '
960 'All the same types as --output are supported. '
961 'Additionally, you can also provide "home" (default) and "temp" paths. '
962 'All intermediary files are first downloaded to the temp path and '
963 'then the final files are moved over to the home path after download is finished. '
964 'This option is ignored if --output is an absolute path'))
965 filesystem
.add_option(
967 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
968 action
='callback', callback
=_dict_from_options_callback
,
970 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
971 'default_key': 'default'
972 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
973 filesystem
.add_option(
974 '--output-na-placeholder',
975 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
976 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
977 filesystem
.add_option(
979 dest
='autonumber_size', metavar
='NUMBER', type=int,
980 help=optparse
.SUPPRESS_HELP
)
981 filesystem
.add_option(
982 '--autonumber-start',
983 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
984 help=optparse
.SUPPRESS_HELP
)
985 filesystem
.add_option(
986 '--restrict-filenames',
987 action
='store_true', dest
='restrictfilenames', default
=False,
988 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
989 filesystem
.add_option(
990 '--no-restrict-filenames',
991 action
='store_false', dest
='restrictfilenames',
992 help='Allow Unicode characters, "&" and spaces in filenames (default)')
993 filesystem
.add_option(
994 '--windows-filenames',
995 action
='store_true', dest
='windowsfilenames', default
=False,
996 help='Force filenames to be windows compatible')
997 filesystem
.add_option(
998 '--no-windows-filenames',
999 action
='store_false', dest
='windowsfilenames',
1000 help='Make filenames windows compatible only if using windows (default)')
1001 filesystem
.add_option(
1002 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1003 dest
='trim_file_name', default
=0, type=int,
1004 help='Limit the filename length (excluding extension) to the specified number of characters')
1005 filesystem
.add_option(
1007 action
='store_true', dest
='autonumber', default
=False,
1008 help=optparse
.SUPPRESS_HELP
)
1009 filesystem
.add_option(
1011 action
='store_true', dest
='usetitle', default
=False,
1012 help=optparse
.SUPPRESS_HELP
)
1013 filesystem
.add_option(
1014 '--literal', default
=False,
1015 action
='store_true', dest
='usetitle',
1016 help=optparse
.SUPPRESS_HELP
)
1017 filesystem
.add_option(
1018 '-w', '--no-overwrites',
1019 action
='store_false', dest
='overwrites', default
=None,
1020 help='Do not overwrite any files')
1021 filesystem
.add_option(
1022 '--force-overwrites', '--yes-overwrites',
1023 action
='store_true', dest
='overwrites',
1024 help='Overwrite all video and metadata files. This option includes --no-continue')
1025 filesystem
.add_option(
1026 '--no-force-overwrites',
1027 action
='store_const', dest
='overwrites', const
=None,
1028 help='Do not overwrite the video, but overwrite related files (default)')
1029 filesystem
.add_option(
1031 action
='store_true', dest
='continue_dl', default
=True,
1032 help='Resume partially downloaded files/fragments (default)')
1033 filesystem
.add_option(
1035 action
='store_false', dest
='continue_dl',
1037 'Do not resume partially downloaded fragments. '
1038 'If the file is not fragmented, restart download of the entire file'))
1039 filesystem
.add_option(
1041 action
='store_false', dest
='nopart', default
=False,
1042 help='Use .part files instead of writing directly into output file (default)')
1043 filesystem
.add_option(
1045 action
='store_true', dest
='nopart',
1046 help='Do not use .part files - write directly into output file')
1047 filesystem
.add_option(
1049 action
='store_true', dest
='updatetime', default
=True,
1050 help='Use the Last-modified header to set the file modification time (default)')
1051 filesystem
.add_option(
1053 action
='store_false', dest
='updatetime',
1054 help='Do not use the Last-modified header to set the file modification time')
1055 filesystem
.add_option(
1056 '--write-description',
1057 action
='store_true', dest
='writedescription', default
=False,
1058 help='Write video description to a .description file')
1059 filesystem
.add_option(
1060 '--no-write-description',
1061 action
='store_false', dest
='writedescription',
1062 help='Do not write video description (default)')
1063 filesystem
.add_option(
1064 '--write-info-json',
1065 action
='store_true', dest
='writeinfojson', default
=False,
1066 help='Write video metadata to a .info.json file (this may contain personal information)')
1067 filesystem
.add_option(
1068 '--no-write-info-json',
1069 action
='store_false', dest
='writeinfojson',
1070 help='Do not write video metadata (default)')
1071 filesystem
.add_option(
1072 '--write-annotations',
1073 action
='store_true', dest
='writeannotations', default
=False,
1074 help='Write video annotations to a .annotations.xml file')
1075 filesystem
.add_option(
1076 '--no-write-annotations',
1077 action
='store_false', dest
='writeannotations',
1078 help='Do not write video annotations (default)')
1079 filesystem
.add_option(
1080 '--write-playlist-metafiles',
1081 action
='store_true', dest
='allow_playlist_files', default
=None,
1083 'Write playlist metadata in addition to the video metadata '
1084 'when using --write-info-json, --write-description etc. (default)'))
1085 filesystem
.add_option(
1086 '--no-write-playlist-metafiles',
1087 action
='store_false', dest
='allow_playlist_files',
1088 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1089 filesystem
.add_option(
1091 action
='store_true', dest
='clean_infojson', default
=None,
1093 'Remove some private fields such as filenames from the infojson. '
1094 'Note that it could still contain some personal information (default)'))
1095 filesystem
.add_option(
1096 '--no-clean-infojson',
1097 action
='store_false', dest
='clean_infojson',
1098 help='Write all fields to the infojson')
1099 filesystem
.add_option(
1100 '--write-comments', '--get-comments',
1101 action
='store_true', dest
='getcomments', default
=False,
1103 'Retrieve video comments to be placed in the infojson. '
1104 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1105 filesystem
.add_option(
1106 '--no-write-comments', '--no-get-comments',
1107 action
='store_true', dest
='getcomments', default
=False,
1108 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1109 filesystem
.add_option(
1110 '--load-info-json', '--load-info',
1111 dest
='load_info_filename', metavar
='FILE',
1112 help='JSON file containing the video information (created with the "--write-info-json" option)')
1113 filesystem
.add_option(
1115 dest
='cookiefile', metavar
='FILE',
1116 help='File to read cookies from and dump cookie jar in')
1117 filesystem
.add_option(
1119 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1120 help='Do not read/dump cookies from/to file (default)')
1121 filesystem
.add_option(
1122 '--cookies-from-browser',
1123 dest
='cookiesfrombrowser', metavar
='BROWSER[:PROFILE]',
1125 'Load cookies from a user profile of the given web browser. '
1126 'Currently supported browsers are: {}. '
1127 'You can specify the user profile name or directory using '
1128 '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
1129 'If no profile is given, the most recently accessed one is used'.format(
1130 '|'.join(sorted(SUPPORTED_BROWSERS
)))))
1131 filesystem
.add_option(
1132 '--no-cookies-from-browser',
1133 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1134 help='Do not load cookies from browser (default)')
1135 filesystem
.add_option(
1136 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1137 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')
1138 filesystem
.add_option(
1139 '--no-cache-dir', action
='store_false', dest
='cachedir',
1140 help='Disable filesystem caching')
1141 filesystem
.add_option(
1143 action
='store_true', dest
='rm_cachedir',
1144 help='Delete all filesystem cache files')
1146 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1147 thumbnail
.add_option(
1148 '--write-thumbnail',
1149 action
='store_true', dest
='writethumbnail', default
=False,
1150 help='Write thumbnail image to disk')
1151 thumbnail
.add_option(
1152 '--no-write-thumbnail',
1153 action
='store_false', dest
='writethumbnail',
1154 help='Do not write thumbnail image to disk (default)')
1155 thumbnail
.add_option(
1156 '--write-all-thumbnails',
1157 action
='store_true', dest
='write_all_thumbnails', default
=False,
1158 help='Write all thumbnail image formats to disk')
1159 thumbnail
.add_option(
1160 '--list-thumbnails',
1161 action
='store_true', dest
='list_thumbnails', default
=False,
1162 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1164 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1167 action
='store_true', dest
='writelink', default
=False,
1168 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1171 action
='store_true', dest
='writeurllink', default
=False,
1172 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1174 '--write-webloc-link',
1175 action
='store_true', dest
='writewebloclink', default
=False,
1176 help='Write a .webloc macOS internet shortcut')
1178 '--write-desktop-link',
1179 action
='store_true', dest
='writedesktoplink', default
=False,
1180 help='Write a .desktop Linux internet shortcut')
1182 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1183 postproc
.add_option(
1184 '-x', '--extract-audio',
1185 action
='store_true', dest
='extractaudio', default
=False,
1186 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1187 postproc
.add_option(
1188 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1190 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1191 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1192 postproc
.add_option(
1193 '--audio-quality', metavar
='QUALITY',
1194 dest
='audioquality', default
='5',
1195 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1196 postproc
.add_option(
1198 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1200 'Remux the video into another container if necessary (currently supported: %s). '
1201 'If target container does not support the video/audio codec, remuxing will fail. '
1202 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1203 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1204 postproc
.add_option(
1206 metavar
='FORMAT', dest
='recodevideo', default
=None,
1208 'Re-encode the video into another format if re-encoding is necessary. '
1209 'The syntax and supported formats are the same as --remux-video'))
1210 postproc
.add_option(
1211 '--postprocessor-args', '--ppa',
1212 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1213 action
='callback', callback
=_dict_from_options_callback
,
1215 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1216 'process': compat_shlex_split
,
1217 'multiple_keys': False
1219 'Give these arguments to the postprocessors. '
1220 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1221 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1222 'Merger, ExtractAudio, SplitChapters, Metadata, EmbedSubtitle, EmbedThumbnail, '
1223 'SubtitlesConvertor, ThumbnailsConvertor, VideoRemuxer, VideoConvertor, '
1224 'SponSkrub, FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1225 'The supported executables are: AtomicParsley, FFmpeg, FFprobe, and SponSkrub. '
1226 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1227 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1228 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1229 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1230 'You can use this option multiple times to give different arguments to different '
1231 'postprocessors. (Alias: --ppa)'))
1232 postproc
.add_option(
1233 '-k', '--keep-video',
1234 action
='store_true', dest
='keepvideo', default
=False,
1235 help='Keep the intermediate video file on disk after post-processing')
1236 postproc
.add_option(
1238 action
='store_false', dest
='keepvideo',
1239 help='Delete the intermediate video file after post-processing (default)')
1240 postproc
.add_option(
1241 '--post-overwrites',
1242 action
='store_false', dest
='nopostoverwrites',
1243 help='Overwrite post-processed files (default)')
1244 postproc
.add_option(
1245 '--no-post-overwrites',
1246 action
='store_true', dest
='nopostoverwrites', default
=False,
1247 help='Do not overwrite post-processed files')
1248 postproc
.add_option(
1250 action
='store_true', dest
='embedsubtitles', default
=False,
1251 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1252 postproc
.add_option(
1254 action
='store_false', dest
='embedsubtitles',
1255 help='Do not embed subtitles (default)')
1256 postproc
.add_option(
1257 '--embed-thumbnail',
1258 action
='store_true', dest
='embedthumbnail', default
=False,
1259 help='Embed thumbnail in the video as cover art')
1260 postproc
.add_option(
1261 '--no-embed-thumbnail',
1262 action
='store_false', dest
='embedthumbnail',
1263 help='Do not embed thumbnail (default)')
1264 postproc
.add_option(
1265 '--embed-metadata', '--add-metadata',
1266 action
='store_true', dest
='addmetadata', default
=False,
1267 help='Embed metadata including chapter markers (if supported by the format) to the video file (Alias: --add-metadata)')
1268 postproc
.add_option(
1269 '--no-embed-metadata', '--no-add-metadata',
1270 action
='store_false', dest
='addmetadata',
1271 help='Do not write metadata (default) (Alias: --no-add-metadata)')
1272 postproc
.add_option(
1273 '--metadata-from-title',
1274 metavar
='FORMAT', dest
='metafromtitle',
1275 help=optparse
.SUPPRESS_HELP
)
1276 postproc
.add_option(
1278 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1280 'Parse additional metadata like title/artist from other fields; '
1281 'see "MODIFYING METADATA" for details'))
1282 postproc
.add_option(
1283 '--replace-in-metadata',
1284 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1285 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1286 postproc
.add_option(
1288 action
='store_true', dest
='xattrs', default
=False,
1289 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1290 postproc
.add_option(
1292 metavar
='POLICY', dest
='fixup', default
=None,
1293 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1295 'Automatically correct known faults of the file. '
1296 'One of never (do nothing), warn (only emit a warning), '
1297 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1298 'force (try fixing even if file already exists'))
1299 postproc
.add_option(
1300 '--prefer-avconv', '--no-prefer-ffmpeg',
1301 action
='store_false', dest
='prefer_ffmpeg',
1302 help=optparse
.SUPPRESS_HELP
)
1303 postproc
.add_option(
1304 '--prefer-ffmpeg', '--no-prefer-avconv',
1305 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1306 help=optparse
.SUPPRESS_HELP
)
1307 postproc
.add_option(
1308 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1309 dest
='ffmpeg_location',
1310 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1311 postproc
.add_option(
1312 '--exec', metavar
='CMD',
1313 action
='append', dest
='exec_cmd',
1315 'Execute a command on the file after downloading and post-processing. '
1316 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1317 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1318 'If no fields are passed, %(filepath)q is appended to the end of the command. '
1319 'This option can be used multiple times'))
1320 postproc
.add_option(
1322 action
='store_const', dest
='exec_cmd', const
=[],
1323 help='Remove any previously defined --exec')
1324 postproc
.add_option(
1325 '--exec-before-download', metavar
='CMD',
1326 action
='append', dest
='exec_before_dl_cmd',
1328 'Execute a command before the actual download. '
1329 'The syntax is the same as --exec but "filepath" is not available. '
1330 'This option can be used multiple times'))
1331 postproc
.add_option(
1332 '--no-exec-before-download',
1333 action
='store_const', dest
='exec_before_dl_cmd', const
=[],
1334 help='Remove any previously defined --exec-before-download')
1335 postproc
.add_option(
1336 '--convert-subs', '--convert-sub', '--convert-subtitles',
1337 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1339 'Convert the subtitles to another format (currently supported: %s) '
1340 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1341 postproc
.add_option(
1342 '--convert-thumbnails',
1343 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1345 'Convert the thumbnails to another format '
1346 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1347 postproc
.add_option(
1348 '--split-chapters', '--split-tracks',
1349 dest
='split_chapters', action
='store_true', default
=False,
1351 'Split video into multiple files based on internal chapters. '
1352 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1353 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1354 postproc
.add_option(
1355 '--no-split-chapters', '--no-split-tracks',
1356 dest
='split_chapters', action
='store_false',
1357 help='Do not split video based on chapters (default)')
1359 sponskrub
= optparse
.OptionGroup(parser
, 'SponSkrub (SponsorBlock) Options', description
=(
1360 'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
1361 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1362 sponskrub
.add_option(
1364 action
='store_true', dest
='sponskrub', default
=None,
1366 'Use sponskrub to mark sponsored sections. '
1367 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1368 sponskrub
.add_option(
1370 action
='store_false', dest
='sponskrub',
1371 help='Do not use sponskrub')
1372 sponskrub
.add_option(
1373 '--sponskrub-cut', default
=False,
1374 action
='store_true', dest
='sponskrub_cut',
1375 help='Cut out the sponsor sections instead of simply marking them')
1376 sponskrub
.add_option(
1377 '--no-sponskrub-cut',
1378 action
='store_false', dest
='sponskrub_cut',
1379 help='Simply mark the sponsor sections, not cut them out (default)')
1380 sponskrub
.add_option(
1381 '--sponskrub-force', default
=False,
1382 action
='store_true', dest
='sponskrub_force',
1383 help='Run sponskrub even if the video was already downloaded')
1384 sponskrub
.add_option(
1385 '--no-sponskrub-force',
1386 action
='store_true', dest
='sponskrub_force',
1387 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1388 sponskrub
.add_option(
1389 '--sponskrub-location', metavar
='PATH',
1390 dest
='sponskrub_path', default
='',
1391 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1392 sponskrub
.add_option(
1393 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1394 help=optparse
.SUPPRESS_HELP
)
1396 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1397 extractor
.add_option(
1398 '--extractor-retries',
1399 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1400 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1401 extractor
.add_option(
1402 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1403 action
='store_true', dest
='dynamic_mpd', default
=True,
1404 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1405 extractor
.add_option(
1406 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1407 action
='store_false', dest
='dynamic_mpd',
1408 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1409 extractor
.add_option(
1410 '--hls-split-discontinuity',
1411 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1412 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1414 extractor
.add_option(
1415 '--no-hls-split-discontinuity',
1416 dest
='hls_split_discontinuity', action
='store_false',
1417 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1418 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [val
.strip() for val
in vals
.split(',')])
1419 extractor
.add_option(
1421 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1422 action
='callback', callback
=_dict_from_options_callback
,
1424 'multiple_keys': False,
1425 'process': lambda val
: dict(
1426 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1428 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1429 'You can use this option multiple times to give arguments for different extractors'))
1430 extractor
.add_option(
1431 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1432 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1433 help=optparse
.SUPPRESS_HELP
)
1434 extractor
.add_option(
1435 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1436 action
='store_false', dest
='youtube_include_dash_manifest',
1437 help=optparse
.SUPPRESS_HELP
)
1438 extractor
.add_option(
1439 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1440 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1441 help=optparse
.SUPPRESS_HELP
)
1442 extractor
.add_option(
1443 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1444 action
='store_false', dest
='youtube_include_hls_manifest',
1445 help=optparse
.SUPPRESS_HELP
)
1447 parser
.add_option_group(general
)
1448 parser
.add_option_group(network
)
1449 parser
.add_option_group(geo
)
1450 parser
.add_option_group(selection
)
1451 parser
.add_option_group(downloader
)
1452 parser
.add_option_group(filesystem
)
1453 parser
.add_option_group(thumbnail
)
1454 parser
.add_option_group(link
)
1455 parser
.add_option_group(verbosity
)
1456 parser
.add_option_group(workarounds
)
1457 parser
.add_option_group(video_format
)
1458 parser
.add_option_group(subtitles
)
1459 parser
.add_option_group(authentication
)
1460 parser
.add_option_group(postproc
)
1461 parser
.add_option_group(sponskrub
)
1462 parser
.add_option_group(extractor
)
1464 if overrideArguments
is not None:
1465 opts
, args
= parser
.parse_args(overrideArguments
)
1467 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1469 def compat_conf(conf
):
1470 if sys
.version_info
< (3,):
1471 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1475 'command-line': compat_conf(sys
.argv
[1:]),
1476 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1477 paths
= {'command-line': False}
1478 opts
, args
= parser
.parse_args(configs
['command-line'])
1481 if '--config-location' in configs
['command-line']:
1482 location
= compat_expanduser(opts
.config_location
)
1483 if os
.path
.isdir(location
):
1484 location
= os
.path
.join(location
, 'yt-dlp.conf')
1485 if not os
.path
.exists(location
):
1486 parser
.error('config-location %s does not exist.' % location
)
1487 configs
['custom'] = _readOptions(location
, default
=None)
1488 if configs
['custom'] is None:
1489 configs
['custom'] = []
1491 paths
['custom'] = location
1492 if '--ignore-config' in configs
['command-line']:
1494 if '--ignore-config' in configs
['custom']:
1497 def read_options(path
, user
=False):
1498 # Multiple package names can be given here
1499 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1500 # the configuration file of any of these three packages
1501 for package
in ('yt-dlp',):
1503 config
, current_path
= _readUserConf(package
, default
=None)
1505 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1506 config
= _readOptions(current_path
, default
=None)
1507 if config
is not None:
1508 return config
, current_path
1511 configs
['portable'], paths
['portable'] = read_options(get_executable_path())
1512 if '--ignore-config' in configs
['portable']:
1515 def get_home_path():
1516 opts
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])[0]
1517 return expand_path(opts
.paths
.get('home', '')).strip()
1519 configs
['home'], paths
['home'] = read_options(get_home_path())
1520 if '--ignore-config' in configs
['home']:
1523 configs
['system'], paths
['system'] = read_options('/etc')
1524 if '--ignore-config' in configs
['system']:
1527 configs
['user'], paths
['user'] = read_options('', True)
1528 if '--ignore-config' in configs
['user']:
1529 configs
['system'], paths
['system'] = [], None
1532 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1533 opts
, args
= parser
.parse_args(argv
)
1535 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1537 if paths
.get(key
) is None:
1540 write_string('[debug] %s config file: %s\n' % (label
, paths
[key
]))
1541 write_string('[debug] %s config: %s\n' % (label
, repr(_hide_login_info(configs
[key
]))))
1543 return parser
, opts
, args