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
, prepend
=True):
112 parser
.values
, option
.dest
,
113 value
.split(',') if not prepend
114 else value
.split(',') + getattr(parser
.values
, option
.dest
))
116 def _dict_from_multiple_values_options_callback(
117 option
, opt_str
, value
, parser
,
118 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True):
120 out_dict
= getattr(parser
.values
, option
.dest
)
122 allowed_keys
= r
'(%s)(,(%s))*' % (allowed_keys
, allowed_keys
)
123 mobj
= re
.match(r
'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
125 keys
= [k
.strip() for k
in mobj
.group('keys').lower().split(',')]
126 val
= mobj
.group('val')
127 elif default_key
is not None:
128 keys
, val
= [default_key
], value
130 raise optparse
.OptionValueError(
131 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
132 val
= process(val
) if callable(process
) else val
136 # No need to wrap help messages if we're on a wide console
137 columns
= compat_get_terminal_size().columns
138 max_width
= columns
if columns
else 80
139 max_help_position
= 80
141 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
142 fmt
.format_option_strings
= _format_option_string
145 'version': __version__
,
147 'usage': '%prog [OPTIONS] URL [URL...]',
148 'conflict_handler': 'resolve',
151 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
153 general
= optparse
.OptionGroup(parser
, 'General Options')
157 help='Print this help text and exit')
161 help='Print program version and exit')
164 action
='store_true', dest
='update_self',
165 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
167 '-i', '--ignore-errors', '--no-abort-on-error',
168 action
='store_true', dest
='ignoreerrors', default
=True,
169 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
171 '--abort-on-error', '--no-ignore-errors',
172 action
='store_false', dest
='ignoreerrors',
173 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
176 action
='store_true', dest
='dump_user_agent', default
=False,
177 help='Display the current browser identification')
180 action
='store_true', dest
='list_extractors', default
=False,
181 help='List all supported extractors')
183 '--extractor-descriptions',
184 action
='store_true', dest
='list_extractor_descriptions', default
=False,
185 help='Output descriptions of all supported extractors')
187 '--force-generic-extractor',
188 action
='store_true', dest
='force_generic_extractor', default
=False,
189 help='Force extraction to use the generic extractor')
192 dest
='default_search', metavar
='PREFIX',
193 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')
195 '--ignore-config', '--no-config',
198 'Disable loading any configuration files except the one provided by --config-location. '
199 'When given inside a configuration file, no further configuration files are loaded. '
200 'Additionally, (for backward compatibility) if this option is found inside the '
201 'system configuration file, the user configuration is not loaded'))
204 dest
='config_location', metavar
='PATH',
205 help='Location of the main configuration file; either the path to the config or its containing directory')
208 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
209 help='Do not extract the videos of a playlist, only list them')
212 action
='store_true', dest
='extract_flat',
213 # help='Do not resolve the video urls')
215 help=optparse
.SUPPRESS_HELP
)
217 '--no-flat-playlist',
218 action
='store_false', dest
='extract_flat',
219 help='Extract the videos of a playlist')
222 action
='store_true', dest
='mark_watched', default
=False,
223 help='Mark videos watched (YouTube only)')
226 action
='store_false', dest
='mark_watched',
227 help='Do not mark videos watched (default)')
230 action
='store_true', dest
='no_color', default
=False,
231 help='Do not emit color codes in output')
233 network
= optparse
.OptionGroup(parser
, 'Network Options')
235 '--proxy', dest
='proxy',
236 default
=None, metavar
='URL',
238 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
239 'SOCKS proxy, specify a proper scheme. For example '
240 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
241 'for direct connection'))
244 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
245 help='Time to wait before giving up, in seconds')
248 metavar
='IP', dest
='source_address', default
=None,
249 help='Client-side IP address to bind to',
252 '-4', '--force-ipv4',
253 action
='store_const', const
='0.0.0.0', dest
='source_address',
254 help='Make all connections via IPv4',
257 '-6', '--force-ipv6',
258 action
='store_const', const
='::', dest
='source_address',
259 help='Make all connections via IPv6',
262 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
264 '--geo-verification-proxy',
265 dest
='geo_verification_proxy', default
=None, metavar
='URL',
267 'Use this proxy to verify the IP address for some geo-restricted sites. '
268 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
270 '--cn-verification-proxy',
271 dest
='cn_verification_proxy', default
=None, metavar
='URL',
272 help=optparse
.SUPPRESS_HELP
)
275 action
='store_true', dest
='geo_bypass', default
=True,
276 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
279 action
='store_false', dest
='geo_bypass', default
=True,
280 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
282 '--geo-bypass-country', metavar
='CODE',
283 dest
='geo_bypass_country', default
=None,
284 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
286 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
287 dest
='geo_bypass_ip_block', default
=None,
288 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
290 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
291 selection
.add_option(
293 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
294 help='Playlist video to start at (default is %default)')
295 selection
.add_option(
297 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
298 help='Playlist video to end at (default is last)')
299 selection
.add_option(
301 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
302 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')
303 selection
.add_option(
305 dest
='matchtitle', metavar
='REGEX',
306 help='Download only matching titles (regex or caseless sub-string)')
307 selection
.add_option(
309 dest
='rejecttitle', metavar
='REGEX',
310 help='Skip download for matching titles (regex or caseless sub-string)')
311 selection
.add_option(
313 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
314 help='Abort after downloading NUMBER files')
315 selection
.add_option(
317 metavar
='SIZE', dest
='min_filesize', default
=None,
318 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
319 selection
.add_option(
321 metavar
='SIZE', dest
='max_filesize', default
=None,
322 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
323 selection
.add_option(
325 metavar
='DATE', dest
='date', default
=None,
327 'Download only videos uploaded in this date. '
328 'The date can be "YYYYMMDD" or in the format '
329 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
330 selection
.add_option(
332 metavar
='DATE', dest
='datebefore', default
=None,
334 'Download only videos uploaded on or before this date. '
335 'The date formats accepted is the same as --date'))
336 selection
.add_option(
338 metavar
='DATE', dest
='dateafter', default
=None,
340 'Download only videos uploaded on or after this date. '
341 'The date formats accepted is the same as --date'))
342 selection
.add_option(
344 metavar
='COUNT', dest
='min_views', default
=None, type=int,
345 help='Do not download any videos with less than COUNT views')
346 selection
.add_option(
348 metavar
='COUNT', dest
='max_views', default
=None, type=int,
349 help='Do not download any videos with more than COUNT views')
350 selection
.add_option(
352 metavar
='FILTER', dest
='match_filter', default
=None,
354 'Generic video filter. '
355 'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
356 'match if the key is present, '
357 '!key to check if the key is not present, '
358 'key>NUMBER (like "view_count > 12", also works with '
359 '>=, <, <=, !=, =) to compare against a number, '
360 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
361 'to match against a string literal '
362 'and & to require multiple matches. '
363 'Values which are not known are excluded unless you '
364 'put a question mark (?) after the operator. '
365 'For example, to only match videos that have been liked more than '
366 '100 times and disliked less than 50 times (or the dislike '
367 'functionality is not available at the given service), but who '
368 'also have a description, use --match-filter '
369 '"like_count > 100 & dislike_count <? 50 & description"'))
370 selection
.add_option(
372 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
373 help='Do not use generic video filter (default)')
374 selection
.add_option(
376 action
='store_true', dest
='noplaylist', default
=False,
377 help='Download only the video, if the URL refers to a video and a playlist')
378 selection
.add_option(
380 action
='store_false', dest
='noplaylist',
381 help='Download the playlist, if the URL refers to a video and a playlist')
382 selection
.add_option(
384 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
385 help='Download only videos suitable for the given age')
386 selection
.add_option(
387 '--download-archive', metavar
='FILE',
388 dest
='download_archive',
389 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
390 selection
.add_option(
391 '--break-on-existing',
392 action
='store_true', dest
='break_on_existing', default
=False,
393 help='Stop the download process when encountering a file that is in the archive')
394 selection
.add_option(
396 action
='store_true', dest
='break_on_reject', default
=False,
397 help='Stop the download process when encountering a file that has been filtered out')
398 selection
.add_option(
399 '--skip-playlist-after-errors', metavar
='N',
400 dest
='skip_playlist_after_errors', default
=None, type=int,
401 help='Number of allowed failures until the rest of the playlist is skipped')
402 selection
.add_option(
403 '--no-download-archive',
404 dest
='download_archive', action
="store_const", const
=None,
405 help='Do not use archive file (default)')
406 selection
.add_option(
408 dest
='include_ads', action
='store_true',
409 help=optparse
.SUPPRESS_HELP
)
410 selection
.add_option(
412 dest
='include_ads', action
='store_false',
413 help=optparse
.SUPPRESS_HELP
)
415 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
416 authentication
.add_option(
418 dest
='username', metavar
='USERNAME',
419 help='Login with this account ID')
420 authentication
.add_option(
422 dest
='password', metavar
='PASSWORD',
423 help='Account password. If this option is left out, yt-dlp will ask interactively')
424 authentication
.add_option(
426 dest
='twofactor', metavar
='TWOFACTOR',
427 help='Two-factor authentication code')
428 authentication
.add_option(
430 action
='store_true', dest
='usenetrc', default
=False,
431 help='Use .netrc authentication data')
432 authentication
.add_option(
434 dest
='videopassword', metavar
='PASSWORD',
435 help='Video password (vimeo, youku)')
436 authentication
.add_option(
438 dest
='ap_mso', metavar
='MSO',
439 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
440 authentication
.add_option(
442 dest
='ap_username', metavar
='USERNAME',
443 help='Multiple-system operator account login')
444 authentication
.add_option(
446 dest
='ap_password', metavar
='PASSWORD',
447 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
448 authentication
.add_option(
450 action
='store_true', dest
='ap_list_mso', default
=False,
451 help='List all supported multiple-system operators')
453 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
454 video_format
.add_option(
456 action
='store', dest
='format', metavar
='FORMAT', default
=None,
457 help='Video format code, see "FORMAT SELECTION" for more details')
458 video_format
.add_option(
459 '-S', '--format-sort', metavar
='SORTORDER',
460 dest
='format_sort', default
=[],
461 action
='callback', callback
=_comma_separated_values_options_callback
, type='str',
462 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
463 video_format
.add_option(
464 '--format-sort-force', '--S-force',
465 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
467 'Force user specified sort order to have precedence over all fields, '
468 'see "Sorting Formats" for more details'))
469 video_format
.add_option(
470 '--no-format-sort-force',
471 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
473 'Some fields have precedence over the user specified sort order (default), '
474 'see "Sorting Formats" for more details'))
475 video_format
.add_option(
476 '--video-multistreams',
477 action
='store_true', dest
='allow_multiple_video_streams', default
=False,
478 help='Allow multiple video streams to be merged into a single file')
479 video_format
.add_option(
480 '--no-video-multistreams',
481 action
='store_false', dest
='allow_multiple_video_streams',
482 help='Only one video stream is downloaded for each output file (default)')
483 video_format
.add_option(
484 '--audio-multistreams',
485 action
='store_true', dest
='allow_multiple_audio_streams', default
=False,
486 help='Allow multiple audio streams to be merged into a single file')
487 video_format
.add_option(
488 '--no-audio-multistreams',
489 action
='store_false', dest
='allow_multiple_audio_streams',
490 help='Only one audio stream is downloaded for each output file (default)')
491 video_format
.add_option(
493 action
='store_const', dest
='format', const
='all',
494 help=optparse
.SUPPRESS_HELP
)
495 video_format
.add_option(
496 '--prefer-free-formats',
497 action
='store_true', dest
='prefer_free_formats', default
=False,
499 'Prefer video formats with free containers over non-free ones of same quality. '
500 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
501 video_format
.add_option(
502 '--no-prefer-free-formats',
503 action
='store_true', dest
='prefer_free_formats', default
=False,
504 help="Don't give any special preference to free containers (default)")
505 video_format
.add_option(
506 '-F', '--list-formats',
507 action
='store_true', dest
='listformats',
508 help='List all available formats of requested videos')
509 video_format
.add_option(
510 '--list-formats-as-table',
511 action
='store_true', dest
='listformats_table', default
=True,
512 help='Present the output of -F in tabular form (default)')
513 video_format
.add_option(
514 '--list-formats-old', '--no-list-formats-as-table',
515 action
='store_false', dest
='listformats_table',
516 help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
517 video_format
.add_option(
518 '--merge-output-format',
519 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
521 'If a merge is required (e.g. bestvideo+bestaudio), '
522 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
523 'Ignored if no merge is required'))
524 video_format
.add_option(
525 '--allow-unplayable-formats',
526 action
='store_true', dest
='allow_unplayable_formats', default
=False,
528 'Allow unplayable formats to be listed and downloaded. '
529 'All video post-processing will also be turned off'))
530 video_format
.add_option(
531 '--no-allow-unplayable-formats',
532 action
='store_false', dest
='allow_unplayable_formats',
533 help='Do not allow unplayable formats to be listed or downloaded (default)')
535 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
536 subtitles
.add_option(
537 '--write-subs', '--write-srt',
538 action
='store_true', dest
='writesubtitles', default
=False,
539 help='Write subtitle file')
540 subtitles
.add_option(
541 '--no-write-subs', '--no-write-srt',
542 action
='store_false', dest
='writesubtitles',
543 help='Do not write subtitle file (default)')
544 subtitles
.add_option(
545 '--write-auto-subs', '--write-automatic-subs',
546 action
='store_true', dest
='writeautomaticsub', default
=False,
547 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
548 subtitles
.add_option(
549 '--no-write-auto-subs', '--no-write-automatic-subs',
550 action
='store_false', dest
='writeautomaticsub', default
=False,
551 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
552 subtitles
.add_option(
554 action
='store_true', dest
='allsubtitles', default
=False,
555 help=optparse
.SUPPRESS_HELP
)
556 subtitles
.add_option(
558 action
='store_true', dest
='listsubtitles', default
=False,
559 help='List all available subtitles for the video')
560 subtitles
.add_option(
562 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
563 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
564 subtitles
.add_option(
565 '--sub-langs', '--srt-langs',
566 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
567 default
=[], callback
=_comma_separated_values_options_callback
,
569 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs en.*,ja) '
570 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
571 'Use --list-subs for a list of available language tags'))
573 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
574 downloader
.add_option(
575 '-N', '--concurrent-fragments',
576 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
577 help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
578 downloader
.add_option(
579 '-r', '--limit-rate', '--rate-limit',
580 dest
='ratelimit', metavar
='RATE',
581 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
582 downloader
.add_option(
584 dest
='retries', metavar
='RETRIES', default
=10,
585 help='Number of retries (default is %default), or "infinite"')
586 downloader
.add_option(
587 '--fragment-retries',
588 dest
='fragment_retries', metavar
='RETRIES', default
=10,
589 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
590 downloader
.add_option(
591 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
592 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
593 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
594 downloader
.add_option(
595 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
596 action
='store_false', dest
='skip_unavailable_fragments',
597 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
598 downloader
.add_option(
600 action
='store_true', dest
='keep_fragments', default
=False,
601 help='Keep downloaded fragments on disk after downloading is finished')
602 downloader
.add_option(
603 '--no-keep-fragments',
604 action
='store_false', dest
='keep_fragments',
605 help='Delete downloaded fragments after downloading is finished (default)')
606 downloader
.add_option(
608 dest
='buffersize', metavar
='SIZE', default
='1024',
609 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
610 downloader
.add_option(
612 action
='store_false', dest
='noresizebuffer',
613 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
614 downloader
.add_option(
615 '--no-resize-buffer',
616 action
='store_true', dest
='noresizebuffer', default
=False,
617 help='Do not automatically adjust the buffer size')
618 downloader
.add_option(
620 dest
='http_chunk_size', metavar
='SIZE', default
=None,
622 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
623 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
624 downloader
.add_option(
626 action
='store_true', dest
='test', default
=False,
627 help=optparse
.SUPPRESS_HELP
)
628 downloader
.add_option(
629 '--playlist-reverse',
631 help='Download playlist videos in reverse order')
632 downloader
.add_option(
633 '--no-playlist-reverse',
634 action
='store_false', dest
='playlist_reverse',
635 help='Download playlist videos in default order (default)')
636 downloader
.add_option(
639 help='Download playlist videos in random order')
640 downloader
.add_option(
641 '--xattr-set-filesize',
642 dest
='xattr_set_filesize', action
='store_true',
643 help='Set file xattribute ytdl.filesize with expected file size')
644 downloader
.add_option(
645 '--hls-prefer-native',
646 dest
='hls_prefer_native', action
='store_true', default
=None,
647 help=optparse
.SUPPRESS_HELP
)
648 downloader
.add_option(
649 '--hls-prefer-ffmpeg',
650 dest
='hls_prefer_native', action
='store_false', default
=None,
651 help=optparse
.SUPPRESS_HELP
)
652 downloader
.add_option(
654 dest
='hls_use_mpegts', action
='store_true', default
=None,
656 'Use the mpegts container for HLS videos; '
657 'allowing some players to play the video while downloading, '
658 'and reducing the chance of file corruption if download is interrupted. '
659 'This is enabled by default for live streams'))
660 downloader
.add_option(
661 '--no-hls-use-mpegts',
662 dest
='hls_use_mpegts', action
='store_false',
664 'Do not use the mpegts container for HLS videos. '
665 'This is default when not downloading live streams'))
666 downloader
.add_option(
667 '--downloader', '--external-downloader',
668 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
669 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
671 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
672 'default_key': 'default', 'process': lambda x
: x
.strip()},
674 'Name or path of the external downloader to use (optionally) prefixed by '
675 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
676 'Currently supports native, %s (Recommended: aria2c). '
677 'You can use this option multiple times to set different downloaders for different protocols. '
678 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
679 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
680 '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
681 downloader
.add_option(
682 '--downloader-args', '--external-downloader-args',
683 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
684 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
686 'allowed_keys': '|'.join(list_external_downloaders()),
687 'default_key': 'default', 'process': compat_shlex_split
},
689 'Give these arguments to the external downloader. '
690 'Specify the downloader name and the arguments separated by a colon ":". '
691 'You can use this option multiple times (Alias: --external-downloader-args)'))
693 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
694 workarounds
.add_option(
696 dest
='encoding', metavar
='ENCODING',
697 help='Force the specified encoding (experimental)')
698 workarounds
.add_option(
699 '--no-check-certificate',
700 action
='store_true', dest
='no_check_certificate', default
=False,
701 help='Suppress HTTPS certificate validation')
702 workarounds
.add_option(
703 '--prefer-insecure', '--prefer-unsecure',
704 action
='store_true', dest
='prefer_insecure',
705 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
706 workarounds
.add_option(
708 metavar
='UA', dest
='user_agent',
709 help='Specify a custom user agent')
710 workarounds
.add_option(
712 metavar
='URL', dest
='referer', default
=None,
713 help='Specify a custom referer, use if the video access is restricted to one domain',
715 workarounds
.add_option(
717 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
718 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
719 callback_kwargs
={'multiple_keys': False}
,
720 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
722 workarounds
.add_option(
724 dest
='bidi_workaround', action
='store_true',
725 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
726 workarounds
.add_option(
727 '--sleep-requests', metavar
='SECONDS',
728 dest
='sleep_interval_requests', type=float,
729 help='Number of seconds to sleep between requests during data extraction')
730 workarounds
.add_option(
731 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
732 dest
='sleep_interval', type=float,
734 'Number of seconds to sleep before each download. '
735 'This is the minimum time to sleep when used along with --max-sleep-interval '
736 '(Alias: --min-sleep-interval)'))
737 workarounds
.add_option(
738 '--max-sleep-interval', metavar
='SECONDS',
739 dest
='max_sleep_interval', type=float,
740 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
741 workarounds
.add_option(
742 '--sleep-subtitles', metavar
='SECONDS',
743 dest
='sleep_interval_subtitles', default
=0, type=int,
744 help='Number of seconds to sleep before each subtitle download')
746 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
747 verbosity
.add_option(
749 action
='store_true', dest
='quiet', default
=False,
750 help='Activate quiet mode')
751 verbosity
.add_option(
753 dest
='no_warnings', action
='store_true', default
=False,
754 help='Ignore warnings')
755 verbosity
.add_option(
757 action
='store_true', dest
='simulate', default
=False,
758 help='Do not download the video and do not write anything to disk')
759 verbosity
.add_option(
760 '--ignore-no-formats-error',
761 action
='store_true', dest
='ignore_no_formats_error', default
=False,
763 'Ignore "No video formats" error. Usefull for extracting metadata '
764 'even if the video is not actually available for download (experimental)'))
765 verbosity
.add_option(
766 '--no-ignore-no-formats-error',
767 action
='store_false', dest
='ignore_no_formats_error',
768 help='Throw error when no downloadable video formats are found (default)')
769 verbosity
.add_option(
770 '--skip-download', '--no-download',
771 action
='store_true', dest
='skip_download', default
=False,
772 help='Do not download the video but write all related files (Alias: --no-download)')
773 verbosity
.add_option(
775 action
='store_true', dest
='geturl', default
=False,
776 help='Simulate, quiet but print URL')
777 verbosity
.add_option(
779 action
='store_true', dest
='gettitle', default
=False,
780 help='Simulate, quiet but print title')
781 verbosity
.add_option(
783 action
='store_true', dest
='getid', default
=False,
784 help='Simulate, quiet but print id')
785 verbosity
.add_option(
787 action
='store_true', dest
='getthumbnail', default
=False,
788 help='Simulate, quiet but print thumbnail URL')
789 verbosity
.add_option(
791 action
='store_true', dest
='getdescription', default
=False,
792 help='Simulate, quiet but print video description')
793 verbosity
.add_option(
795 action
='store_true', dest
='getduration', default
=False,
796 help='Simulate, quiet but print video length')
797 verbosity
.add_option(
799 action
='store_true', dest
='getfilename', default
=False,
800 help='Simulate, quiet but print output filename')
801 verbosity
.add_option(
803 action
='store_true', dest
='getformat', default
=False,
804 help='Simulate, quiet but print output format')
805 verbosity
.add_option(
807 action
='store_true', dest
='dumpjson', default
=False,
808 help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
809 verbosity
.add_option(
810 '-J', '--dump-single-json',
811 action
='store_true', dest
='dump_single_json', default
=False,
813 'Simulate, quiet but print JSON information for each command-line argument. '
814 'If the URL refers to a playlist, dump the whole playlist information in a single line'))
815 verbosity
.add_option(
817 action
='store_true', dest
='print_json', default
=False,
818 help='Be quiet and print the video information as JSON (video is still being downloaded)')
819 verbosity
.add_option(
820 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
821 action
='store_true', dest
='force_write_download_archive', default
=False,
823 'Force download archive entries to be written as far as no errors occur, '
824 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
825 verbosity
.add_option(
827 action
='store_true', dest
='progress_with_newline', default
=False,
828 help='Output progress bar as new lines')
829 verbosity
.add_option(
831 action
='store_true', dest
='noprogress', default
=False,
832 help='Do not print progress bar')
833 verbosity
.add_option(
835 action
='store_true', dest
='consoletitle', default
=False,
836 help='Display progress in console titlebar')
837 verbosity
.add_option(
839 action
='store_true', dest
='verbose', default
=False,
840 help='Print various debugging information')
841 verbosity
.add_option(
842 '--dump-pages', '--dump-intermediate-pages',
843 action
='store_true', dest
='dump_intermediate_pages', default
=False,
844 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
845 verbosity
.add_option(
847 action
='store_true', dest
='write_pages', default
=False,
848 help='Write downloaded intermediary pages to files in the current directory to debug problems')
849 verbosity
.add_option(
850 '--youtube-print-sig-code',
851 action
='store_true', dest
='youtube_print_sig_code', default
=False,
852 help=optparse
.SUPPRESS_HELP
)
853 verbosity
.add_option(
854 '--print-traffic', '--dump-headers',
855 dest
='debug_printtraffic', action
='store_true', default
=False,
856 help='Display sent and read HTTP traffic')
857 verbosity
.add_option(
859 dest
='call_home', action
='store_true', default
=False,
860 # help='[Broken] Contact the yt-dlp server for debugging')
861 help=optparse
.SUPPRESS_HELP
)
862 verbosity
.add_option(
864 dest
='call_home', action
='store_false',
865 # help='Do not contact the yt-dlp server for debugging (default)')
866 help=optparse
.SUPPRESS_HELP
)
868 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
869 filesystem
.add_option(
870 '-a', '--batch-file',
871 dest
='batchfile', metavar
='FILE',
872 help="File containing URLs to download ('-' for stdin), one URL per line. "
873 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
874 filesystem
.add_option(
875 '--id', default
=False,
876 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
877 filesystem
.add_option(
879 metavar
='TYPES:PATH', dest
='paths', default
={}, type='str',
880 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
882 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
883 'process': lambda x
: x
.strip()},
885 'The paths where the files should be downloaded. '
886 'Specify the type of file and the path separated by a colon ":". '
887 'All the same types as --output are supported. '
888 'Additionally, you can also provide "home" and "temp" paths. '
889 'All intermediary files are first downloaded to the temp path and '
890 'then the final files are moved over to the home path after download is finished. '
891 'This option is ignored if --output is an absolute path'))
892 filesystem
.add_option(
894 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
895 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
897 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
898 'default_key': 'default', 'process': lambda x
: x
.strip()},
899 help='Output filename template; see "OUTPUT TEMPLATE" for details')
900 filesystem
.add_option(
901 '--output-na-placeholder',
902 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
903 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
904 filesystem
.add_option(
906 dest
='autonumber_size', metavar
='NUMBER', type=int,
907 help=optparse
.SUPPRESS_HELP
)
908 filesystem
.add_option(
909 '--autonumber-start',
910 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
911 help=optparse
.SUPPRESS_HELP
)
912 filesystem
.add_option(
913 '--restrict-filenames',
914 action
='store_true', dest
='restrictfilenames', default
=False,
915 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
916 filesystem
.add_option(
917 '--no-restrict-filenames',
918 action
='store_false', dest
='restrictfilenames',
919 help='Allow Unicode characters, "&" and spaces in filenames (default)')
920 filesystem
.add_option(
921 '--windows-filenames',
922 action
='store_true', dest
='windowsfilenames', default
=False,
923 help='Force filenames to be windows compatible')
924 filesystem
.add_option(
925 '--no-windows-filenames',
926 action
='store_false', dest
='windowsfilenames',
927 help='Make filenames windows compatible only if using windows (default)')
928 filesystem
.add_option(
929 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
930 dest
='trim_file_name', default
=0, type=int,
931 help='Limit the filename length (excluding extension) to the specified number of characters')
932 filesystem
.add_option(
933 '-A', '--auto-number',
934 action
='store_true', dest
='autonumber', default
=False,
935 help=optparse
.SUPPRESS_HELP
)
936 filesystem
.add_option(
938 action
='store_true', dest
='usetitle', default
=False,
939 help=optparse
.SUPPRESS_HELP
)
940 filesystem
.add_option(
941 '-l', '--literal', default
=False,
942 action
='store_true', dest
='usetitle',
943 help=optparse
.SUPPRESS_HELP
)
944 filesystem
.add_option(
945 '-w', '--no-overwrites',
946 action
='store_false', dest
='overwrites', default
=None,
947 help='Do not overwrite any files')
948 filesystem
.add_option(
949 '--force-overwrites', '--yes-overwrites',
950 action
='store_true', dest
='overwrites',
951 help='Overwrite all video and metadata files. This option includes --no-continue')
952 filesystem
.add_option(
953 '--no-force-overwrites',
954 action
='store_const', dest
='overwrites', const
=None,
955 help='Do not overwrite the video, but overwrite related files (default)')
956 filesystem
.add_option(
958 action
='store_true', dest
='continue_dl', default
=True,
959 help='Resume partially downloaded files/fragments (default)')
960 filesystem
.add_option(
962 action
='store_false', dest
='continue_dl',
964 'Do not resume partially downloaded fragments. '
965 'If the file is not fragmented, restart download of the entire file'))
966 filesystem
.add_option(
968 action
='store_false', dest
='nopart', default
=False,
969 help='Use .part files instead of writing directly into output file (default)')
970 filesystem
.add_option(
972 action
='store_true', dest
='nopart',
973 help='Do not use .part files - write directly into output file')
974 filesystem
.add_option(
976 action
='store_true', dest
='updatetime', default
=True,
977 help='Use the Last-modified header to set the file modification time (default)')
978 filesystem
.add_option(
980 action
='store_false', dest
='updatetime',
981 help='Do not use the Last-modified header to set the file modification time')
982 filesystem
.add_option(
983 '--write-description',
984 action
='store_true', dest
='writedescription', default
=False,
985 help='Write video description to a .description file')
986 filesystem
.add_option(
987 '--no-write-description',
988 action
='store_false', dest
='writedescription',
989 help='Do not write video description (default)')
990 filesystem
.add_option(
992 action
='store_true', dest
='writeinfojson', default
=False,
993 help='Write video metadata to a .info.json file (this may contain personal information)')
994 filesystem
.add_option(
995 '--no-write-info-json',
996 action
='store_false', dest
='writeinfojson',
997 help='Do not write video metadata (default)')
998 filesystem
.add_option(
999 '--write-annotations',
1000 action
='store_true', dest
='writeannotations', default
=False,
1001 help='Write video annotations to a .annotations.xml file')
1002 filesystem
.add_option(
1003 '--no-write-annotations',
1004 action
='store_false', dest
='writeannotations',
1005 help='Do not write video annotations (default)')
1006 filesystem
.add_option(
1007 '--write-playlist-metafiles',
1008 action
='store_true', dest
='allow_playlist_files', default
=True,
1010 'Write playlist metadata in addition to the video metadata '
1011 'when using --write-info-json, --write-description etc. (default)'))
1012 filesystem
.add_option(
1013 '--no-write-playlist-metafiles',
1014 action
='store_false', dest
='allow_playlist_files',
1015 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1016 filesystem
.add_option(
1018 action
='store_true', dest
='clean_infojson', default
=True,
1020 'Remove some private fields such as filenames from the infojson. '
1021 'Note that it could still contain some personal information (default)'))
1022 filesystem
.add_option(
1023 '--no-clean-infojson',
1024 action
='store_false', dest
='clean_infojson',
1025 help='Write all fields to the infojson')
1026 filesystem
.add_option(
1028 action
='store_true', dest
='getcomments', default
=False,
1030 'Retrieve video comments to be placed in the .info.json file. '
1031 'The comments are fetched even without this option if the extraction is known to be quick'))
1032 filesystem
.add_option(
1033 '--load-info-json', '--load-info',
1034 dest
='load_info_filename', metavar
='FILE',
1035 help='JSON file containing the video information (created with the "--write-info-json" option)')
1036 filesystem
.add_option(
1038 dest
='cookiefile', metavar
='FILE',
1039 help='File to read cookies from and dump cookie jar in')
1040 filesystem
.add_option(
1042 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1043 help='Do not read/dump cookies (default)')
1044 filesystem
.add_option(
1045 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1046 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')
1047 filesystem
.add_option(
1048 '--no-cache-dir', action
='store_false', dest
='cachedir',
1049 help='Disable filesystem caching')
1050 filesystem
.add_option(
1052 action
='store_true', dest
='rm_cachedir',
1053 help='Delete all filesystem cache files')
1055 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1056 thumbnail
.add_option(
1057 '--write-thumbnail',
1058 action
='store_true', dest
='writethumbnail', default
=False,
1059 help='Write thumbnail image to disk')
1060 thumbnail
.add_option(
1061 '--no-write-thumbnail',
1062 action
='store_false', dest
='writethumbnail',
1063 help='Do not write thumbnail image to disk (default)')
1064 thumbnail
.add_option(
1065 '--write-all-thumbnails',
1066 action
='store_true', dest
='write_all_thumbnails', default
=False,
1067 help='Write all thumbnail image formats to disk')
1068 thumbnail
.add_option(
1069 '--list-thumbnails',
1070 action
='store_true', dest
='list_thumbnails', default
=False,
1071 help='Simulate and list all available thumbnail formats')
1073 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1076 action
='store_true', dest
='writelink', default
=False,
1077 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1080 action
='store_true', dest
='writeurllink', default
=False,
1081 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1083 '--write-webloc-link',
1084 action
='store_true', dest
='writewebloclink', default
=False,
1085 help='Write a .webloc macOS internet shortcut')
1087 '--write-desktop-link',
1088 action
='store_true', dest
='writedesktoplink', default
=False,
1089 help='Write a .desktop Linux internet shortcut')
1091 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1092 postproc
.add_option(
1093 '-x', '--extract-audio',
1094 action
='store_true', dest
='extractaudio', default
=False,
1095 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1096 postproc
.add_option(
1097 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1098 help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
1099 postproc
.add_option(
1100 '--audio-quality', metavar
='QUALITY',
1101 dest
='audioquality', default
='5',
1102 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1103 postproc
.add_option(
1105 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1107 'Remux the video into another container if necessary (currently supported: %s). '
1108 'If target container does not support the video/audio codec, remuxing will fail. '
1109 'You can specify multiple rules; eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1110 'and anything else to mkv.' % '|'.join(REMUX_EXTENSIONS
)))
1111 postproc
.add_option(
1113 metavar
='FORMAT', dest
='recodevideo', default
=None,
1115 'Re-encode the video into another format if re-encoding is necessary. '
1116 'The supported formats are the same as --remux-video'))
1117 postproc
.add_option(
1118 '--postprocessor-args', '--ppa',
1119 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1120 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
1122 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1123 'process': compat_shlex_split
, 'multiple_keys': False},
1125 'Give these arguments to the postprocessors. '
1126 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1127 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1128 'Merger, ExtractAudio, SplitChapters, Metadata, EmbedSubtitle, EmbedThumbnail, '
1129 'SubtitlesConvertor, ThumbnailsConvertor, VideoRemuxer, VideoConvertor, '
1130 'SponSkrub, FixupStretched, FixupM4a and FixupM3u8. '
1131 'The supported executables are: AtomicParsley, FFmpeg, FFprobe, and SponSkrub. '
1132 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1133 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1134 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1135 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1136 'You can use this option multiple times to give different arguments to different '
1137 'postprocessors. (Alias: --ppa)'))
1138 postproc
.add_option(
1139 '-k', '--keep-video',
1140 action
='store_true', dest
='keepvideo', default
=False,
1141 help='Keep the intermediate video file on disk after post-processing')
1142 postproc
.add_option(
1144 action
='store_false', dest
='keepvideo',
1145 help='Delete the intermediate video file after post-processing (default)')
1146 postproc
.add_option(
1147 '--post-overwrites',
1148 action
='store_false', dest
='nopostoverwrites',
1149 help='Overwrite post-processed files (default)')
1150 postproc
.add_option(
1151 '--no-post-overwrites',
1152 action
='store_true', dest
='nopostoverwrites', default
=False,
1153 help='Do not overwrite post-processed files')
1154 postproc
.add_option(
1156 action
='store_true', dest
='embedsubtitles', default
=False,
1157 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1158 postproc
.add_option(
1160 action
='store_false', dest
='embedsubtitles',
1161 help='Do not embed subtitles (default)')
1162 postproc
.add_option(
1163 '--embed-thumbnail',
1164 action
='store_true', dest
='embedthumbnail', default
=False,
1165 help='Embed thumbnail in the audio as cover art')
1166 postproc
.add_option(
1167 '--no-embed-thumbnail',
1168 action
='store_false', dest
='embedthumbnail',
1169 help='Do not embed thumbnail (default)')
1170 postproc
.add_option(
1172 action
='store_true', dest
='addmetadata', default
=False,
1173 help='Write metadata to the video file')
1174 postproc
.add_option(
1175 '--no-add-metadata',
1176 action
='store_false', dest
='addmetadata',
1177 help='Do not write metadata (default)')
1178 postproc
.add_option(
1179 '--metadata-from-title',
1180 metavar
='FORMAT', dest
='metafromtitle',
1181 help=optparse
.SUPPRESS_HELP
)
1182 postproc
.add_option(
1184 metavar
='FROM:TO', dest
='metafromfield', action
='append',
1186 'Parse additional metadata like title/artist from other fields; '
1187 'see "MODIFYING METADATA" for details'))
1188 postproc
.add_option(
1190 action
='store_true', dest
='xattrs', default
=False,
1191 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1192 postproc
.add_option(
1194 metavar
='POLICY', dest
='fixup', default
=None,
1196 'Automatically correct known faults of the file. '
1197 'One of never (do nothing), warn (only emit a warning), '
1198 'detect_or_warn (the default; fix file if we can, warn otherwise)'))
1199 postproc
.add_option(
1200 '--prefer-avconv', '--no-prefer-ffmpeg',
1201 action
='store_false', dest
='prefer_ffmpeg',
1202 help=optparse
.SUPPRESS_HELP
)
1203 postproc
.add_option(
1204 '--prefer-ffmpeg', '--no-prefer-avconv',
1205 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1206 help=optparse
.SUPPRESS_HELP
)
1207 postproc
.add_option(
1208 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1209 dest
='ffmpeg_location',
1210 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1211 postproc
.add_option(
1213 metavar
='CMD', dest
='exec_cmd',
1215 'Execute a command on the file after downloading and post-processing. '
1216 'Similar syntax to the output template can be used to pass any field as arguments to the command. '
1217 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1218 'If no fields are passed, "%(filepath)s" is appended to the end of the command'))
1219 postproc
.add_option(
1220 '--convert-subs', '--convert-sub', '--convert-subtitles',
1221 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1222 help='Convert the subtitles to another format (currently supported: srt|ass|vtt|lrc) (Alias: --convert-subtitles)')
1223 postproc
.add_option(
1224 '--convert-thumbnails',
1225 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1226 help='Convert the thumbnails to another format (currently supported: jpg)')
1227 postproc
.add_option(
1228 '--split-chapters', '--split-tracks',
1229 dest
='split_chapters', action
='store_true', default
=False,
1231 'Split video into multiple files based on internal chapters. '
1232 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1233 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1234 postproc
.add_option(
1235 '--no-split-chapters', '--no-split-tracks',
1236 dest
='split_chapters', action
='store_false',
1237 help='Do not split video based on chapters (default)')
1239 sponskrub
= optparse
.OptionGroup(parser
, 'SponSkrub (SponsorBlock) Options', description
=(
1240 'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
1241 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1242 sponskrub
.add_option(
1244 action
='store_true', dest
='sponskrub', default
=None,
1246 'Use sponskrub to mark sponsored sections. '
1247 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1248 sponskrub
.add_option(
1250 action
='store_false', dest
='sponskrub',
1251 help='Do not use sponskrub')
1252 sponskrub
.add_option(
1253 '--sponskrub-cut', default
=False,
1254 action
='store_true', dest
='sponskrub_cut',
1255 help='Cut out the sponsor sections instead of simply marking them')
1256 sponskrub
.add_option(
1257 '--no-sponskrub-cut',
1258 action
='store_false', dest
='sponskrub_cut',
1259 help='Simply mark the sponsor sections, not cut them out (default)')
1260 sponskrub
.add_option(
1261 '--sponskrub-force', default
=False,
1262 action
='store_true', dest
='sponskrub_force',
1263 help='Run sponskrub even if the video was already downloaded')
1264 sponskrub
.add_option(
1265 '--no-sponskrub-force',
1266 action
='store_true', dest
='sponskrub_force',
1267 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1268 sponskrub
.add_option(
1269 '--sponskrub-location', metavar
='PATH',
1270 dest
='sponskrub_path', default
='',
1271 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1272 sponskrub
.add_option(
1273 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1274 help=optparse
.SUPPRESS_HELP
)
1276 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1277 extractor
.add_option(
1278 '--extractor-retries',
1279 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1280 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1281 extractor
.add_option(
1282 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1283 action
='store_true', dest
='dynamic_mpd', default
=True,
1284 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1285 extractor
.add_option(
1286 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1287 action
='store_false', dest
='dynamic_mpd',
1288 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1289 extractor
.add_option(
1290 '--hls-split-discontinuity',
1291 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1292 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1294 extractor
.add_option(
1295 '--no-hls-split-discontinuity',
1296 dest
='hls_split_discontinuity', action
='store_false',
1297 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1298 extractor
.add_option(
1299 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1300 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1301 help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
1302 extractor
.add_option(
1303 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1304 action
='store_false', dest
='youtube_include_dash_manifest',
1305 help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
1306 extractor
.add_option(
1307 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1308 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1309 help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
1310 extractor
.add_option(
1311 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1312 action
='store_false', dest
='youtube_include_hls_manifest',
1313 help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
1315 parser
.add_option_group(general
)
1316 parser
.add_option_group(network
)
1317 parser
.add_option_group(geo
)
1318 parser
.add_option_group(selection
)
1319 parser
.add_option_group(downloader
)
1320 parser
.add_option_group(filesystem
)
1321 parser
.add_option_group(thumbnail
)
1322 parser
.add_option_group(link
)
1323 parser
.add_option_group(verbosity
)
1324 parser
.add_option_group(workarounds
)
1325 parser
.add_option_group(video_format
)
1326 parser
.add_option_group(subtitles
)
1327 parser
.add_option_group(authentication
)
1328 parser
.add_option_group(postproc
)
1329 parser
.add_option_group(sponskrub
)
1330 parser
.add_option_group(extractor
)
1332 if overrideArguments
is not None:
1333 opts
, args
= parser
.parse_args(overrideArguments
)
1335 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1337 def compat_conf(conf
):
1338 if sys
.version_info
< (3,):
1339 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1343 'command-line': compat_conf(sys
.argv
[1:]),
1344 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1345 paths
= {'command-line': False}
1346 opts
, args
= parser
.parse_args(configs
['command-line'])
1349 if '--config-location' in configs
['command-line']:
1350 location
= compat_expanduser(opts
.config_location
)
1351 if os
.path
.isdir(location
):
1352 location
= os
.path
.join(location
, 'yt-dlp.conf')
1353 if not os
.path
.exists(location
):
1354 parser
.error('config-location %s does not exist.' % location
)
1355 configs
['custom'] = _readOptions(location
, default
=None)
1356 if configs
['custom'] is None:
1357 configs
['custom'] = []
1359 paths
['custom'] = location
1360 if '--ignore-config' in configs
['command-line']:
1362 if '--ignore-config' in configs
['custom']:
1365 def read_options(path
, user
=False):
1366 # Multiple package names can be given here
1367 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1368 # the configuration file of any of these three packages
1369 for package
in ('yt-dlp',):
1371 config
, current_path
= _readUserConf(package
, default
=None)
1373 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1374 config
= _readOptions(current_path
, default
=None)
1375 if config
is not None:
1376 return config
, current_path
1379 configs
['portable'], paths
['portable'] = read_options(get_executable_path())
1380 if '--ignore-config' in configs
['portable']:
1383 def get_home_path():
1384 opts
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])[0]
1385 return expand_path(opts
.paths
.get('home', '')).strip()
1387 configs
['home'], paths
['home'] = read_options(get_home_path())
1388 if '--ignore-config' in configs
['home']:
1391 configs
['system'], paths
['system'] = read_options('/etc')
1392 if '--ignore-config' in configs
['system']:
1395 configs
['user'], paths
['user'] = read_options('', True)
1396 if '--ignore-config' in configs
['user']:
1397 configs
['system'], paths
['system'] = [], None
1400 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1401 opts
, args
= parser
.parse_args(argv
)
1403 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1405 if paths
.get(key
) is None:
1408 write_string('[debug] %s config file: %s\n' % (label
, paths
[key
]))
1409 write_string('[debug] %s config: %s\n' % (label
, repr(_hide_login_info(configs
[key
]))))
1411 return parser
, opts
, args