1 from __future__
import unicode_literals
8 from .downloader
.external
import list_external_downloaders
11 compat_get_terminal_size
,
24 from .version
import __version__
27 def _hide_login_info(opts
):
28 PRIVATE_OPTS
= set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
29 eqre
= re
.compile('^(?P<key>' + ('|'.join(re
.escape(po
) for po
in PRIVATE_OPTS
)) + ')=.+$')
34 return m
.group('key') + '=PRIVATE'
38 opts
= list(map(_scrub_eq
, opts
))
39 for idx
, opt
in enumerate(opts
):
40 if opt
in PRIVATE_OPTS
and idx
+ 1 < len(opts
):
41 opts
[idx
+ 1] = 'PRIVATE'
45 def parseOpts(overrideArguments
=None):
46 def _readOptions(filename_bytes
, default
=[]):
48 optionf
= open(filename_bytes
)
50 return default
# silently skip if file is not present
52 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
53 contents
= optionf
.read()
54 if sys
.version_info
< (3,):
55 contents
= contents
.decode(preferredencoding())
56 res
= compat_shlex_split(contents
, comments
=True)
61 def _readUserConf(package_name
, default
=[]):
63 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
64 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
65 if not os
.path
.isfile(userConfFile
):
66 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
67 userConf
= _readOptions(userConfFile
, default
=None)
68 if userConf
is not None:
69 return userConf
, userConfFile
72 appdata_dir
= compat_getenv('appdata')
74 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
75 userConf
= _readOptions(userConfFile
, default
=None)
77 userConfFile
+= '.txt'
78 userConf
= _readOptions(userConfFile
, default
=None)
79 if userConf
is not None:
80 return userConf
, userConfFile
83 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
84 userConf
= _readOptions(userConfFile
, default
=None)
86 userConfFile
+= '.txt'
87 userConf
= _readOptions(userConfFile
, default
=None)
88 if userConf
is not None:
89 return userConf
, userConfFile
93 def _format_option_string(option
):
94 ''' ('-o', '--option') -> -o, --format METAVAR'''
98 if option
._short
_opts
:
99 opts
.append(option
._short
_opts
[0])
100 if option
._long
_opts
:
101 opts
.append(option
._long
_opts
[0])
105 if option
.takes_value():
106 opts
.append(' %s' % option
.metavar
)
110 def _comma_separated_values_options_callback(option
, opt_str
, value
, parser
):
111 setattr(parser
.values
, option
.dest
, value
.split(','))
113 def _dict_from_multiple_values_options_callback(
114 option
, opt_str
, value
, parser
, allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None):
116 out_dict
= getattr(parser
.values
, option
.dest
)
117 mobj
= re
.match(r
'(?i)(?P<key>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
119 key
, val
= mobj
.group('key').lower(), mobj
.group('val')
120 elif default_key
is not None:
121 key
, val
= default_key
, value
123 raise optparse
.OptionValueError(
124 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
125 out_dict
[key
] = process(val
) if callable(process
) else val
127 # No need to wrap help messages if we're on a wide console
128 columns
= compat_get_terminal_size().columns
129 max_width
= columns
if columns
else 80
130 max_help_position
= 80
132 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
133 fmt
.format_option_strings
= _format_option_string
136 'version': __version__
,
138 'usage': '%prog [OPTIONS] URL [URL...]',
139 'conflict_handler': 'resolve',
142 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
144 general
= optparse
.OptionGroup(parser
, 'General Options')
148 help='Print this help text and exit')
152 help='Print program version and exit')
155 action
='store_true', dest
='update_self',
156 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
158 '-i', '--ignore-errors', '--no-abort-on-error',
159 action
='store_true', dest
='ignoreerrors', default
=True,
160 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
162 '--abort-on-error', '--no-ignore-errors',
163 action
='store_false', dest
='ignoreerrors',
164 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
167 action
='store_true', dest
='dump_user_agent', default
=False,
168 help='Display the current browser identification')
171 action
='store_true', dest
='list_extractors', default
=False,
172 help='List all supported extractors')
174 '--extractor-descriptions',
175 action
='store_true', dest
='list_extractor_descriptions', default
=False,
176 help='Output descriptions of all supported extractors')
178 '--force-generic-extractor',
179 action
='store_true', dest
='force_generic_extractor', default
=False,
180 help='Force extraction to use the generic extractor')
183 dest
='default_search', metavar
='PREFIX',
184 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')
186 '--ignore-config', '--no-config',
189 'Disable loading any configuration files except the one provided by --config-location. '
190 'When given inside a configuration file, no further configuration files are loaded. '
191 'Additionally, (for backward compatibility) if this option is found inside the '
192 'system configuration file, the user configuration is not loaded'))
195 dest
='config_location', metavar
='PATH',
196 help='Location of the main configuration file; either the path to the config or its containing directory')
199 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
200 help='Do not extract the videos of a playlist, only list them')
203 action
='store_true', dest
='extract_flat',
204 # help='Do not resolve the video urls')
206 help=optparse
.SUPPRESS_HELP
)
208 '--no-flat-playlist',
209 action
='store_false', dest
='extract_flat',
210 help='Extract the videos of a playlist')
213 action
='store_true', dest
='mark_watched', default
=False,
214 help='Mark videos watched (YouTube only)')
217 action
='store_false', dest
='mark_watched', default
=False,
218 help='Do not mark videos watched')
221 action
='store_true', dest
='no_color',
223 help='Do not emit color codes in output')
225 network
= optparse
.OptionGroup(parser
, 'Network Options')
227 '--proxy', dest
='proxy',
228 default
=None, metavar
='URL',
230 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
231 'SOCKS proxy, specify a proper scheme. For example '
232 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
233 'for direct connection'))
236 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
237 help='Time to wait before giving up, in seconds')
240 metavar
='IP', dest
='source_address', default
=None,
241 help='Client-side IP address to bind to',
244 '-4', '--force-ipv4',
245 action
='store_const', const
='0.0.0.0', dest
='source_address',
246 help='Make all connections via IPv4',
249 '-6', '--force-ipv6',
250 action
='store_const', const
='::', dest
='source_address',
251 help='Make all connections via IPv6',
254 geo
= optparse
.OptionGroup(parser
, 'Geo Restriction')
256 '--geo-verification-proxy',
257 dest
='geo_verification_proxy', default
=None, metavar
='URL',
259 'Use this proxy to verify the IP address for some geo-restricted sites. '
260 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
262 '--cn-verification-proxy',
263 dest
='cn_verification_proxy', default
=None, metavar
='URL',
264 help=optparse
.SUPPRESS_HELP
)
267 action
='store_true', dest
='geo_bypass', default
=True,
268 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
271 action
='store_false', dest
='geo_bypass', default
=True,
272 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
274 '--geo-bypass-country', metavar
='CODE',
275 dest
='geo_bypass_country', default
=None,
276 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
278 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
279 dest
='geo_bypass_ip_block', default
=None,
280 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
282 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
283 selection
.add_option(
285 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
286 help='Playlist video to start at (default is %default)')
287 selection
.add_option(
289 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
290 help='Playlist video to end at (default is last)')
291 selection
.add_option(
293 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
294 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')
295 selection
.add_option(
297 dest
='matchtitle', metavar
='REGEX',
298 help='Download only matching titles (regex or caseless sub-string)')
299 selection
.add_option(
301 dest
='rejecttitle', metavar
='REGEX',
302 help='Skip download for matching titles (regex or caseless sub-string)')
303 selection
.add_option(
305 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
306 help='Abort after downloading NUMBER files')
307 selection
.add_option(
309 metavar
='SIZE', dest
='min_filesize', default
=None,
310 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
311 selection
.add_option(
313 metavar
='SIZE', dest
='max_filesize', default
=None,
314 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
315 selection
.add_option(
317 metavar
='DATE', dest
='date', default
=None,
319 'Download only videos uploaded in this date. '
320 'The date can be "YYYYMMDD" or in the format '
321 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
322 selection
.add_option(
324 metavar
='DATE', dest
='datebefore', default
=None,
326 'Download only videos uploaded on or before this date. '
327 'The date formats accepted is the same as --date'))
328 selection
.add_option(
330 metavar
='DATE', dest
='dateafter', default
=None,
332 'Download only videos uploaded on or after this date. '
333 'The date formats accepted is the same as --date'))
334 selection
.add_option(
336 metavar
='COUNT', dest
='min_views', default
=None, type=int,
337 help='Do not download any videos with less than COUNT views')
338 selection
.add_option(
340 metavar
='COUNT', dest
='max_views', default
=None, type=int,
341 help='Do not download any videos with more than COUNT views')
342 selection
.add_option(
344 metavar
='FILTER', dest
='match_filter', default
=None,
346 'Generic video filter. '
347 'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
348 'match if the key is present, '
349 '!key to check if the key is not present, '
350 'key>NUMBER (like "comment_count > 12", also works with '
351 '>=, <, <=, !=, =) to compare against a number, '
352 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
353 'to match against a string literal '
354 'and & to require multiple matches. '
355 'Values which are not known are excluded unless you '
356 'put a question mark (?) after the operator. '
357 'For example, to only match videos that have been liked more than '
358 '100 times and disliked less than 50 times (or the dislike '
359 'functionality is not available at the given service), but who '
360 'also have a description, use --match-filter '
361 '"like_count > 100 & dislike_count <? 50 & description"'))
362 selection
.add_option(
364 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
365 help='Do not use generic video filter (default)')
366 selection
.add_option(
368 action
='store_true', dest
='noplaylist', default
=False,
369 help='Download only the video, if the URL refers to a video and a playlist')
370 selection
.add_option(
372 action
='store_false', dest
='noplaylist', default
=False,
373 help='Download the playlist, if the URL refers to a video and a playlist')
374 selection
.add_option(
376 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
377 help='Download only videos suitable for the given age')
378 selection
.add_option(
379 '--download-archive', metavar
='FILE',
380 dest
='download_archive',
381 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
382 selection
.add_option(
383 '--break-on-existing',
384 action
='store_true', dest
='break_on_existing', default
=False,
385 help='Stop the download process when encountering a file that is in the archive')
386 selection
.add_option(
388 action
='store_true', dest
='break_on_reject', default
=False,
389 help='Stop the download process when encountering a file that has been filtered out')
390 selection
.add_option(
391 '--no-download-archive',
392 dest
='download_archive', action
="store_const", const
=None,
393 help='Do not use archive file (default)')
394 selection
.add_option(
396 dest
='include_ads', action
='store_true',
397 help='Download advertisements as well (experimental)')
398 selection
.add_option(
400 dest
='include_ads', action
='store_false',
401 help='Do not download advertisements (default)')
403 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
404 authentication
.add_option(
406 dest
='username', metavar
='USERNAME',
407 help='Login with this account ID')
408 authentication
.add_option(
410 dest
='password', metavar
='PASSWORD',
411 help='Account password. If this option is left out, yt-dlp will ask interactively')
412 authentication
.add_option(
414 dest
='twofactor', metavar
='TWOFACTOR',
415 help='Two-factor authentication code')
416 authentication
.add_option(
418 action
='store_true', dest
='usenetrc', default
=False,
419 help='Use .netrc authentication data')
420 authentication
.add_option(
422 dest
='videopassword', metavar
='PASSWORD',
423 help='Video password (vimeo, youku)')
425 adobe_pass
= optparse
.OptionGroup(parser
, 'Adobe Pass Options')
426 adobe_pass
.add_option(
428 dest
='ap_mso', metavar
='MSO',
429 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
430 adobe_pass
.add_option(
432 dest
='ap_username', metavar
='USERNAME',
433 help='Multiple-system operator account login')
434 adobe_pass
.add_option(
436 dest
='ap_password', metavar
='PASSWORD',
437 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
438 adobe_pass
.add_option(
440 action
='store_true', dest
='ap_list_mso', default
=False,
441 help='List all supported multiple-system operators')
443 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
444 video_format
.add_option(
446 action
='store', dest
='format', metavar
='FORMAT', default
=None,
447 help='Video format code, see "FORMAT SELECTION" for more details')
448 video_format
.add_option(
449 '-S', '--format-sort', metavar
='SORTORDER',
450 dest
='format_sort', default
=[],
451 action
='callback', callback
=_comma_separated_values_options_callback
, type='str',
452 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
453 video_format
.add_option(
454 '--format-sort-force', '--S-force',
455 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
457 'Force user specified sort order to have precedence over all fields, '
458 'see "Sorting Formats" for more details'))
459 video_format
.add_option(
460 '--no-format-sort-force',
461 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
463 'Some fields have precedence over the user specified sort order (default), '
464 'see "Sorting Formats" for more details'))
465 video_format
.add_option(
466 '--video-multistreams',
467 action
='store_true', dest
='allow_multiple_video_streams', default
=False,
468 help='Allow multiple video streams to be merged into a single file')
469 video_format
.add_option(
470 '--no-video-multistreams',
471 action
='store_false', dest
='allow_multiple_video_streams',
472 help='Only one video stream is downloaded for each output file (default)')
473 video_format
.add_option(
474 '--audio-multistreams',
475 action
='store_true', dest
='allow_multiple_audio_streams', default
=False,
476 help='Allow multiple audio streams to be merged into a single file')
477 video_format
.add_option(
478 '--no-audio-multistreams',
479 action
='store_false', dest
='allow_multiple_audio_streams',
480 help='Only one audio stream is downloaded for each output file (default)')
481 video_format
.add_option(
483 action
='store_const', dest
='format', const
='all',
484 help='Download all available video formats')
485 video_format
.add_option(
486 '--prefer-free-formats',
487 action
='store_true', dest
='prefer_free_formats', default
=False,
489 'Prefer video formats with free containers over non-free ones of same quality. '
490 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
491 video_format
.add_option(
492 '--no-prefer-free-formats',
493 action
='store_true', dest
='prefer_free_formats', default
=False,
494 help="Don't give any special preference to free containers (default)")
495 video_format
.add_option(
496 '-F', '--list-formats',
497 action
='store_true', dest
='listformats',
498 help='List all available formats of requested videos')
499 video_format
.add_option(
500 '--list-formats-as-table',
501 action
='store_true', dest
='listformats_table', default
=True,
502 help='Present the output of -F in tabular form (default)')
503 video_format
.add_option(
504 '--list-formats-old', '--no-list-formats-as-table',
505 action
='store_false', dest
='listformats_table',
506 help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
507 video_format
.add_option(
508 '--merge-output-format',
509 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
511 'If a merge is required (e.g. bestvideo+bestaudio), '
512 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
513 'Ignored if no merge is required'))
514 video_format
.add_option(
515 '--allow-unplayable-formats',
516 action
='store_true', dest
='allow_unplayable_formats', default
=False,
518 'Allow unplayable formats to be listed and downloaded. '
519 'All video postprocessing will also be turned off'))
520 video_format
.add_option(
521 '--no-allow-unplayable-formats',
522 action
='store_false', dest
='allow_unplayable_formats',
523 help='Do not allow unplayable formats to be listed or downloaded (default)')
525 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
526 subtitles
.add_option(
527 '--write-subs', '--write-srt',
528 action
='store_true', dest
='writesubtitles', default
=False,
529 help='Write subtitle file')
530 subtitles
.add_option(
531 '--no-write-subs', '--no-write-srt',
532 action
='store_false', dest
='writesubtitles',
533 help='Do not write subtitle file (default)')
534 subtitles
.add_option(
535 '--write-auto-subs', '--write-automatic-subs',
536 action
='store_true', dest
='writeautomaticsub', default
=False,
537 help='Write automatically generated subtitle file (YouTube only)')
538 subtitles
.add_option(
539 '--no-write-auto-subs', '--no-write-automatic-subs',
540 action
='store_false', dest
='writeautomaticsub', default
=False,
541 help='Do not write automatically generated subtitle file (default)')
542 subtitles
.add_option(
544 action
='store_true', dest
='allsubtitles', default
=False,
545 help='Download all the available subtitles of the video')
546 subtitles
.add_option(
548 action
='store_true', dest
='listsubtitles', default
=False,
549 help='List all available subtitles for the video')
550 subtitles
.add_option(
552 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
553 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
554 subtitles
.add_option(
555 '--sub-lang', '--sub-langs', '--srt-lang',
556 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
557 default
=[], callback
=_comma_separated_values_options_callback
,
558 help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
560 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
561 downloader
.add_option(
562 '-r', '--limit-rate', '--rate-limit',
563 dest
='ratelimit', metavar
='RATE',
564 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
565 downloader
.add_option(
567 dest
='retries', metavar
='RETRIES', default
=10,
568 help='Number of retries (default is %default), or "infinite"')
569 downloader
.add_option(
570 '--fragment-retries',
571 dest
='fragment_retries', metavar
='RETRIES', default
=10,
572 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
573 downloader
.add_option(
574 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
575 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
576 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
577 downloader
.add_option(
578 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
579 action
='store_false', dest
='skip_unavailable_fragments',
580 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
581 downloader
.add_option(
583 action
='store_true', dest
='keep_fragments', default
=False,
584 help='Keep downloaded fragments on disk after downloading is finished')
585 downloader
.add_option(
586 '--no-keep-fragments',
587 action
='store_false', dest
='keep_fragments',
588 help='Delete downloaded fragments after downloading is finished (default)')
589 downloader
.add_option(
591 dest
='buffersize', metavar
='SIZE', default
='1024',
592 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
593 downloader
.add_option(
595 action
='store_false', dest
='noresizebuffer',
596 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
597 downloader
.add_option(
598 '--no-resize-buffer',
599 action
='store_true', dest
='noresizebuffer', default
=False,
600 help='Do not automatically adjust the buffer size')
601 downloader
.add_option(
603 dest
='http_chunk_size', metavar
='SIZE', default
=None,
605 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
606 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
607 downloader
.add_option(
609 action
='store_true', dest
='test', default
=False,
610 help=optparse
.SUPPRESS_HELP
)
611 downloader
.add_option(
612 '--playlist-reverse',
614 help='Download playlist videos in reverse order')
615 downloader
.add_option(
616 '--no-playlist-reverse',
617 action
='store_false', dest
='playlist_reverse',
618 help='Download playlist videos in default order (default)')
619 downloader
.add_option(
622 help='Download playlist videos in random order')
623 downloader
.add_option(
624 '--xattr-set-filesize',
625 dest
='xattr_set_filesize', action
='store_true',
626 help='Set file xattribute ytdl.filesize with expected file size')
627 downloader
.add_option(
628 '--hls-prefer-native',
629 dest
='hls_prefer_native', action
='store_true', default
=None,
630 help='Use the native HLS downloader instead of ffmpeg')
631 downloader
.add_option(
632 '--hls-prefer-ffmpeg',
633 dest
='hls_prefer_native', action
='store_false', default
=None,
634 help='Use ffmpeg instead of the native HLS downloader')
635 downloader
.add_option(
637 dest
='hls_use_mpegts', action
='store_true',
639 'Use the mpegts container for HLS videos, allowing to play the '
640 'video while downloading (some players may not be able to play it)'))
641 downloader
.add_option(
642 '--external-downloader',
643 dest
='external_downloader', metavar
='NAME',
645 'Use the specified external downloader. '
646 'Currently supports %s' % ', '.join(list_external_downloaders())))
647 downloader
.add_option(
648 '--downloader-args', '--external-downloader-args',
649 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
650 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
652 'allowed_keys': '|'.join(list_external_downloaders()),
653 'default_key': 'default', 'process': compat_shlex_split
},
655 'Give these arguments to the external downloader. '
656 'Specify the downloader name and the arguments separated by a colon ":". '
657 'You can use this option multiple times (Alias: --external-downloader-args)'))
659 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
660 workarounds
.add_option(
662 dest
='encoding', metavar
='ENCODING',
663 help='Force the specified encoding (experimental)')
664 workarounds
.add_option(
665 '--no-check-certificate',
666 action
='store_true', dest
='no_check_certificate', default
=False,
667 help='Suppress HTTPS certificate validation')
668 workarounds
.add_option(
669 '--prefer-insecure', '--prefer-unsecure',
670 action
='store_true', dest
='prefer_insecure',
671 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
672 workarounds
.add_option(
674 metavar
='UA', dest
='user_agent',
675 help='Specify a custom user agent')
676 workarounds
.add_option(
678 metavar
='URL', dest
='referer', default
=None,
679 help='Specify a custom referer, use if the video access is restricted to one domain',
681 workarounds
.add_option(
683 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
684 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
685 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
687 workarounds
.add_option(
689 dest
='bidi_workaround', action
='store_true',
690 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
691 workarounds
.add_option(
692 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
693 dest
='sleep_interval', type=float,
695 'Number of seconds to sleep before each download when used alone '
696 'or a lower bound of a range for randomized sleep before each download '
697 '(minimum possible number of seconds to sleep) when used along with '
698 '--max-sleep-interval'))
699 workarounds
.add_option(
700 '--max-sleep-interval', metavar
='SECONDS',
701 dest
='max_sleep_interval', type=float,
703 'Upper bound of a range for randomized sleep before each download '
704 '(maximum possible number of seconds to sleep). Must only be used '
705 'along with --min-sleep-interval'))
706 workarounds
.add_option(
707 '--sleep-subtitles', metavar
='SECONDS',
708 dest
='sleep_interval_subtitles', default
=0, type=int,
709 help='Enforce sleep interval on subtitles as well')
711 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity / Simulation Options')
712 verbosity
.add_option(
714 action
='store_true', dest
='quiet', default
=False,
715 help='Activate quiet mode')
716 verbosity
.add_option(
718 dest
='no_warnings', action
='store_true', default
=False,
719 help='Ignore warnings')
720 verbosity
.add_option(
722 action
='store_true', dest
='simulate', default
=False,
723 help='Do not download the video and do not write anything to disk')
724 verbosity
.add_option(
725 '--skip-download', '--no-download',
726 action
='store_true', dest
='skip_download', default
=False,
727 help='Do not download the video')
728 verbosity
.add_option(
730 action
='store_true', dest
='geturl', default
=False,
731 help='Simulate, quiet but print URL')
732 verbosity
.add_option(
734 action
='store_true', dest
='gettitle', default
=False,
735 help='Simulate, quiet but print title')
736 verbosity
.add_option(
738 action
='store_true', dest
='getid', default
=False,
739 help='Simulate, quiet but print id')
740 verbosity
.add_option(
742 action
='store_true', dest
='getthumbnail', default
=False,
743 help='Simulate, quiet but print thumbnail URL')
744 verbosity
.add_option(
746 action
='store_true', dest
='getdescription', default
=False,
747 help='Simulate, quiet but print video description')
748 verbosity
.add_option(
750 action
='store_true', dest
='getduration', default
=False,
751 help='Simulate, quiet but print video length')
752 verbosity
.add_option(
754 action
='store_true', dest
='getfilename', default
=False,
755 help='Simulate, quiet but print output filename')
756 verbosity
.add_option(
758 action
='store_true', dest
='getformat', default
=False,
759 help='Simulate, quiet but print output format')
760 verbosity
.add_option(
762 action
='store_true', dest
='dumpjson', default
=False,
763 help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
764 verbosity
.add_option(
765 '-J', '--dump-single-json',
766 action
='store_true', dest
='dump_single_json', default
=False,
768 'Simulate, quiet but print JSON information for each command-line argument. '
769 'If the URL refers to a playlist, dump the whole playlist information in a single line'))
770 verbosity
.add_option(
772 action
='store_true', dest
='print_json', default
=False,
773 help='Be quiet and print the video information as JSON (video is still being downloaded)')
774 verbosity
.add_option(
775 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
776 action
='store_true', dest
='force_write_download_archive', default
=False,
778 'Force download archive entries to be written as far as no errors occur,'
779 'even if -s or another simulation switch is used (Alias: --force-download-archive)'))
780 verbosity
.add_option(
782 action
='store_true', dest
='progress_with_newline', default
=False,
783 help='Output progress bar as new lines')
784 verbosity
.add_option(
786 action
='store_true', dest
='noprogress', default
=False,
787 help='Do not print progress bar')
788 verbosity
.add_option(
790 action
='store_true', dest
='consoletitle', default
=False,
791 help='Display progress in console titlebar')
792 verbosity
.add_option(
794 action
='store_true', dest
='verbose', default
=False,
795 help='Print various debugging information')
796 verbosity
.add_option(
797 '--dump-pages', '--dump-intermediate-pages',
798 action
='store_true', dest
='dump_intermediate_pages', default
=False,
799 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
800 verbosity
.add_option(
802 action
='store_true', dest
='write_pages', default
=False,
803 help='Write downloaded intermediary pages to files in the current directory to debug problems')
804 verbosity
.add_option(
805 '--youtube-print-sig-code',
806 action
='store_true', dest
='youtube_print_sig_code', default
=False,
807 help=optparse
.SUPPRESS_HELP
)
808 verbosity
.add_option(
809 '--print-traffic', '--dump-headers',
810 dest
='debug_printtraffic', action
='store_true', default
=False,
811 help='Display sent and read HTTP traffic')
812 verbosity
.add_option(
814 dest
='call_home', action
='store_true', default
=False,
815 # help='[Broken] Contact the yt-dlp server for debugging')
816 help=optparse
.SUPPRESS_HELP
)
817 verbosity
.add_option(
819 dest
='call_home', action
='store_false',
820 # help='Do not contact the yt-dlp server for debugging (default)')
821 help=optparse
.SUPPRESS_HELP
)
823 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
824 filesystem
.add_option(
825 '-a', '--batch-file',
826 dest
='batchfile', metavar
='FILE',
827 help="File containing URLs to download ('-' for stdin), one URL per line. "
828 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
829 filesystem
.add_option(
830 '--id', default
=False,
831 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
832 filesystem
.add_option(
834 metavar
='TYPE:PATH', dest
='paths', default
={}, type='str',
835 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
837 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
838 'process': lambda x
: x
.strip()},
840 'The paths where the files should be downloaded. '
841 'Specify the type of file and the path separated by a colon ":". '
842 'All the same types as --output are supported. '
843 'Additionally, you can also provide "home" and "temp" paths. '
844 'All intermediary files are first downloaded to the temp path and '
845 'then the final files are moved over to the home path after download is finished. '
846 'This option is ignored if --output is an absolute path'))
847 filesystem
.add_option(
849 metavar
='[TYPE:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
850 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
852 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
853 'default_key': 'default', 'process': lambda x
: x
.strip()},
854 help='Output filename template, see "OUTPUT TEMPLATE" for details')
855 filesystem
.add_option(
856 '--output-na-placeholder',
857 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
858 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
859 filesystem
.add_option(
861 dest
='autonumber_size', metavar
='NUMBER', type=int,
862 help=optparse
.SUPPRESS_HELP
)
863 filesystem
.add_option(
864 '--autonumber-start',
865 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
866 help='Specify the start value for %(autonumber)s (default is %default)')
867 filesystem
.add_option(
868 '--restrict-filenames',
869 action
='store_true', dest
='restrictfilenames', default
=False,
870 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
871 filesystem
.add_option(
872 '--no-restrict-filenames',
873 action
='store_false', dest
='restrictfilenames',
874 help='Allow Unicode characters, "&" and spaces in filenames (default)')
875 filesystem
.add_option(
876 '--windows-filenames',
877 action
='store_true', dest
='windowsfilenames', default
=False,
878 help='Force filenames to be windows compatible')
879 filesystem
.add_option(
880 '--no-windows-filenames',
881 action
='store_false', dest
='windowsfilenames',
882 help='Make filenames windows compatible only if using windows (default)')
883 filesystem
.add_option(
884 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
885 dest
='trim_file_name', default
=0, type=int,
886 help='Limit the filename length (excluding extension) to the specified number of characters')
887 filesystem
.add_option(
888 '-A', '--auto-number',
889 action
='store_true', dest
='autonumber', default
=False,
890 help=optparse
.SUPPRESS_HELP
)
891 filesystem
.add_option(
893 action
='store_true', dest
='usetitle', default
=False,
894 help=optparse
.SUPPRESS_HELP
)
895 filesystem
.add_option(
896 '-l', '--literal', default
=False,
897 action
='store_true', dest
='usetitle',
898 help=optparse
.SUPPRESS_HELP
)
899 filesystem
.add_option(
900 '-w', '--no-overwrites',
901 action
='store_false', dest
='overwrites', default
=None,
902 help='Do not overwrite any files')
903 filesystem
.add_option(
904 '--force-overwrites', '--yes-overwrites',
905 action
='store_true', dest
='overwrites',
906 help='Overwrite all video and metadata files. This option includes --no-continue')
907 filesystem
.add_option(
908 '--no-force-overwrites',
909 action
='store_const', dest
='overwrites', const
=None,
910 help='Do not overwrite the video, but overwrite related files (default)')
911 filesystem
.add_option(
913 action
='store_true', dest
='continue_dl', default
=True,
914 help='Resume partially downloaded files/fragments (default)')
915 filesystem
.add_option(
917 action
='store_false', dest
='continue_dl',
919 'Do not resume partially downloaded fragments. '
920 'If the file is unfragmented, restart download of the entire file'))
921 filesystem
.add_option(
923 action
='store_false', dest
='nopart', default
=False,
924 help='Use .part files instead of writing directly into output file (default)')
925 filesystem
.add_option(
927 action
='store_true', dest
='nopart',
928 help='Do not use .part files - write directly into output file')
929 filesystem
.add_option(
931 action
='store_true', dest
='updatetime', default
=True,
932 help='Use the Last-modified header to set the file modification time (default)')
933 filesystem
.add_option(
935 action
='store_false', dest
='updatetime',
936 help='Do not use the Last-modified header to set the file modification time')
937 filesystem
.add_option(
938 '--write-description',
939 action
='store_true', dest
='writedescription', default
=False,
940 help='Write video description to a .description file')
941 filesystem
.add_option(
942 '--no-write-description',
943 action
='store_false', dest
='writedescription',
944 help='Do not write video description (default)')
945 filesystem
.add_option(
947 action
='store_true', dest
='writeinfojson', default
=False,
948 help='Write video metadata to a .info.json file (this may contain personal information)')
949 filesystem
.add_option(
950 '--no-write-info-json',
951 action
='store_false', dest
='writeinfojson',
952 help='Do not write video metadata (default)')
953 filesystem
.add_option(
954 '--write-annotations',
955 action
='store_true', dest
='writeannotations', default
=False,
956 help='Write video annotations to a .annotations.xml file')
957 filesystem
.add_option(
958 '--no-write-annotations',
959 action
='store_false', dest
='writeannotations',
960 help='Do not write video annotations (default)')
961 filesystem
.add_option(
962 '--write-playlist-metafiles',
963 action
='store_true', dest
='allow_playlist_files', default
=True,
965 'Write playlist metadata in addition to the video metadata '
966 'when using --write-info-json, --write-description etc. (default)'))
967 filesystem
.add_option(
968 '--no-write-playlist-metafiles',
969 action
='store_false', dest
='allow_playlist_files',
971 'Do not write playlist metadata when using '
972 '--write-info-json, --write-description etc.'))
973 filesystem
.add_option(
975 action
='store_true', dest
='getcomments', default
=False,
976 help='Retrieve video comments to be placed in the .info.json file')
977 filesystem
.add_option(
978 '--load-info-json', '--load-info',
979 dest
='load_info_filename', metavar
='FILE',
980 help='JSON file containing the video information (created with the "--write-info-json" option)')
981 filesystem
.add_option(
983 dest
='cookiefile', metavar
='FILE',
984 help='File to read cookies from and dump cookie jar in')
985 filesystem
.add_option(
987 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
988 help='Do not read/dump cookies (default)')
989 filesystem
.add_option(
990 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
991 help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change')
992 filesystem
.add_option(
993 '--no-cache-dir', action
='store_false', dest
='cachedir',
994 help='Disable filesystem caching')
995 filesystem
.add_option(
997 action
='store_true', dest
='rm_cachedir',
998 help='Delete all filesystem cache files')
1000 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Images')
1001 thumbnail
.add_option(
1002 '--write-thumbnail',
1003 action
='store_true', dest
='writethumbnail', default
=False,
1004 help='Write thumbnail image to disk')
1005 thumbnail
.add_option(
1006 '--no-write-thumbnail',
1007 action
='store_false', dest
='writethumbnail',
1008 help='Do not write thumbnail image to disk (default)')
1009 thumbnail
.add_option(
1010 '--write-all-thumbnails',
1011 action
='store_true', dest
='write_all_thumbnails', default
=False,
1012 help='Write all thumbnail image formats to disk')
1013 thumbnail
.add_option(
1014 '--list-thumbnails',
1015 action
='store_true', dest
='list_thumbnails', default
=False,
1016 help='Simulate and list all available thumbnail formats')
1018 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1021 action
='store_true', dest
='writelink', default
=False,
1022 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1025 action
='store_true', dest
='writeurllink', default
=False,
1026 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1028 '--write-webloc-link',
1029 action
='store_true', dest
='writewebloclink', default
=False,
1030 help='Write a .webloc macOS internet shortcut')
1032 '--write-desktop-link',
1033 action
='store_true', dest
='writedesktoplink', default
=False,
1034 help='Write a .desktop Linux internet shortcut')
1036 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1037 postproc
.add_option(
1038 '-x', '--extract-audio',
1039 action
='store_true', dest
='extractaudio', default
=False,
1040 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1041 postproc
.add_option(
1042 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1043 help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
1044 postproc
.add_option(
1045 '--audio-quality', metavar
='QUALITY',
1046 dest
='audioquality', default
='5',
1047 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1048 postproc
.add_option(
1050 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1052 'Remux the video into another container if necessary (currently supported: %s). '
1053 'If target container does not support the video/audio codec, remuxing will fail. '
1054 'You can specify multiple rules; eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1055 'and anything else to mkv.' % '|'.join(REMUX_EXTENSIONS
)))
1056 postproc
.add_option(
1058 metavar
='FORMAT', dest
='recodevideo', default
=None,
1060 'Re-encode the video into another format if re-encoding is necessary. '
1061 'The supported formats are the same as --remux-video'))
1062 postproc
.add_option(
1063 '--postprocessor-args', '--ppa',
1064 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1065 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
1066 callback_kwargs
={'default_key': 'default-compat', 'allowed_keys': r'\w+(?:\+\w+)?', 'process': compat_shlex_split}
,
1068 'Give these arguments to the postprocessors. '
1069 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1070 'to give the argument to the specified postprocessor/executable. Supported postprocessors are: '
1071 'SponSkrub, ExtractAudio, VideoRemuxer, VideoConvertor, EmbedSubtitle, Metadata, Merger, '
1072 'FixupStretched, FixupM4a, FixupM3u8, SubtitlesConvertor and EmbedThumbnail. '
1073 'The supported executables are: SponSkrub, FFmpeg, FFprobe, and AtomicParsley. '
1074 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1075 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1076 'a number can be appended to the exe name seperated by "_i" to pass the argument '
1077 'before the specified input file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1078 'You can use this option multiple times to give different arguments to different '
1079 'postprocessors. (Alias: --ppa)'))
1080 postproc
.add_option(
1081 '-k', '--keep-video',
1082 action
='store_true', dest
='keepvideo', default
=False,
1083 help='Keep the intermediate video file on disk after post-processing')
1084 postproc
.add_option(
1086 action
='store_false', dest
='keepvideo',
1087 help='Delete the intermediate video file after post-processing (default)')
1088 postproc
.add_option(
1089 '--post-overwrites',
1090 action
='store_false', dest
='nopostoverwrites',
1091 help='Overwrite post-processed files (default)')
1092 postproc
.add_option(
1093 '--no-post-overwrites',
1094 action
='store_true', dest
='nopostoverwrites', default
=False,
1095 help='Do not overwrite post-processed files')
1096 postproc
.add_option(
1098 action
='store_true', dest
='embedsubtitles', default
=False,
1099 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1100 postproc
.add_option(
1102 action
='store_false', dest
='embedsubtitles',
1103 help='Do not embed subtitles (default)')
1104 postproc
.add_option(
1105 '--embed-thumbnail',
1106 action
='store_true', dest
='embedthumbnail', default
=False,
1107 help='Embed thumbnail in the audio as cover art')
1108 postproc
.add_option(
1109 '--no-embed-thumbnail',
1110 action
='store_false', dest
='embedthumbnail',
1111 help='Do not embed thumbnail (default)')
1112 postproc
.add_option(
1114 action
='store_true', dest
='addmetadata', default
=False,
1115 help='Write metadata to the video file')
1116 postproc
.add_option(
1117 '--no-add-metadata',
1118 action
='store_false', dest
='addmetadata',
1119 help='Do not write metadata (default)')
1120 postproc
.add_option(
1121 '--metadata-from-title',
1122 metavar
='FORMAT', dest
='metafromtitle',
1123 help=optparse
.SUPPRESS_HELP
)
1124 postproc
.add_option(
1126 metavar
='FIELD:FORMAT', dest
='metafromfield', action
='append',
1128 'Parse additional metadata like title/artist from other fields. '
1129 'Give field name to extract data from, and format of the field seperated by a ":". '
1130 'Either regular expression with named capture groups or a '
1131 'similar syntax to the output template can also be used. '
1132 'The parsed parameters replace any existing values and can be use in output template'
1133 'This option can be used multiple times. '
1134 'Example: --parse-metadata "title:%(artist)s - %(title)s" matches a title like '
1135 '"Coldplay - Paradise". '
1136 'Example (regex): --parse-metadata "description:Artist - (?P<artist>.+?)"'))
1137 postproc
.add_option(
1139 action
='store_true', dest
='xattrs', default
=False,
1140 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1141 postproc
.add_option(
1143 metavar
='POLICY', dest
='fixup', default
='detect_or_warn',
1145 'Automatically correct known faults of the file. '
1146 'One of never (do nothing), warn (only emit a warning), '
1147 'detect_or_warn (the default; fix file if we can, warn otherwise)'))
1148 postproc
.add_option(
1149 '--prefer-avconv', '--no-prefer-ffmpeg',
1150 action
='store_false', dest
='prefer_ffmpeg',
1151 help=optparse
.SUPPRESS_HELP
)
1152 postproc
.add_option(
1153 '--prefer-ffmpeg', '--no-prefer-avconv',
1154 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1155 help=optparse
.SUPPRESS_HELP
)
1156 postproc
.add_option(
1157 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1158 dest
='ffmpeg_location',
1159 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1160 postproc
.add_option(
1162 metavar
='CMD', dest
='exec_cmd',
1163 help='Execute a command on the file after downloading and post-processing, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
1164 postproc
.add_option(
1165 '--convert-subs', '--convert-subtitles',
1166 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1167 help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
1169 sponskrub
= optparse
.OptionGroup(parser
, 'SponSkrub (SponsorBlock) Options', description
=(
1170 'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
1171 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1172 sponskrub
.add_option(
1174 action
='store_true', dest
='sponskrub', default
=None,
1176 'Use sponskrub to mark sponsored sections. '
1177 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1178 sponskrub
.add_option(
1180 action
='store_false', dest
='sponskrub',
1181 help='Do not use sponskrub')
1182 sponskrub
.add_option(
1183 '--sponskrub-cut', default
=False,
1184 action
='store_true', dest
='sponskrub_cut',
1185 help='Cut out the sponsor sections instead of simply marking them')
1186 sponskrub
.add_option(
1187 '--no-sponskrub-cut',
1188 action
='store_false', dest
='sponskrub_cut',
1189 help='Simply mark the sponsor sections, not cut them out (default)')
1190 sponskrub
.add_option(
1191 '--sponskrub-force', default
=False,
1192 action
='store_true', dest
='sponskrub_force',
1193 help='Run sponskrub even if the video was already downloaded')
1194 sponskrub
.add_option(
1195 '--no-sponskrub-force',
1196 action
='store_true', dest
='sponskrub_force',
1197 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1198 sponskrub
.add_option(
1199 '--sponskrub-location', metavar
='PATH',
1200 dest
='sponskrub_path', default
='',
1201 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1202 sponskrub
.add_option(
1203 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1204 help=optparse
.SUPPRESS_HELP
)
1206 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1207 extractor
.add_option(
1208 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1209 action
='store_true', dest
='dynamic_mpd', default
=True,
1210 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1211 extractor
.add_option(
1212 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1213 action
='store_false', dest
='dynamic_mpd',
1214 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1215 extractor
.add_option(
1216 '--hls-split-discontinuity',
1217 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1218 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1220 extractor
.add_option(
1221 '--no-hls-split-discontinuity',
1222 dest
='hls_split_discontinuity', action
='store_false',
1223 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1224 extractor
.add_option(
1225 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1226 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1227 help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
1228 extractor
.add_option(
1229 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1230 action
='store_false', dest
='youtube_include_dash_manifest',
1231 help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
1232 extractor
.add_option(
1233 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1234 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1235 help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
1236 extractor
.add_option(
1237 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1238 action
='store_false', dest
='youtube_include_hls_manifest',
1239 help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
1241 parser
.add_option_group(general
)
1242 parser
.add_option_group(network
)
1243 parser
.add_option_group(geo
)
1244 parser
.add_option_group(selection
)
1245 parser
.add_option_group(downloader
)
1246 parser
.add_option_group(filesystem
)
1247 parser
.add_option_group(thumbnail
)
1248 parser
.add_option_group(link
)
1249 parser
.add_option_group(verbosity
)
1250 parser
.add_option_group(workarounds
)
1251 parser
.add_option_group(video_format
)
1252 parser
.add_option_group(subtitles
)
1253 parser
.add_option_group(authentication
)
1254 parser
.add_option_group(adobe_pass
)
1255 parser
.add_option_group(postproc
)
1256 parser
.add_option_group(sponskrub
)
1257 parser
.add_option_group(extractor
)
1259 if overrideArguments
is not None:
1260 opts
, args
= parser
.parse_args(overrideArguments
)
1262 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1264 def compat_conf(conf
):
1265 if sys
.version_info
< (3,):
1266 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1270 'command-line': compat_conf(sys
.argv
[1:]),
1271 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1272 paths
= {'command-line': False}
1273 opts
, args
= parser
.parse_args(configs
['command-line'])
1276 if '--config-location' in configs
['command-line']:
1277 location
= compat_expanduser(opts
.config_location
)
1278 if os
.path
.isdir(location
):
1279 location
= os
.path
.join(location
, 'yt-dlp.conf')
1280 if not os
.path
.exists(location
):
1281 parser
.error('config-location %s does not exist.' % location
)
1282 configs
['custom'] = _readOptions(location
, default
=None)
1283 if configs
['custom'] is None:
1284 configs
['custom'] = []
1286 paths
['custom'] = location
1287 if '--ignore-config' in configs
['command-line']:
1289 if '--ignore-config' in configs
['custom']:
1292 def read_options(path
, user
=False):
1293 # Multiple package names can be given here
1294 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1295 # the configuration file of any of these three packages
1296 for package
in ('yt-dlp',):
1298 config
, current_path
= _readUserConf(package
, default
=None)
1300 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1301 config
= _readOptions(current_path
, default
=None)
1302 if config
is not None:
1303 return config
, current_path
1306 configs
['portable'], paths
['portable'] = read_options(get_executable_path())
1307 if '--ignore-config' in configs
['portable']:
1310 def get_home_path():
1311 opts
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])[0]
1312 return expand_path(opts
.paths
.get('home', '')).strip()
1314 configs
['home'], paths
['home'] = read_options(get_home_path())
1315 if '--ignore-config' in configs
['home']:
1318 configs
['system'], paths
['system'] = read_options('/etc')
1319 if '--ignore-config' in configs
['system']:
1322 configs
['user'], paths
['user'] = read_options('', True)
1323 if '--ignore-config' in configs
['user']:
1324 configs
['system'], paths
['system'] = [], None
1327 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1328 opts
, args
= parser
.parse_args(argv
)
1330 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1332 if paths
.get(key
) is None:
1335 write_string('[debug] %s config file: %s\n' % (label
, paths
[key
]))
1336 write_string('[debug] %s config: %s\n' % (label
, repr(_hide_login_info(configs
[key
]))))
1338 return parser
, opts
, args