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=optparse
.SUPPRESS_HELP
)
360 selection
.add_option(
362 dest
='rejecttitle', metavar
='REGEX',
363 help=optparse
.SUPPRESS_HELP
)
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=optparse
.SUPPRESS_HELP
)
399 selection
.add_option(
401 metavar
='COUNT', dest
='max_views', default
=None, type=int,
402 help=optparse
.SUPPRESS_HELP
)
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,
583 help=optparse.SUPPRESS_HELP)
584 video_format.add_option(
585 '--no
-allow
-unplayable
-formats
',
586 action='store_false
', dest='allow_unplayable_formats
',
587 help=optparse.SUPPRESS_HELP)
589 subtitles = optparse.OptionGroup(parser, 'Subtitle Options
')
590 subtitles.add_option(
591 '--write
-subs
', '--write
-srt
',
592 action='store_true
', dest='writesubtitles
', default=False,
593 help='Write subtitle
file')
594 subtitles.add_option(
595 '--no
-write
-subs
', '--no
-write
-srt
',
596 action='store_false
', dest='writesubtitles
',
597 help='Do
not write subtitle
file (default
)')
598 subtitles.add_option(
599 '--write
-auto
-subs
', '--write
-automatic
-subs
',
600 action='store_true
', dest='writeautomaticsub
', default=False,
601 help='Write automatically generated subtitle
file (Alias
: --write
-automatic
-subs
)')
602 subtitles.add_option(
603 '--no
-write
-auto
-subs
', '--no
-write
-automatic
-subs
',
604 action='store_false
', dest='writeautomaticsub
', default=False,
605 help='Do
not write auto
-generated
subtitles (default
) (Alias
: --no
-write
-automatic
-subs
)')
606 subtitles.add_option(
608 action='store_true
', dest='allsubtitles
', default=False,
609 help=optparse.SUPPRESS_HELP)
610 subtitles.add_option(
612 action='store_true
', dest='listsubtitles
', default=False,
613 help='List available subtitles of each video
. Simulate unless
--no
-simulate
is used
')
614 subtitles.add_option(
616 action='store
', dest='subtitlesformat
', metavar='FORMAT
', default='best
',
617 help='Subtitle format
, accepts formats preference
, for example
: "srt" or "ass/srt/best"')
618 subtitles.add_option(
619 '--sub
-langs
', '--srt
-langs
',
620 action='callback
', dest='subtitleslangs
', metavar='LANGS
', type='str',
621 default=[], callback=_list_from_options_callback,
623 'Languages of the subtitles to
download (can be regex
) or "all" separated by commas
. (Eg
: --sub
-langs en
.*,ja
) '
624 'You can prefix the language code
with a
"-" to exempt it
from the requested languages
. (Eg
: --sub
-langs all
,-live_chat
) '
625 'Use
--list-subs
for a
list of available language tags
'))
627 downloader = optparse.OptionGroup(parser, 'Download Options
')
628 downloader.add_option(
629 '-N
', '--concurrent
-fragments
',
630 dest='concurrent_fragment_downloads
', metavar='N
', default=1, type=int,
631 help='Number of fragments of a dash
/hlsnative video that should be download
concurrently (default
is %default
)')
632 downloader.add_option(
633 '-r
', '--limit
-rate
', '--rate
-limit
',
634 dest='ratelimit
', metavar='RATE
',
635 help='Maximum download rate
in bytes per
second (e
.g
. 50K
or 4.2M
)')
636 downloader.add_option(
638 dest='throttledratelimit
', metavar='RATE
',
639 help='Minimum download rate
in bytes per second below which throttling
is assumed
and the video data
is re
-extracted (e
.g
. 100K
)')
640 downloader.add_option(
642 dest='retries
', metavar='RETRIES
', default=10,
643 help='Number of
retries (default
is %default
), or "infinite"')
644 downloader.add_option(
645 '--fragment
-retries
',
646 dest='fragment_retries
', metavar='RETRIES
', default=10,
647 help='Number of retries
for a
fragment (default
is %default
), or "infinite" (DASH
, hlsnative
and ISM
)')
648 downloader.add_option(
649 '--skip
-unavailable
-fragments
', '--no
-abort
-on
-unavailable
-fragment
',
650 action='store_true
', dest='skip_unavailable_fragments
', default=True,
651 help='Skip unavailable fragments
for DASH
, hlsnative
and ISM (default
) (Alias
: --no
-abort
-on
-unavailable
-fragment
)')
652 downloader.add_option(
653 '--abort
-on
-unavailable
-fragment
', '--no
-skip
-unavailable
-fragments
',
654 action='store_false
', dest='skip_unavailable_fragments
',
655 help='Abort downloading
if a fragment
is unavailable (Alias
: --no
-skip
-unavailable
-fragments
)')
656 downloader.add_option(
658 action='store_true
', dest='keep_fragments
', default=False,
659 help='Keep downloaded fragments on disk after downloading
is finished
')
660 downloader.add_option(
661 '--no
-keep
-fragments
',
662 action='store_false
', dest='keep_fragments
',
663 help='Delete downloaded fragments after downloading
is finished (default
)')
664 downloader.add_option(
666 dest='buffersize
', metavar='SIZE
', default='1024',
667 help='Size of download
buffer (e
.g
. 1024 or 16K
) (default
is %default
)')
668 downloader.add_option(
670 action='store_false
', dest='noresizebuffer
',
671 help='The
buffer size
is automatically resized
from an initial value of
--buffer-size (default
)')
672 downloader.add_option(
673 '--no
-resize
-buffer',
674 action='store_true
', dest='noresizebuffer
', default=False,
675 help='Do
not automatically adjust the
buffer size
')
676 downloader.add_option(
678 dest='http_chunk_size
', metavar='SIZE
', default=None,
680 'Size of a chunk
for chunk
-based HTTP
downloading (e
.g
. 10485760 or 10M
) (default
is disabled
). '
681 'May be useful
for bypassing bandwidth throttling imposed by a
webserver (experimental
)'))
682 downloader.add_option(
684 action='store_true
', dest='test
', default=False,
685 help=optparse.SUPPRESS_HELP)
686 downloader.add_option(
687 '--playlist
-reverse
',
689 help='Download playlist videos
in reverse order
')
690 downloader.add_option(
691 '--no
-playlist
-reverse
',
692 action='store_false
', dest='playlist_reverse
',
693 help='Download playlist videos
in default
order (default
)')
694 downloader.add_option(
697 help='Download playlist videos
in random order
')
698 downloader.add_option(
699 '--xattr
-set-filesize
',
700 dest='xattr_set_filesize
', action='store_true
',
701 help='Set
file xattribute ytdl
.filesize
with expected
file size
')
702 downloader.add_option(
703 '--hls
-prefer
-native
',
704 dest='hls_prefer_native
', action='store_true
', default=None,
705 help=optparse.SUPPRESS_HELP)
706 downloader.add_option(
707 '--hls
-prefer
-ffmpeg
',
708 dest='hls_prefer_native
', action='store_false
', default=None,
709 help=optparse.SUPPRESS_HELP)
710 downloader.add_option(
712 dest='hls_use_mpegts
', action='store_true
', default=None,
714 'Use the mpegts container
for HLS videos
; '
715 'allowing some players to play the video
while downloading
, '
716 'and reducing the chance of
file corruption
if download
is interrupted
. '
717 'This
is enabled by default
for live streams
'))
718 downloader.add_option(
719 '--no
-hls
-use
-mpegts
',
720 dest='hls_use_mpegts
', action='store_false
',
722 'Do
not use the mpegts container
for HLS videos
. '
723 'This
is default when
not downloading live streams
'))
724 downloader.add_option(
725 '--downloader
', '--external
-downloader
',
726 dest='external_downloader
', metavar='[PROTO
:]NAME
', default={}, type='str',
727 action='callback
', callback=_dict_from_options_callback,
729 'allowed_keys
': 'http|ftp|m3u8|dash|rtsp|rtmp|mms
',
730 'default_key
': 'default
',
733 'Name
or path of the external downloader to
use (optionally
) prefixed by
'
734 'the
protocols (http
, ftp
, m3u8
, dash
, rstp
, rtmp
, mms
) to use it
for. '
735 'Currently supports native
, %s (Recommended
: aria2c
). '
736 'You can use this option multiple times to
set different downloaders
for different protocols
. '
737 'For example
, --downloader aria2c
--downloader
"dash,m3u8:native" will use
'
738 'aria2c
for http
/ftp downloads
, and the native downloader
for dash
/m3u8 downloads
'
739 '(Alias
: --external
-downloader
)' % ', '.join(list_external_downloaders())))
740 downloader.add_option(
741 '--downloader
-args
', '--external
-downloader
-args
',
742 metavar='NAME
:ARGS
', dest='external_downloader_args
', default={}, type='str',
743 action='callback
', callback=_dict_from_options_callback,
745 'allowed_keys
': r'ffmpeg_
[io
]\d
*|
%s' % '|
'.join(list_external_downloaders()),
746 'default_key
': 'default
',
747 'process
': compat_shlex_split
749 'Give these arguments to the external downloader
. '
750 'Specify the downloader name
and the arguments separated by a colon
":". '
751 'For ffmpeg
, arguments can be passed to different positions using the same syntax
as --postprocessor
-args
. '
752 'You can use this option multiple times to give different arguments to different downloaders
'
753 '(Alias
: --external
-downloader
-args
)'))
755 workarounds = optparse.OptionGroup(parser, 'Workarounds
')
756 workarounds.add_option(
758 dest='encoding
', metavar='ENCODING
',
759 help='Force the specified
encoding (experimental
)')
760 workarounds.add_option(
761 '--no
-check
-certificate
',
762 action='store_true
', dest='no_check_certificate
', default=False,
763 help='Suppress HTTPS certificate validation
')
764 workarounds.add_option(
765 '--prefer
-insecure
', '--prefer
-unsecure
',
766 action='store_true
', dest='prefer_insecure
',
767 help='Use an unencrypted connection to retrieve information about the
video (Currently supported only
for YouTube
)')
768 workarounds.add_option(
770 metavar='UA
', dest='user_agent
',
771 help='Specify a custom user agent
')
772 workarounds.add_option(
774 metavar='URL
', dest='referer
', default=None,
775 help='Specify a custom referer
, use
if the video access
is restricted to one domain
',
777 workarounds.add_option(
779 metavar='FIELD
:VALUE
', dest='headers
', default={}, type='str',
780 action='callback
', callback=_dict_from_options_callback,
781 callback_kwargs={'multiple_keys': False},
782 help='Specify a custom HTTP header
and its value
, separated by a colon
":". You can use this option multiple times
',
784 workarounds.add_option(
786 dest='bidi_workaround
', action='store_true
',
787 help='Work around terminals that lack bidirectional text support
. Requires bidiv
or fribidi executable
in PATH
')
788 workarounds.add_option(
789 '--sleep
-requests
', metavar='SECONDS
',
790 dest='sleep_interval_requests
', type=float,
791 help='Number of seconds to sleep between requests during data extraction
')
792 workarounds.add_option(
793 '--sleep
-interval
', '--min-sleep
-interval
', metavar='SECONDS
',
794 dest='sleep_interval
', type=float,
796 'Number of seconds to sleep before each download
. '
797 'This
is the minimum time to sleep when used along
with --max-sleep
-interval
'
798 '(Alias
: --min-sleep
-interval
)'))
799 workarounds.add_option(
800 '--max-sleep
-interval
', metavar='SECONDS
',
801 dest='max_sleep_interval
', type=float,
802 help='Maximum number of seconds to sleep
. Can only be used along
with --min-sleep
-interval
')
803 workarounds.add_option(
804 '--sleep
-subtitles
', metavar='SECONDS
',
805 dest='sleep_interval_subtitles
', default=0, type=int,
806 help='Number of seconds to sleep before each subtitle download
')
808 verbosity = optparse.OptionGroup(parser, 'Verbosity
and Simulation Options
')
809 verbosity.add_option(
811 action='store_true
', dest='quiet
', default=False,
812 help='Activate quiet mode
. If used
with --verbose
, print the log to stderr
')
813 verbosity.add_option(
815 dest='no_warnings
', action='store_true
', default=False,
816 help='Ignore warnings
')
817 verbosity.add_option(
819 action='store_true
', dest='simulate
', default=None,
820 help='Do
not download the video
and do
not write anything to disk
')
821 verbosity.add_option(
823 action='store_false
', dest='simulate
',
824 help='Download the video even
if printing
/listing options are used
')
825 verbosity.add_option(
826 '--ignore
-no
-formats
-error
',
827 action='store_true
', dest='ignore_no_formats_error
', default=False,
829 'Ignore
"No video formats" error
. Usefull
for extracting metadata
'
830 'even
if the videos are
not actually available
for download (experimental
)'))
831 verbosity.add_option(
832 '--no
-ignore
-no
-formats
-error
',
833 action='store_false
', dest='ignore_no_formats_error
',
834 help='Throw error when no downloadable video formats are
found (default
)')
835 verbosity.add_option(
836 '--skip
-download
', '--no
-download
',
837 action='store_true
', dest='skip_download
', default=False,
838 help='Do
not download the video but write all related
files (Alias
: --no
-download
)')
839 verbosity.add_option(
841 metavar='TEMPLATE
', action='append
', dest='forceprint
',
843 'Quiet
, but
print the given fields
for each video
. Simulate unless
--no
-simulate
is used
. '
844 'Either a field name
or same syntax
as the output template can be used
'))
845 verbosity.add_option(
847 action='store_true
', dest='geturl
', default=False,
848 help=optparse.SUPPRESS_HELP)
849 verbosity.add_option(
851 action='store_true
', dest='gettitle
', default=False,
852 help=optparse.SUPPRESS_HELP)
853 verbosity.add_option(
855 action='store_true
', dest='getid
', default=False,
856 help=optparse.SUPPRESS_HELP)
857 verbosity.add_option(
859 action='store_true
', dest='getthumbnail
', default=False,
860 help=optparse.SUPPRESS_HELP)
861 verbosity.add_option(
863 action='store_true
', dest='getdescription
', default=False,
864 help=optparse.SUPPRESS_HELP)
865 verbosity.add_option(
867 action='store_true
', dest='getduration
', default=False,
868 help=optparse.SUPPRESS_HELP)
869 verbosity.add_option(
871 action='store_true
', dest='getfilename
', default=False,
872 help=optparse.SUPPRESS_HELP)
873 verbosity.add_option(
875 action='store_true
', dest='getformat
', default=False,
876 help=optparse.SUPPRESS_HELP)
877 verbosity.add_option(
879 action='store_true
', dest='dumpjson
', default=False,
880 help='Quiet
, but
print JSON information
for each video
. Simulate unless
--no
-simulate
is used
. See
"OUTPUT TEMPLATE" for a description of available keys
')
881 verbosity.add_option(
882 '-J
', '--dump
-single
-json
',
883 action='store_true
', dest='dump_single_json
', default=False,
885 'Quiet
, but
print JSON information
for each url
or infojson passed
. Simulate unless
--no
-simulate
is used
. '
886 'If the URL refers to a playlist
, the whole playlist information
is dumped
in a single line
'))
887 verbosity.add_option(
889 action='store_true
', dest='print_json
', default=False,
890 help=optparse.SUPPRESS_HELP)
891 verbosity.add_option(
892 '--force
-write
-archive
', '--force
-write
-download
-archive
', '--force
-download
-archive
',
893 action='store_true
', dest='force_write_download_archive
', default=False,
895 'Force download archive entries to be written
as far
as no errors occur
, '
896 'even
if -s
or another simulation option
is used (Alias
: --force
-download
-archive
)'))
897 verbosity.add_option(
899 action='store_true
', dest='progress_with_newline
', default=False,
900 help='Output progress bar
as new lines
')
901 verbosity.add_option(
903 action='store_true
', dest='noprogress
', default=False,
904 help='Do
not print progress bar
')
905 verbosity.add_option(
907 action='store_true
', dest='consoletitle
', default=False,
908 help='Display progress
in console titlebar
')
909 verbosity.add_option(
911 action='store_true
', dest='verbose
', default=False,
912 help='Print various debugging information
')
913 verbosity.add_option(
914 '--dump
-pages
', '--dump
-intermediate
-pages
',
915 action='store_true
', dest='dump_intermediate_pages
', default=False,
916 help='Print downloaded pages encoded using base64 to debug
problems (very verbose
)')
917 verbosity.add_option(
919 action='store_true
', dest='write_pages
', default=False,
920 help='Write downloaded intermediary pages to files
in the current directory to debug problems
')
921 verbosity.add_option(
922 '--youtube
-print-sig
-code
',
923 action='store_true
', dest='youtube_print_sig_code
', default=False,
924 help=optparse.SUPPRESS_HELP)
925 verbosity.add_option(
926 '--print-traffic
', '--dump
-headers
',
927 dest='debug_printtraffic
', action='store_true
', default=False,
928 help='Display sent
and read HTTP traffic
')
929 verbosity.add_option(
931 dest='call_home
', action='store_true
', default=False,
932 # help='[Broken
] Contact the yt
-dlp server
for debugging
')
933 help=optparse.SUPPRESS_HELP)
934 verbosity.add_option(
936 dest='call_home
', action='store_false
',
937 # help='Do
not contact the yt
-dlp server
for debugging (default
)')
938 help=optparse.SUPPRESS_HELP)
940 filesystem = optparse.OptionGroup(parser, 'Filesystem Options
')
941 filesystem.add_option(
942 '-a
', '--batch
-file',
943 dest='batchfile
', metavar='FILE
',
944 help="File containing URLs to download ('-' for stdin), one URL per line. "
945 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
946 filesystem
.add_option(
947 '--id', default
=False,
948 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
949 filesystem
.add_option(
951 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
952 action
='callback', callback
=_dict_from_options_callback
,
954 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
955 'default_key': 'home'
957 'The paths where the files should be downloaded. '
958 'Specify the type of file and the path separated by a colon ":". '
959 'All the same types as --output are supported. '
960 'Additionally, you can also provide "home" (default) and "temp" paths. '
961 'All intermediary files are first downloaded to the temp path and '
962 'then the final files are moved over to the home path after download is finished. '
963 'This option is ignored if --output is an absolute path'))
964 filesystem
.add_option(
966 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
967 action
='callback', callback
=_dict_from_options_callback
,
969 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
970 'default_key': 'default'
971 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
972 filesystem
.add_option(
973 '--output-na-placeholder',
974 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
975 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
976 filesystem
.add_option(
978 dest
='autonumber_size', metavar
='NUMBER', type=int,
979 help=optparse
.SUPPRESS_HELP
)
980 filesystem
.add_option(
981 '--autonumber-start',
982 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
983 help=optparse
.SUPPRESS_HELP
)
984 filesystem
.add_option(
985 '--restrict-filenames',
986 action
='store_true', dest
='restrictfilenames', default
=False,
987 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
988 filesystem
.add_option(
989 '--no-restrict-filenames',
990 action
='store_false', dest
='restrictfilenames',
991 help='Allow Unicode characters, "&" and spaces in filenames (default)')
992 filesystem
.add_option(
993 '--windows-filenames',
994 action
='store_true', dest
='windowsfilenames', default
=False,
995 help='Force filenames to be windows compatible')
996 filesystem
.add_option(
997 '--no-windows-filenames',
998 action
='store_false', dest
='windowsfilenames',
999 help='Make filenames windows compatible only if using windows (default)')
1000 filesystem
.add_option(
1001 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1002 dest
='trim_file_name', default
=0, type=int,
1003 help='Limit the filename length (excluding extension) to the specified number of characters')
1004 filesystem
.add_option(
1006 action
='store_true', dest
='autonumber', default
=False,
1007 help=optparse
.SUPPRESS_HELP
)
1008 filesystem
.add_option(
1010 action
='store_true', dest
='usetitle', default
=False,
1011 help=optparse
.SUPPRESS_HELP
)
1012 filesystem
.add_option(
1013 '--literal', default
=False,
1014 action
='store_true', dest
='usetitle',
1015 help=optparse
.SUPPRESS_HELP
)
1016 filesystem
.add_option(
1017 '-w', '--no-overwrites',
1018 action
='store_false', dest
='overwrites', default
=None,
1019 help='Do not overwrite any files')
1020 filesystem
.add_option(
1021 '--force-overwrites', '--yes-overwrites',
1022 action
='store_true', dest
='overwrites',
1023 help='Overwrite all video and metadata files. This option includes --no-continue')
1024 filesystem
.add_option(
1025 '--no-force-overwrites',
1026 action
='store_const', dest
='overwrites', const
=None,
1027 help='Do not overwrite the video, but overwrite related files (default)')
1028 filesystem
.add_option(
1030 action
='store_true', dest
='continue_dl', default
=True,
1031 help='Resume partially downloaded files/fragments (default)')
1032 filesystem
.add_option(
1034 action
='store_false', dest
='continue_dl',
1036 'Do not resume partially downloaded fragments. '
1037 'If the file is not fragmented, restart download of the entire file'))
1038 filesystem
.add_option(
1040 action
='store_false', dest
='nopart', default
=False,
1041 help='Use .part files instead of writing directly into output file (default)')
1042 filesystem
.add_option(
1044 action
='store_true', dest
='nopart',
1045 help='Do not use .part files - write directly into output file')
1046 filesystem
.add_option(
1048 action
='store_true', dest
='updatetime', default
=True,
1049 help='Use the Last-modified header to set the file modification time (default)')
1050 filesystem
.add_option(
1052 action
='store_false', dest
='updatetime',
1053 help='Do not use the Last-modified header to set the file modification time')
1054 filesystem
.add_option(
1055 '--write-description',
1056 action
='store_true', dest
='writedescription', default
=False,
1057 help='Write video description to a .description file')
1058 filesystem
.add_option(
1059 '--no-write-description',
1060 action
='store_false', dest
='writedescription',
1061 help='Do not write video description (default)')
1062 filesystem
.add_option(
1063 '--write-info-json',
1064 action
='store_true', dest
='writeinfojson', default
=False,
1065 help='Write video metadata to a .info.json file (this may contain personal information)')
1066 filesystem
.add_option(
1067 '--no-write-info-json',
1068 action
='store_false', dest
='writeinfojson',
1069 help='Do not write video metadata (default)')
1070 filesystem
.add_option(
1071 '--write-annotations',
1072 action
='store_true', dest
='writeannotations', default
=False,
1073 help='Write video annotations to a .annotations.xml file')
1074 filesystem
.add_option(
1075 '--no-write-annotations',
1076 action
='store_false', dest
='writeannotations',
1077 help='Do not write video annotations (default)')
1078 filesystem
.add_option(
1079 '--write-playlist-metafiles',
1080 action
='store_true', dest
='allow_playlist_files', default
=None,
1082 'Write playlist metadata in addition to the video metadata '
1083 'when using --write-info-json, --write-description etc. (default)'))
1084 filesystem
.add_option(
1085 '--no-write-playlist-metafiles',
1086 action
='store_false', dest
='allow_playlist_files',
1087 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1088 filesystem
.add_option(
1090 action
='store_true', dest
='clean_infojson', default
=None,
1092 'Remove some private fields such as filenames from the infojson. '
1093 'Note that it could still contain some personal information (default)'))
1094 filesystem
.add_option(
1095 '--no-clean-infojson',
1096 action
='store_false', dest
='clean_infojson',
1097 help='Write all fields to the infojson')
1098 filesystem
.add_option(
1099 '--write-comments', '--get-comments',
1100 action
='store_true', dest
='getcomments', default
=False,
1102 'Retrieve video comments to be placed in the infojson. '
1103 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1104 filesystem
.add_option(
1105 '--no-write-comments', '--no-get-comments',
1106 action
='store_true', dest
='getcomments', default
=False,
1107 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1108 filesystem
.add_option(
1109 '--load-info-json', '--load-info',
1110 dest
='load_info_filename', metavar
='FILE',
1111 help='JSON file containing the video information (created with the "--write-info-json" option)')
1112 filesystem
.add_option(
1114 dest
='cookiefile', metavar
='FILE',
1115 help='File to read cookies from and dump cookie jar in')
1116 filesystem
.add_option(
1118 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1119 help='Do not read/dump cookies from/to file (default)')
1120 filesystem
.add_option(
1121 '--cookies-from-browser',
1122 dest
='cookiesfrombrowser', metavar
='BROWSER[:PROFILE]',
1124 'Load cookies from a user profile of the given web browser. '
1125 'Currently supported browsers are: {}. '
1126 'You can specify the user profile name or directory using '
1127 '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
1128 'If no profile is given, the most recently accessed one is used'.format(
1129 '|'.join(sorted(SUPPORTED_BROWSERS
)))))
1130 filesystem
.add_option(
1131 '--no-cookies-from-browser',
1132 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1133 help='Do not load cookies from browser (default)')
1134 filesystem
.add_option(
1135 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1136 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')
1137 filesystem
.add_option(
1138 '--no-cache-dir', action
='store_false', dest
='cachedir',
1139 help='Disable filesystem caching')
1140 filesystem
.add_option(
1142 action
='store_true', dest
='rm_cachedir',
1143 help='Delete all filesystem cache files')
1145 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1146 thumbnail
.add_option(
1147 '--write-thumbnail',
1148 action
='store_true', dest
='writethumbnail', default
=False,
1149 help='Write thumbnail image to disk')
1150 thumbnail
.add_option(
1151 '--no-write-thumbnail',
1152 action
='store_false', dest
='writethumbnail',
1153 help='Do not write thumbnail image to disk (default)')
1154 thumbnail
.add_option(
1155 '--write-all-thumbnails',
1156 action
='store_true', dest
='write_all_thumbnails', default
=False,
1157 help='Write all thumbnail image formats to disk')
1158 thumbnail
.add_option(
1159 '--list-thumbnails',
1160 action
='store_true', dest
='list_thumbnails', default
=False,
1161 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1163 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1166 action
='store_true', dest
='writelink', default
=False,
1167 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1170 action
='store_true', dest
='writeurllink', default
=False,
1171 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1173 '--write-webloc-link',
1174 action
='store_true', dest
='writewebloclink', default
=False,
1175 help='Write a .webloc macOS internet shortcut')
1177 '--write-desktop-link',
1178 action
='store_true', dest
='writedesktoplink', default
=False,
1179 help='Write a .desktop Linux internet shortcut')
1181 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1182 postproc
.add_option(
1183 '-x', '--extract-audio',
1184 action
='store_true', dest
='extractaudio', default
=False,
1185 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1186 postproc
.add_option(
1187 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1189 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1190 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1191 postproc
.add_option(
1192 '--audio-quality', metavar
='QUALITY',
1193 dest
='audioquality', default
='5',
1194 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1195 postproc
.add_option(
1197 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1199 'Remux the video into another container if necessary (currently supported: %s). '
1200 'If target container does not support the video/audio codec, remuxing will fail. '
1201 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1202 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1203 postproc
.add_option(
1205 metavar
='FORMAT', dest
='recodevideo', default
=None,
1207 'Re-encode the video into another format if re-encoding is necessary. '
1208 'The syntax and supported formats are the same as --remux-video'))
1209 postproc
.add_option(
1210 '--postprocessor-args', '--ppa',
1211 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1212 action
='callback', callback
=_dict_from_options_callback
,
1214 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1215 'process': compat_shlex_split
,
1216 'multiple_keys': False
1218 'Give these arguments to the postprocessors. '
1219 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1220 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1221 'Merger, ExtractAudio, SplitChapters, Metadata, EmbedSubtitle, EmbedThumbnail, '
1222 'SubtitlesConvertor, ThumbnailsConvertor, VideoRemuxer, VideoConvertor, '
1223 'SponSkrub, FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1224 'The supported executables are: AtomicParsley, FFmpeg, FFprobe, and SponSkrub. '
1225 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1226 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1227 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1228 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1229 'You can use this option multiple times to give different arguments to different '
1230 'postprocessors. (Alias: --ppa)'))
1231 postproc
.add_option(
1232 '-k', '--keep-video',
1233 action
='store_true', dest
='keepvideo', default
=False,
1234 help='Keep the intermediate video file on disk after post-processing')
1235 postproc
.add_option(
1237 action
='store_false', dest
='keepvideo',
1238 help='Delete the intermediate video file after post-processing (default)')
1239 postproc
.add_option(
1240 '--post-overwrites',
1241 action
='store_false', dest
='nopostoverwrites',
1242 help='Overwrite post-processed files (default)')
1243 postproc
.add_option(
1244 '--no-post-overwrites',
1245 action
='store_true', dest
='nopostoverwrites', default
=False,
1246 help='Do not overwrite post-processed files')
1247 postproc
.add_option(
1249 action
='store_true', dest
='embedsubtitles', default
=False,
1250 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1251 postproc
.add_option(
1253 action
='store_false', dest
='embedsubtitles',
1254 help='Do not embed subtitles (default)')
1255 postproc
.add_option(
1256 '--embed-thumbnail',
1257 action
='store_true', dest
='embedthumbnail', default
=False,
1258 help='Embed thumbnail in the video as cover art')
1259 postproc
.add_option(
1260 '--no-embed-thumbnail',
1261 action
='store_false', dest
='embedthumbnail',
1262 help='Do not embed thumbnail (default)')
1263 postproc
.add_option(
1264 '--embed-metadata', '--add-metadata',
1265 action
='store_true', dest
='addmetadata', default
=False,
1266 help='Embed metadata including chapter markers (if supported by the format) to the video file (Alias: --add-metadata)')
1267 postproc
.add_option(
1268 '--no-embed-metadata', '--no-add-metadata',
1269 action
='store_false', dest
='addmetadata',
1270 help='Do not write metadata (default) (Alias: --no-add-metadata)')
1271 postproc
.add_option(
1272 '--metadata-from-title',
1273 metavar
='FORMAT', dest
='metafromtitle',
1274 help=optparse
.SUPPRESS_HELP
)
1275 postproc
.add_option(
1277 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1279 'Parse additional metadata like title/artist from other fields; '
1280 'see "MODIFYING METADATA" for details'))
1281 postproc
.add_option(
1282 '--replace-in-metadata',
1283 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1284 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1285 postproc
.add_option(
1287 action
='store_true', dest
='xattrs', default
=False,
1288 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1289 postproc
.add_option(
1291 metavar
='POLICY', dest
='fixup', default
=None,
1292 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1294 'Automatically correct known faults of the file. '
1295 'One of never (do nothing), warn (only emit a warning), '
1296 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1297 'force (try fixing even if file already exists'))
1298 postproc
.add_option(
1299 '--prefer-avconv', '--no-prefer-ffmpeg',
1300 action
='store_false', dest
='prefer_ffmpeg',
1301 help=optparse
.SUPPRESS_HELP
)
1302 postproc
.add_option(
1303 '--prefer-ffmpeg', '--no-prefer-avconv',
1304 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1305 help=optparse
.SUPPRESS_HELP
)
1306 postproc
.add_option(
1307 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1308 dest
='ffmpeg_location',
1309 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1310 postproc
.add_option(
1311 '--exec', metavar
='CMD',
1312 action
='append', dest
='exec_cmd',
1314 'Execute a command on the file after downloading and post-processing. '
1315 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1316 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1317 'If no fields are passed, %(filepath)q is appended to the end of the command. '
1318 'This option can be used multiple times'))
1319 postproc
.add_option(
1321 action
='store_const', dest
='exec_cmd', const
=[],
1322 help='Remove any previously defined --exec')
1323 postproc
.add_option(
1324 '--exec-before-download', metavar
='CMD',
1325 action
='append', dest
='exec_before_dl_cmd',
1327 'Execute a command before the actual download. '
1328 'The syntax is the same as --exec but "filepath" is not available. '
1329 'This option can be used multiple times'))
1330 postproc
.add_option(
1331 '--no-exec-before-download',
1332 action
='store_const', dest
='exec_before_dl_cmd', const
=[],
1333 help='Remove any previously defined --exec-before-download')
1334 postproc
.add_option(
1335 '--convert-subs', '--convert-sub', '--convert-subtitles',
1336 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1338 'Convert the subtitles to another format (currently supported: %s) '
1339 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1340 postproc
.add_option(
1341 '--convert-thumbnails',
1342 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1344 'Convert the thumbnails to another format '
1345 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1346 postproc
.add_option(
1347 '--split-chapters', '--split-tracks',
1348 dest
='split_chapters', action
='store_true', default
=False,
1350 'Split video into multiple files based on internal chapters. '
1351 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1352 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1353 postproc
.add_option(
1354 '--no-split-chapters', '--no-split-tracks',
1355 dest
='split_chapters', action
='store_false',
1356 help='Do not split video based on chapters (default)')
1358 sponskrub
= optparse
.OptionGroup(parser
, 'SponSkrub (SponsorBlock) Options', description
=(
1359 'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
1360 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1361 sponskrub
.add_option(
1363 action
='store_true', dest
='sponskrub', default
=None,
1365 'Use sponskrub to mark sponsored sections. '
1366 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1367 sponskrub
.add_option(
1369 action
='store_false', dest
='sponskrub',
1370 help='Do not use sponskrub')
1371 sponskrub
.add_option(
1372 '--sponskrub-cut', default
=False,
1373 action
='store_true', dest
='sponskrub_cut',
1374 help='Cut out the sponsor sections instead of simply marking them')
1375 sponskrub
.add_option(
1376 '--no-sponskrub-cut',
1377 action
='store_false', dest
='sponskrub_cut',
1378 help='Simply mark the sponsor sections, not cut them out (default)')
1379 sponskrub
.add_option(
1380 '--sponskrub-force', default
=False,
1381 action
='store_true', dest
='sponskrub_force',
1382 help='Run sponskrub even if the video was already downloaded')
1383 sponskrub
.add_option(
1384 '--no-sponskrub-force',
1385 action
='store_true', dest
='sponskrub_force',
1386 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1387 sponskrub
.add_option(
1388 '--sponskrub-location', metavar
='PATH',
1389 dest
='sponskrub_path', default
='',
1390 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1391 sponskrub
.add_option(
1392 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1393 help=optparse
.SUPPRESS_HELP
)
1395 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1396 extractor
.add_option(
1397 '--extractor-retries',
1398 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1399 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1400 extractor
.add_option(
1401 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1402 action
='store_true', dest
='dynamic_mpd', default
=True,
1403 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1404 extractor
.add_option(
1405 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1406 action
='store_false', dest
='dynamic_mpd',
1407 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1408 extractor
.add_option(
1409 '--hls-split-discontinuity',
1410 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1411 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1413 extractor
.add_option(
1414 '--no-hls-split-discontinuity',
1415 dest
='hls_split_discontinuity', action
='store_false',
1416 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1417 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [val
.strip() for val
in vals
.split(',')])
1418 extractor
.add_option(
1420 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1421 action
='callback', callback
=_dict_from_options_callback
,
1423 'multiple_keys': False,
1424 'process': lambda val
: dict(
1425 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1427 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1428 'You can use this option multiple times to give arguments for different extractors'))
1429 extractor
.add_option(
1430 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1431 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1432 help=optparse
.SUPPRESS_HELP
)
1433 extractor
.add_option(
1434 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1435 action
='store_false', dest
='youtube_include_dash_manifest',
1436 help=optparse
.SUPPRESS_HELP
)
1437 extractor
.add_option(
1438 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1439 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1440 help=optparse
.SUPPRESS_HELP
)
1441 extractor
.add_option(
1442 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1443 action
='store_false', dest
='youtube_include_hls_manifest',
1444 help=optparse
.SUPPRESS_HELP
)
1446 parser
.add_option_group(general
)
1447 parser
.add_option_group(network
)
1448 parser
.add_option_group(geo
)
1449 parser
.add_option_group(selection
)
1450 parser
.add_option_group(downloader
)
1451 parser
.add_option_group(filesystem
)
1452 parser
.add_option_group(thumbnail
)
1453 parser
.add_option_group(link
)
1454 parser
.add_option_group(verbosity
)
1455 parser
.add_option_group(workarounds
)
1456 parser
.add_option_group(video_format
)
1457 parser
.add_option_group(subtitles
)
1458 parser
.add_option_group(authentication
)
1459 parser
.add_option_group(postproc
)
1460 parser
.add_option_group(sponskrub
)
1461 parser
.add_option_group(extractor
)
1463 if overrideArguments
is not None:
1464 opts
, args
= parser
.parse_args(overrideArguments
)
1466 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1468 def compat_conf(conf
):
1469 if sys
.version_info
< (3,):
1470 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1474 'command-line': compat_conf(sys
.argv
[1:]),
1475 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1476 paths
= {'command-line': False}
1477 opts
, args
= parser
.parse_args(configs
['command-line'])
1480 if '--config-location' in configs
['command-line']:
1481 location
= compat_expanduser(opts
.config_location
)
1482 if os
.path
.isdir(location
):
1483 location
= os
.path
.join(location
, 'yt-dlp.conf')
1484 if not os
.path
.exists(location
):
1485 parser
.error('config-location %s does not exist.' % location
)
1486 configs
['custom'] = _readOptions(location
, default
=None)
1487 if configs
['custom'] is None:
1488 configs
['custom'] = []
1490 paths
['custom'] = location
1491 if '--ignore-config' in configs
['command-line']:
1493 if '--ignore-config' in configs
['custom']:
1496 def read_options(path
, user
=False):
1497 # Multiple package names can be given here
1498 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1499 # the configuration file of any of these three packages
1500 for package
in ('yt-dlp',):
1502 config
, current_path
= _readUserConf(package
, default
=None)
1504 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1505 config
= _readOptions(current_path
, default
=None)
1506 if config
is not None:
1507 return config
, current_path
1510 configs
['portable'], paths
['portable'] = read_options(get_executable_path())
1511 if '--ignore-config' in configs
['portable']:
1514 def get_home_path():
1515 opts
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])[0]
1516 return expand_path(opts
.paths
.get('home', '')).strip()
1518 configs
['home'], paths
['home'] = read_options(get_home_path())
1519 if '--ignore-config' in configs
['home']:
1522 configs
['system'], paths
['system'] = read_options('/etc')
1523 if '--ignore-config' in configs
['system']:
1526 configs
['user'], paths
['user'] = read_options('', True)
1527 if '--ignore-config' in configs
['user']:
1528 configs
['system'], paths
['system'] = [], None
1531 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1532 opts
, args
= parser
.parse_args(argv
)
1534 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1536 if paths
.get(key
) is None:
1539 write_string('[debug] %s config file: %s\n' % (label
, paths
[key
]))
1540 write_string('[debug] %s config: %s\n' % (label
, repr(_hide_login_info(configs
[key
]))))
1542 return parser
, opts
, args