2 f
'You are using an unsupported version of Python. Only Python versions 3.6 and above are supported by yt-dlp' # noqa: F541
4 __license__
= 'Public Domain'
12 from .compat
import compat_getpass
, compat_shlex_quote
13 from .cookies
import SUPPORTED_BROWSERS
, SUPPORTED_KEYRINGS
14 from .downloader
import FileDownloader
15 from .downloader
.external
import get_external_downloader
16 from .extractor
import list_extractor_classes
17 from .extractor
.adobepass
import MSO_INFO
18 from .extractor
.common
import InfoExtractor
19 from .options
import parseOpts
20 from .postprocessor
import (
22 FFmpegSubtitlesConvertorPP
,
23 FFmpegThumbnailsConvertorPP
,
24 FFmpegVideoConvertorPP
,
29 from .update
import Updater
57 from .YoutubeDL
import YoutubeDL
60 def _exit(status
=0, *args
):
63 raise SystemExit(status
)
66 def get_urls(urls
, batchfile
, verbose
):
67 # Batch file verification
69 if batchfile
is not None:
71 batch_urls
= read_batch_urls(
72 read_stdin('URLs') if batchfile
== '-'
73 else open(expand_path(batchfile
), encoding
='utf-8', errors
='ignore'))
75 write_string('[debug] Batch file urls: ' + repr(batch_urls
) + '\n')
77 _exit(f
'ERROR: batch file {batchfile} could not be read')
78 _enc
= preferredencoding()
80 url
.strip().decode(_enc
, 'ignore') if isinstance(url
, bytes) else url
.strip()
81 for url
in batch_urls
+ urls
]
84 def print_extractor_information(opts
, urls
):
85 # Importing GenericIE is currently slow since it imports other extractors
86 # TODO: Move this back to module level after generalization of embed detection
87 from .extractor
.generic
import GenericIE
90 if opts
.list_extractors
:
91 urls
= dict.fromkeys(urls
, False)
92 for ie
in list_extractor_classes(opts
.age_limit
):
93 out
+= ie
.IE_NAME
+ (' (CURRENTLY BROKEN)' if not ie
.working() else '') + '\n'
95 matched_urls
= [url
for url
, matched
in urls
.items() if not matched
]
97 matched_urls
= tuple(filter(ie
.suitable
, urls
.keys()))
98 urls
.update(dict.fromkeys(matched_urls
, True))
99 out
+= ''.join(f
' {url}\n' for url
in matched_urls
)
100 elif opts
.list_extractor_descriptions
:
101 _SEARCHES
= ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
103 ie
.description(markdown
=False, search_examples
=_SEARCHES
)
104 for ie
in list_extractor_classes(opts
.age_limit
) if ie
.working() and ie
.IE_DESC
is not False)
105 elif opts
.ap_list_mso
:
106 out
= 'Supported TV Providers:\n%s\n' % render_table(
108 [[mso_id
, mso_info
['name']] for mso_id
, mso_info
in MSO_INFO
.items()])
111 write_string(out
, out
=sys
.stdout
)
115 def set_compat_opts(opts
):
116 def _unused_compat_opt(name
):
117 if name
not in opts
.compat_opts
:
119 opts
.compat_opts
.discard(name
)
120 opts
.compat_opts
.update(['*%s' % name
])
123 def set_default_compat(compat_name
, opt_name
, default
=True, remove_compat
=True):
124 attr
= getattr(opts
, opt_name
)
125 if compat_name
in opts
.compat_opts
:
127 setattr(opts
, opt_name
, not default
)
131 _unused_compat_opt(compat_name
)
134 setattr(opts
, opt_name
, default
)
137 set_default_compat('abort-on-error', 'ignoreerrors', 'only_download')
138 set_default_compat('no-playlist-metafiles', 'allow_playlist_files')
139 set_default_compat('no-clean-infojson', 'clean_infojson')
140 if 'no-attach-info-json' in opts
.compat_opts
:
141 if opts
.embed_infojson
:
142 _unused_compat_opt('no-attach-info-json')
144 opts
.embed_infojson
= False
145 if 'format-sort' in opts
.compat_opts
:
146 opts
.format_sort
.extend(InfoExtractor
.FormatSort
.ytdl_default
)
147 _video_multistreams_set
= set_default_compat('multistreams', 'allow_multiple_video_streams', False, remove_compat
=False)
148 _audio_multistreams_set
= set_default_compat('multistreams', 'allow_multiple_audio_streams', False, remove_compat
=False)
149 if _video_multistreams_set
is False and _audio_multistreams_set
is False:
150 _unused_compat_opt('multistreams')
151 if 'filename' in opts
.compat_opts
:
152 if opts
.outtmpl
.get('default') is None:
153 opts
.outtmpl
.update({'default': '%(title)s-%(id)s.%(ext)s'}
)
155 _unused_compat_opt('filename')
158 def validate_options(opts
):
159 def validate(cndn
, name
, value
=None, msg
=None):
162 raise ValueError((msg
or 'invalid {name} "{value}" given').format(name
=name
, value
=value
))
164 def validate_in(name
, value
, items
, msg
=None):
165 return validate(value
is None or value
in items
, name
, value
, msg
)
167 def validate_regex(name
, value
, regex
):
168 return validate(value
is None or re
.match(regex
, value
), name
, value
)
170 def validate_positive(name
, value
, strict
=False):
171 return validate(value
is None or value
> 0 or (not strict
and value
== 0),
172 name
, value
, '{name} "{value}" must be positive' + ('' if strict
else ' or 0'))
174 def validate_minmax(min_val
, max_val
, min_name
, max_name
=None):
175 if max_val
is None or min_val
is None or max_val
>= min_val
:
178 min_name
, max_name
= f
'min {min_name}', f
'max {min_name}'
179 raise ValueError(f
'{max_name} "{max_val}" must be must be greater than or equal to {min_name} "{min_val}"')
181 # Usernames and passwords
182 validate(not opts
.usenetrc
or (opts
.username
is None and opts
.password
is None),
183 '.netrc', msg
='using {name} conflicts with giving username/password')
184 validate(opts
.password
is None or opts
.username
is not None, 'account username', msg
='{name} missing')
185 validate(opts
.ap_password
is None or opts
.ap_username
is not None,
186 'TV Provider account username', msg
='{name} missing')
187 validate_in('TV Provider', opts
.ap_mso
, MSO_INFO
,
188 'Unsupported {name} "{value}", use --ap-list-mso to get a list of supported TV Providers')
191 validate_positive('autonumber start', opts
.autonumber_start
)
192 validate_positive('autonumber size', opts
.autonumber_size
, True)
193 validate_positive('concurrent fragments', opts
.concurrent_fragment_downloads
, True)
194 validate_positive('playlist start', opts
.playliststart
, True)
195 if opts
.playlistend
!= -1:
196 validate_minmax(opts
.playliststart
, opts
.playlistend
, 'playlist start', 'playlist end')
199 validate_positive('subtitles sleep interval', opts
.sleep_interval_subtitles
)
200 validate_positive('requests sleep interval', opts
.sleep_interval_requests
)
201 validate_positive('sleep interval', opts
.sleep_interval
)
202 validate_positive('max sleep interval', opts
.max_sleep_interval
)
203 if opts
.sleep_interval
is None:
205 opts
.max_sleep_interval
is None, 'min sleep interval',
206 msg
='{name} must be specified; use --min-sleep-interval')
207 elif opts
.max_sleep_interval
is None:
208 opts
.max_sleep_interval
= opts
.sleep_interval
210 validate_minmax(opts
.sleep_interval
, opts
.max_sleep_interval
, 'sleep interval')
212 if opts
.wait_for_video
is not None:
213 min_wait
, max_wait
, *_
= map(parse_duration
, opts
.wait_for_video
.split('-', 1) + [None])
214 validate(min_wait
is not None and not (max_wait
is None and '-' in opts
.wait_for_video
),
215 'time range to wait for video', opts
.wait_for_video
)
216 validate_minmax(min_wait
, max_wait
, 'time range to wait for video')
217 opts
.wait_for_video
= (min_wait
, max_wait
)
220 for f
in opts
.format_sort
:
221 validate_regex('format sorting', f
, InfoExtractor
.FormatSort
.regex
)
223 # Postprocessor formats
224 validate_regex('audio format', opts
.audioformat
, FFmpegExtractAudioPP
.FORMAT_RE
)
225 validate_in('subtitle format', opts
.convertsubtitles
, FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)
226 validate_regex('thumbnail format', opts
.convertthumbnails
, FFmpegThumbnailsConvertorPP
.FORMAT_RE
)
227 validate_regex('recode video format', opts
.recodevideo
, FFmpegVideoConvertorPP
.FORMAT_RE
)
228 validate_regex('remux video format', opts
.remuxvideo
, FFmpegVideoRemuxerPP
.FORMAT_RE
)
229 if opts
.audioquality
:
230 opts
.audioquality
= opts
.audioquality
.strip('k').strip('K')
231 # int_or_none prevents inf, nan
232 validate_positive('audio quality', int_or_none(float_or_none(opts
.audioquality
), default
=0))
235 def parse_retries(name
, value
):
238 elif value
in ('inf', 'infinite'):
242 except (TypeError, ValueError):
243 validate(False, f
'{name} retry count', value
)
245 opts
.retries
= parse_retries('download', opts
.retries
)
246 opts
.fragment_retries
= parse_retries('fragment', opts
.fragment_retries
)
247 opts
.extractor_retries
= parse_retries('extractor', opts
.extractor_retries
)
248 opts
.file_access_retries
= parse_retries('file access', opts
.file_access_retries
)
250 # Retry sleep function
251 def parse_sleep_func(expr
):
252 NUMBER_RE
= r
'\d+(?:\.\d+)?'
253 op
, start
, limit
, step
, *_
= tuple(re
.fullmatch(
254 rf
'(?:(linear|exp)=)?({NUMBER_RE})(?::({NUMBER_RE})?)?(?::({NUMBER_RE}))?',
255 expr
.strip()).groups()) + (None, None)
258 return lambda n
: min(float(start
) * (float(step
or 2) ** n
), float(limit
or 'inf'))
260 default_step
= start
if op
or limit
else 0
261 return lambda n
: min(float(start
) + float(step
or default_step
) * n
, float(limit
or 'inf'))
263 for key
, expr
in opts
.retry_sleep
.items():
265 del opts
.retry_sleep
[key
]
268 opts
.retry_sleep
[key
] = parse_sleep_func(expr
)
269 except AttributeError:
270 raise ValueError(f
'invalid {key} retry sleep expression {expr!r}')
273 def parse_bytes(name
, value
):
276 numeric_limit
= FileDownloader
.parse_bytes(value
)
277 validate(numeric_limit
is not None, 'rate limit', value
)
280 opts
.ratelimit
= parse_bytes('rate limit', opts
.ratelimit
)
281 opts
.throttledratelimit
= parse_bytes('throttled rate limit', opts
.throttledratelimit
)
282 opts
.min_filesize
= parse_bytes('min filesize', opts
.min_filesize
)
283 opts
.max_filesize
= parse_bytes('max filesize', opts
.max_filesize
)
284 opts
.buffersize
= parse_bytes('buffer size', opts
.buffersize
)
285 opts
.http_chunk_size
= parse_bytes('http chunk size', opts
.http_chunk_size
)
288 def validate_outtmpl(tmpl
, msg
):
289 err
= YoutubeDL
.validate_outtmpl(tmpl
)
291 raise ValueError(f
'invalid {msg} "{tmpl}": {err}')
293 for k
, tmpl
in opts
.outtmpl
.items():
294 validate_outtmpl(tmpl
, f
'{k} output template')
295 for type_
, tmpl_list
in opts
.forceprint
.items():
296 for tmpl
in tmpl_list
:
297 validate_outtmpl(tmpl
, f
'{type_} print template')
298 for type_
, tmpl_list
in opts
.print_to_file
.items():
299 for tmpl
, file in tmpl_list
:
300 validate_outtmpl(tmpl
, f
'{type_} print to file template')
301 validate_outtmpl(file, f
'{type_} print to file filename')
302 validate_outtmpl(opts
.sponsorblock_chapter_title
, 'SponsorBlock chapter title')
303 for k
, tmpl
in opts
.progress_template
.items():
304 k
= f
'{k[:-6]} console title' if '-title' in k
else f
'{k} progress'
305 validate_outtmpl(tmpl
, f
'{k} template')
307 outtmpl_default
= opts
.outtmpl
.get('default')
308 if outtmpl_default
== '':
309 opts
.skip_download
= None
310 del opts
.outtmpl
['default']
311 if outtmpl_default
and not os
.path
.splitext(outtmpl_default
)[1] and opts
.extractaudio
:
313 'Cannot download a video and extract audio into the same file! '
314 f
'Use "{outtmpl_default}.%(ext)s" instead of "{outtmpl_default}" as the output template')
316 def parse_chapters(name
, value
):
317 chapters
, ranges
= [], []
318 for regex
in value
or []:
319 if regex
.startswith('*'):
320 for range in regex
[1:].split(','):
321 dur
= tuple(map(parse_duration
, range.strip().split('-')))
322 if len(dur
) == 2 and all(t
is not None for t
in dur
):
325 raise ValueError(f
'invalid {name} time range "{regex}". Must be of the form *start-end')
328 chapters
.append(re
.compile(regex
))
329 except re
.error
as err
:
330 raise ValueError(f
'invalid {name} regex "{regex}" - {err}')
331 return chapters
, ranges
333 opts
.remove_chapters
, opts
.remove_ranges
= parse_chapters('--remove-chapters', opts
.remove_chapters
)
334 opts
.download_ranges
= download_range_func(*parse_chapters('--download-sections', opts
.download_ranges
))
336 # Cookies from browser
337 if opts
.cookiesfrombrowser
:
338 mobj
= re
.match(r
'(?P<name>[^+:]+)(\s*\+\s*(?P<keyring>[^:]+))?(\s*:(?P<profile>.+))?', opts
.cookiesfrombrowser
)
340 raise ValueError(f
'invalid cookies from browser arguments: {opts.cookiesfrombrowser}')
341 browser_name
, keyring
, profile
= mobj
.group('name', 'keyring', 'profile')
342 browser_name
= browser_name
.lower()
343 if browser_name
not in SUPPORTED_BROWSERS
:
344 raise ValueError(f
'unsupported browser specified for cookies: "{browser_name}". '
345 f
'Supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}')
346 if keyring
is not None:
347 keyring
= keyring
.upper()
348 if keyring
not in SUPPORTED_KEYRINGS
:
349 raise ValueError(f
'unsupported keyring specified for cookies: "{keyring}". '
350 f
'Supported keyrings are: {", ".join(sorted(SUPPORTED_KEYRINGS))}')
351 opts
.cookiesfrombrowser
= (browser_name
, profile
, keyring
)
354 def metadataparser_actions(f
):
355 if isinstance(f
, str):
356 cmd
= '--parse-metadata %s' % compat_shlex_quote(f
)
358 actions
= [MetadataFromFieldPP
.to_action(f
)]
359 except Exception as err
:
360 raise ValueError(f
'{cmd} is invalid; {err}')
362 cmd
= '--replace-in-metadata %s' % ' '.join(map(compat_shlex_quote
, f
))
363 actions
= ((MetadataParserPP
.Actions
.REPLACE
, x
, *f
[1:]) for x
in f
[0].split(','))
365 for action
in actions
:
367 MetadataParserPP
.validate_action(*action
)
368 except Exception as err
:
369 raise ValueError(f
'{cmd} is invalid; {err}')
372 parse_metadata
= opts
.parse_metadata
or []
373 if opts
.metafromtitle
is not None:
374 parse_metadata
.append('title:%s' % opts
.metafromtitle
)
375 opts
.parse_metadata
= list(itertools
.chain(*map(metadataparser_actions
, parse_metadata
)))
378 if opts
.playlist_items
is not None:
380 tuple(PlaylistEntries
.parse_playlist_items(opts
.playlist_items
))
381 except Exception as err
:
382 raise ValueError(f
'Invalid playlist-items {opts.playlist_items!r}: {err}')
384 geo_bypass_code
= opts
.geo_bypass_ip_block
or opts
.geo_bypass_country
385 if geo_bypass_code
is not None:
387 GeoUtils
.random_ipv4(geo_bypass_code
)
389 raise ValueError('unsupported geo-bypass country or ip-block')
391 opts
.match_filter
= match_filter_func(opts
.match_filter
)
393 if opts
.download_archive
is not None:
394 opts
.download_archive
= expand_path(opts
.download_archive
)
396 if opts
.user_agent
is not None:
397 opts
.headers
.setdefault('User-Agent', opts
.user_agent
)
398 if opts
.referer
is not None:
399 opts
.headers
.setdefault('Referer', opts
.referer
)
401 if opts
.no_sponsorblock
:
402 opts
.sponsorblock_mark
= opts
.sponsorblock_remove
= set()
404 default_downloader
= None
405 for proto
, path
in opts
.external_downloader
.items():
406 ed
= get_external_downloader(path
)
409 f
'No such {format_field(proto, None, "%s ", ignore="default")}external downloader "{path}"')
410 elif ed
and proto
== 'default':
411 default_downloader
= ed
.get_basename()
413 warnings
, deprecation_warnings
= [], []
415 # Common mistake: -f best
416 if opts
.format
== 'best':
417 warnings
.append('.\n '.join((
418 '"-f best" selects the best pre-merged format which is often not the best option',
419 'To let yt-dlp download and merge the best available formats, simply do not pass any format selection',
420 'If you know what you are doing and want only the best pre-merged format, use "-f b" instead to suppress this warning')))
422 # --(postprocessor/downloader)-args without name
423 def report_args_compat(name
, value
, key1
, key2
=None, where
=None):
424 if key1
in value
and key2
not in value
:
425 warnings
.append(f
'{name.title()} arguments given without specifying name. '
426 f
'The arguments will be given to {where or f"all {name}s"}')
430 if report_args_compat('external downloader', opts
.external_downloader_args
,
431 'default', where
=default_downloader
) and default_downloader
:
432 # Compat with youtube-dl's behavior. See https://github.com/ytdl-org/youtube-dl/commit/49c5293014bc11ec8c009856cd63cffa6296c1e1
433 opts
.external_downloader_args
.setdefault(default_downloader
, opts
.external_downloader_args
.pop('default'))
435 if report_args_compat('post-processor', opts
.postprocessor_args
, 'default-compat', 'default'):
436 opts
.postprocessor_args
['default'] = opts
.postprocessor_args
.pop('default-compat')
437 opts
.postprocessor_args
.setdefault('sponskrub', [])
439 def report_conflict(arg1
, opt1
, arg2
='--allow-unplayable-formats', opt2
='allow_unplayable_formats',
440 val1
=NO_DEFAULT
, val2
=NO_DEFAULT
, default
=False):
441 if val2
is NO_DEFAULT
:
442 val2
= getattr(opts
, opt2
)
446 if val1
is NO_DEFAULT
:
447 val1
= getattr(opts
, opt1
)
449 warnings
.append(f
'{arg1} is ignored since {arg2} was given')
450 setattr(opts
, opt1
, default
)
452 # Conflicting options
453 report_conflict('--playlist-reverse', 'playlist_reverse', '--playlist-random', 'playlist_random')
454 report_conflict('--playlist-reverse', 'playlist_reverse', '--lazy-playlist', 'lazy_playlist')
455 report_conflict('--playlist-random', 'playlist_random', '--lazy-playlist', 'lazy_playlist')
456 report_conflict('--dateafter', 'dateafter', '--date', 'date', default
=None)
457 report_conflict('--datebefore', 'datebefore', '--date', 'date', default
=None)
458 report_conflict('--exec-before-download', 'exec_before_dl_cmd',
459 '"--exec before_dl:"', 'exec_cmd', val2
=opts
.exec_cmd
.get('before_dl'))
460 report_conflict('--id', 'useid', '--output', 'outtmpl', val2
=opts
.outtmpl
.get('default'))
461 report_conflict('--remux-video', 'remuxvideo', '--recode-video', 'recodevideo')
462 report_conflict('--sponskrub', 'sponskrub', '--remove-chapters', 'remove_chapters')
463 report_conflict('--sponskrub', 'sponskrub', '--sponsorblock-mark', 'sponsorblock_mark')
464 report_conflict('--sponskrub', 'sponskrub', '--sponsorblock-remove', 'sponsorblock_remove')
465 report_conflict('--sponskrub-cut', 'sponskrub_cut', '--split-chapter', 'split_chapters',
466 val1
=opts
.sponskrub
and opts
.sponskrub_cut
)
468 # Conflicts with --allow-unplayable-formats
469 report_conflict('--add-metadata', 'addmetadata')
470 report_conflict('--embed-chapters', 'addchapters')
471 report_conflict('--embed-info-json', 'embed_infojson')
472 report_conflict('--embed-subs', 'embedsubtitles')
473 report_conflict('--embed-thumbnail', 'embedthumbnail')
474 report_conflict('--extract-audio', 'extractaudio')
475 report_conflict('--fixup', 'fixup', val1
=opts
.fixup
not in (None, 'never', 'ignore'), default
='never')
476 report_conflict('--recode-video', 'recodevideo')
477 report_conflict('--remove-chapters', 'remove_chapters', default
=[])
478 report_conflict('--remux-video', 'remuxvideo')
479 report_conflict('--sponskrub', 'sponskrub')
480 report_conflict('--sponsorblock-remove', 'sponsorblock_remove', default
=set())
481 report_conflict('--xattrs', 'xattrs')
483 # Fully deprecated options
484 def report_deprecation(val
, old
, new
=None):
487 deprecation_warnings
.append(
488 f
'{old} is deprecated and may be removed in a future version. Use {new} instead' if new
489 else f
'{old} is deprecated and may not work as expected')
491 report_deprecation(opts
.sponskrub
, '--sponskrub', '--sponsorblock-mark or --sponsorblock-remove')
492 report_deprecation(not opts
.prefer_ffmpeg
, '--prefer-avconv', 'ffmpeg')
493 # report_deprecation(opts.include_ads, '--include-ads') # We may re-implement this in future
494 # report_deprecation(opts.call_home, '--call-home') # We may re-implement this in future
495 # report_deprecation(opts.writeannotations, '--write-annotations') # It's just that no website has it
498 opts
.date
= DateRange
.day(opts
.date
) if opts
.date
else DateRange(opts
.dateafter
, opts
.datebefore
)
500 if opts
.exec_before_dl_cmd
:
501 opts
.exec_cmd
['before_dl'] = opts
.exec_before_dl_cmd
503 if opts
.useid
: # --id is not deprecated in youtube-dl
504 opts
.outtmpl
['default'] = '%(id)s.%(ext)s'
506 if opts
.overwrites
: # --force-overwrites implies --no-continue
507 opts
.continue_dl
= False
509 if (opts
.addmetadata
or opts
.sponsorblock_mark
) and opts
.addchapters
is None:
510 # Add chapters when adding metadata or marking sponsors
511 opts
.addchapters
= True
513 if opts
.extractaudio
and not opts
.keepvideo
and opts
.format
is None:
514 # Do not unnecessarily download audio
515 opts
.format
= 'bestaudio/best'
517 if opts
.getcomments
and opts
.writeinfojson
is None:
518 # If JSON is not printed anywhere, but comments are requested, save it to file
519 if not opts
.dumpjson
or opts
.print_json
or opts
.dump_single_json
:
520 opts
.writeinfojson
= True
522 if opts
.allsubtitles
and not (opts
.embedsubtitles
or opts
.writeautomaticsub
):
523 # --all-sub automatically sets --write-sub if --write-auto-sub is not given
524 opts
.writesubtitles
= True
526 if opts
.addmetadata
and opts
.embed_infojson
is None:
527 # If embedding metadata and infojson is present, embed it
528 opts
.embed_infojson
= 'if_exists'
531 if opts
.username
is not None and opts
.password
is None:
532 opts
.password
= compat_getpass('Type account password and press [Return]: ')
533 if opts
.ap_username
is not None and opts
.ap_password
is None:
534 opts
.ap_password
= compat_getpass('Type TV provider account password and press [Return]: ')
536 return warnings
, deprecation_warnings
539 def get_postprocessors(opts
):
540 yield from opts
.add_postprocessors
542 if opts
.parse_metadata
:
544 'key': 'MetadataParser',
545 'actions': opts
.parse_metadata
,
546 'when': 'pre_process'
548 sponsorblock_query
= opts
.sponsorblock_mark | opts
.sponsorblock_remove
549 if sponsorblock_query
:
551 'key': 'SponsorBlock',
552 'categories': sponsorblock_query
,
553 'api': opts
.sponsorblock_api
,
554 'when': 'after_filter'
556 if opts
.convertsubtitles
:
558 'key': 'FFmpegSubtitlesConvertor',
559 'format': opts
.convertsubtitles
,
562 if opts
.convertthumbnails
:
564 'key': 'FFmpegThumbnailsConvertor',
565 'format': opts
.convertthumbnails
,
568 if opts
.extractaudio
:
570 'key': 'FFmpegExtractAudio',
571 'preferredcodec': opts
.audioformat
,
572 'preferredquality': opts
.audioquality
,
573 'nopostoverwrites': opts
.nopostoverwrites
,
577 'key': 'FFmpegVideoRemuxer',
578 'preferedformat': opts
.remuxvideo
,
582 'key': 'FFmpegVideoConvertor',
583 'preferedformat': opts
.recodevideo
,
585 # If ModifyChapters is going to remove chapters, subtitles must already be in the container.
586 if opts
.embedsubtitles
:
587 keep_subs
= 'no-keep-subs' not in opts
.compat_opts
589 'key': 'FFmpegEmbedSubtitle',
590 # already_have_subtitle = True prevents the file from being deleted after embedding
591 'already_have_subtitle': opts
.writesubtitles
and keep_subs
593 if not opts
.writeautomaticsub
and keep_subs
:
594 opts
.writesubtitles
= True
596 # ModifyChapters must run before FFmpegMetadataPP
597 if opts
.remove_chapters
or sponsorblock_query
:
599 'key': 'ModifyChapters',
600 'remove_chapters_patterns': opts
.remove_chapters
,
601 'remove_sponsor_segments': opts
.sponsorblock_remove
,
602 'remove_ranges': opts
.remove_ranges
,
603 'sponsorblock_chapter_title': opts
.sponsorblock_chapter_title
,
604 'force_keyframes': opts
.force_keyframes_at_cuts
606 # FFmpegMetadataPP should be run after FFmpegVideoConvertorPP and
607 # FFmpegExtractAudioPP as containers before conversion may not support
608 # metadata (3gp, webm, etc.)
609 # By default ffmpeg preserves metadata applicable for both
610 # source and target containers. From this point the container won't change,
611 # so metadata can be added here.
612 if opts
.addmetadata
or opts
.addchapters
or opts
.embed_infojson
:
614 'key': 'FFmpegMetadata',
615 'add_chapters': opts
.addchapters
,
616 'add_metadata': opts
.addmetadata
,
617 'add_infojson': opts
.embed_infojson
,
620 # This should be above EmbedThumbnail since sponskrub removes the thumbnail attachment
621 # but must be below EmbedSubtitle and FFmpegMetadata
622 # See https://github.com/yt-dlp/yt-dlp/issues/204 , https://github.com/faissaloo/SponSkrub/issues/29
623 # If opts.sponskrub is None, sponskrub is used, but it silently fails if the executable can't be found
624 if opts
.sponskrub
is not False:
627 'path': opts
.sponskrub_path
,
628 'args': opts
.sponskrub_args
,
629 'cut': opts
.sponskrub_cut
,
630 'force': opts
.sponskrub_force
,
631 'ignoreerror': opts
.sponskrub
is None,
634 if opts
.embedthumbnail
:
636 'key': 'EmbedThumbnail',
637 # already_have_thumbnail = True prevents the file from being deleted after embedding
638 'already_have_thumbnail': opts
.writethumbnail
640 if not opts
.writethumbnail
:
641 opts
.writethumbnail
= True
642 opts
.outtmpl
['pl_thumbnail'] = ''
643 if opts
.split_chapters
:
645 'key': 'FFmpegSplitChapters',
646 'force_keyframes': opts
.force_keyframes_at_cuts
,
648 # XAttrMetadataPP should be run after post-processors that may change file contents
650 yield {'key': 'XAttrMetadata'}
651 if opts
.concat_playlist
!= 'never':
653 'key': 'FFmpegConcat',
654 'only_multi_video': opts
.concat_playlist
!= 'always',
657 # Exec must be the last PP of each category
658 for when
, exec_cmd
in opts
.exec_cmd
.items():
661 'exec_cmd': exec_cmd
,
666 def parse_options(argv
=None):
667 """ @returns (parser, opts, urls, ydl_opts) """
668 parser
, opts
, urls
= parseOpts(argv
)
669 urls
= get_urls(urls
, opts
.batchfile
, opts
.verbose
)
671 set_compat_opts(opts
)
673 warnings
, deprecation_warnings
= validate_options(opts
)
674 except ValueError as err
:
675 parser
.error(f
'{err}\n')
677 postprocessors
= list(get_postprocessors(opts
))
679 print_only
= bool(opts
.forceprint
) and all(k
not in opts
.forceprint
for k
in POSTPROCESS_WHEN
[2:])
680 any_getting
= any(getattr(opts
, k
) for k
in (
681 'dumpjson', 'dump_single_json', 'getdescription', 'getduration', 'getfilename',
682 'getformat', 'getid', 'getthumbnail', 'gettitle', 'geturl'
686 opts
.recodevideo
if opts
.recodevideo
in FFmpegVideoConvertorPP
.SUPPORTED_EXTS
687 else opts
.remuxvideo
if opts
.remuxvideo
in FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
688 else opts
.audioformat
if (opts
.extractaudio
and opts
.audioformat
in FFmpegExtractAudioPP
.SUPPORTED_EXTS
)
691 return parser
, opts
, urls
, {
692 'usenetrc': opts
.usenetrc
,
693 'netrc_location': opts
.netrc_location
,
694 'username': opts
.username
,
695 'password': opts
.password
,
696 'twofactor': opts
.twofactor
,
697 'videopassword': opts
.videopassword
,
698 'ap_mso': opts
.ap_mso
,
699 'ap_username': opts
.ap_username
,
700 'ap_password': opts
.ap_password
,
701 'client_certificate': opts
.client_certificate
,
702 'client_certificate_key': opts
.client_certificate_key
,
703 'client_certificate_password': opts
.client_certificate_password
,
704 'quiet': opts
.quiet
or any_getting
or opts
.print_json
or bool(opts
.forceprint
),
705 'no_warnings': opts
.no_warnings
,
706 'forceurl': opts
.geturl
,
707 'forcetitle': opts
.gettitle
,
708 'forceid': opts
.getid
,
709 'forcethumbnail': opts
.getthumbnail
,
710 'forcedescription': opts
.getdescription
,
711 'forceduration': opts
.getduration
,
712 'forcefilename': opts
.getfilename
,
713 'forceformat': opts
.getformat
,
714 'forceprint': opts
.forceprint
,
715 'print_to_file': opts
.print_to_file
,
716 'forcejson': opts
.dumpjson
or opts
.print_json
,
717 'dump_single_json': opts
.dump_single_json
,
718 'force_write_download_archive': opts
.force_write_download_archive
,
719 'simulate': (print_only
or any_getting
or None) if opts
.simulate
is None else opts
.simulate
,
720 'skip_download': opts
.skip_download
,
721 'format': opts
.format
,
722 'allow_unplayable_formats': opts
.allow_unplayable_formats
,
723 'ignore_no_formats_error': opts
.ignore_no_formats_error
,
724 'format_sort': opts
.format_sort
,
725 'format_sort_force': opts
.format_sort_force
,
726 'allow_multiple_video_streams': opts
.allow_multiple_video_streams
,
727 'allow_multiple_audio_streams': opts
.allow_multiple_audio_streams
,
728 'check_formats': opts
.check_formats
,
729 'listformats': opts
.listformats
,
730 'listformats_table': opts
.listformats_table
,
731 'outtmpl': opts
.outtmpl
,
732 'outtmpl_na_placeholder': opts
.outtmpl_na_placeholder
,
734 'autonumber_size': opts
.autonumber_size
,
735 'autonumber_start': opts
.autonumber_start
,
736 'restrictfilenames': opts
.restrictfilenames
,
737 'windowsfilenames': opts
.windowsfilenames
,
738 'ignoreerrors': opts
.ignoreerrors
,
739 'force_generic_extractor': opts
.force_generic_extractor
,
740 'ratelimit': opts
.ratelimit
,
741 'throttledratelimit': opts
.throttledratelimit
,
742 'overwrites': opts
.overwrites
,
743 'retries': opts
.retries
,
744 'file_access_retries': opts
.file_access_retries
,
745 'fragment_retries': opts
.fragment_retries
,
746 'extractor_retries': opts
.extractor_retries
,
747 'retry_sleep_functions': opts
.retry_sleep
,
748 'skip_unavailable_fragments': opts
.skip_unavailable_fragments
,
749 'keep_fragments': opts
.keep_fragments
,
750 'concurrent_fragment_downloads': opts
.concurrent_fragment_downloads
,
751 'buffersize': opts
.buffersize
,
752 'noresizebuffer': opts
.noresizebuffer
,
753 'http_chunk_size': opts
.http_chunk_size
,
754 'continuedl': opts
.continue_dl
,
755 'noprogress': opts
.quiet
if opts
.noprogress
is None else opts
.noprogress
,
756 'progress_with_newline': opts
.progress_with_newline
,
757 'progress_template': opts
.progress_template
,
758 'playliststart': opts
.playliststart
,
759 'playlistend': opts
.playlistend
,
760 'playlistreverse': opts
.playlist_reverse
,
761 'playlistrandom': opts
.playlist_random
,
762 'lazy_playlist': opts
.lazy_playlist
,
763 'noplaylist': opts
.noplaylist
,
764 'logtostderr': opts
.outtmpl
.get('default') == '-',
765 'consoletitle': opts
.consoletitle
,
766 'nopart': opts
.nopart
,
767 'updatetime': opts
.updatetime
,
768 'writedescription': opts
.writedescription
,
769 'writeannotations': opts
.writeannotations
,
770 'writeinfojson': opts
.writeinfojson
,
771 'allow_playlist_files': opts
.allow_playlist_files
,
772 'clean_infojson': opts
.clean_infojson
,
773 'getcomments': opts
.getcomments
,
774 'writethumbnail': opts
.writethumbnail
is True,
775 'write_all_thumbnails': opts
.writethumbnail
== 'all',
776 'writelink': opts
.writelink
,
777 'writeurllink': opts
.writeurllink
,
778 'writewebloclink': opts
.writewebloclink
,
779 'writedesktoplink': opts
.writedesktoplink
,
780 'writesubtitles': opts
.writesubtitles
,
781 'writeautomaticsub': opts
.writeautomaticsub
,
782 'allsubtitles': opts
.allsubtitles
,
783 'listsubtitles': opts
.listsubtitles
,
784 'subtitlesformat': opts
.subtitlesformat
,
785 'subtitleslangs': opts
.subtitleslangs
,
786 'matchtitle': decodeOption(opts
.matchtitle
),
787 'rejecttitle': decodeOption(opts
.rejecttitle
),
788 'max_downloads': opts
.max_downloads
,
789 'prefer_free_formats': opts
.prefer_free_formats
,
790 'trim_file_name': opts
.trim_file_name
,
791 'verbose': opts
.verbose
,
792 'dump_intermediate_pages': opts
.dump_intermediate_pages
,
793 'write_pages': opts
.write_pages
,
794 'load_pages': opts
.load_pages
,
796 'keepvideo': opts
.keepvideo
,
797 'min_filesize': opts
.min_filesize
,
798 'max_filesize': opts
.max_filesize
,
799 'min_views': opts
.min_views
,
800 'max_views': opts
.max_views
,
801 'daterange': opts
.date
,
802 'cachedir': opts
.cachedir
,
803 'youtube_print_sig_code': opts
.youtube_print_sig_code
,
804 'age_limit': opts
.age_limit
,
805 'download_archive': opts
.download_archive
,
806 'break_on_existing': opts
.break_on_existing
,
807 'break_on_reject': opts
.break_on_reject
,
808 'break_per_url': opts
.break_per_url
,
809 'skip_playlist_after_errors': opts
.skip_playlist_after_errors
,
810 'cookiefile': opts
.cookiefile
,
811 'cookiesfrombrowser': opts
.cookiesfrombrowser
,
812 'legacyserverconnect': opts
.legacy_server_connect
,
813 'nocheckcertificate': opts
.no_check_certificate
,
814 'prefer_insecure': opts
.prefer_insecure
,
815 'http_headers': opts
.headers
,
817 'socket_timeout': opts
.socket_timeout
,
818 'bidi_workaround': opts
.bidi_workaround
,
819 'debug_printtraffic': opts
.debug_printtraffic
,
820 'prefer_ffmpeg': opts
.prefer_ffmpeg
,
821 'include_ads': opts
.include_ads
,
822 'default_search': opts
.default_search
,
823 'dynamic_mpd': opts
.dynamic_mpd
,
824 'extractor_args': opts
.extractor_args
,
825 'youtube_include_dash_manifest': opts
.youtube_include_dash_manifest
,
826 'youtube_include_hls_manifest': opts
.youtube_include_hls_manifest
,
827 'encoding': opts
.encoding
,
828 'extract_flat': opts
.extract_flat
,
829 'live_from_start': opts
.live_from_start
,
830 'wait_for_video': opts
.wait_for_video
,
831 'mark_watched': opts
.mark_watched
,
832 'merge_output_format': opts
.merge_output_format
,
833 'final_ext': final_ext
,
834 'postprocessors': postprocessors
,
836 'source_address': opts
.source_address
,
837 'call_home': opts
.call_home
,
838 'sleep_interval_requests': opts
.sleep_interval_requests
,
839 'sleep_interval': opts
.sleep_interval
,
840 'max_sleep_interval': opts
.max_sleep_interval
,
841 'sleep_interval_subtitles': opts
.sleep_interval_subtitles
,
842 'external_downloader': opts
.external_downloader
,
843 'download_ranges': opts
.download_ranges
,
844 'force_keyframes_at_cuts': opts
.force_keyframes_at_cuts
,
845 'list_thumbnails': opts
.list_thumbnails
,
846 'playlist_items': opts
.playlist_items
,
847 'xattr_set_filesize': opts
.xattr_set_filesize
,
848 'match_filter': opts
.match_filter
,
849 'no_color': opts
.no_color
,
850 'ffmpeg_location': opts
.ffmpeg_location
,
851 'hls_prefer_native': opts
.hls_prefer_native
,
852 'hls_use_mpegts': opts
.hls_use_mpegts
,
853 'hls_split_discontinuity': opts
.hls_split_discontinuity
,
854 'external_downloader_args': opts
.external_downloader_args
,
855 'postprocessor_args': opts
.postprocessor_args
,
856 'cn_verification_proxy': opts
.cn_verification_proxy
,
857 'geo_verification_proxy': opts
.geo_verification_proxy
,
858 'geo_bypass': opts
.geo_bypass
,
859 'geo_bypass_country': opts
.geo_bypass_country
,
860 'geo_bypass_ip_block': opts
.geo_bypass_ip_block
,
861 '_warnings': warnings
,
862 '_deprecation_warnings': deprecation_warnings
,
863 'compat_opts': opts
.compat_opts
,
867 def _real_main(argv
=None):
868 setproctitle('yt-dlp')
870 parser
, opts
, all_urls
, ydl_opts
= parse_options(argv
)
873 if opts
.dump_user_agent
:
874 ua
= traverse_obj(opts
.headers
, 'User-Agent', casesense
=False, default
=std_headers
['User-Agent'])
875 write_string(f
'{ua}\n', out
=sys
.stdout
)
878 if print_extractor_information(opts
, all_urls
):
881 with YoutubeDL(ydl_opts
) as ydl
:
882 pre_process
= opts
.update_self
or opts
.rm_cachedir
883 actual_use
= all_urls
or opts
.load_info_filename
888 updater
= Updater(ydl
)
889 if opts
.update_self
and updater
.update() and actual_use
:
891 return updater
.restart()
892 # This code is reachable only for zip variant in py < 3.10
893 # It makes sense to exit here, but the old behavior is to continue
894 ydl
.report_warning('Restart yt-dlp to use the updated version')
895 # return 100, 'ERROR: The program must exit for the update to complete'
899 return ydl
._download
_retcode
901 ydl
.warn_if_short_id(sys
.argv
[1:] if argv
is None else argv
)
903 'You must provide at least one URL.\n'
904 'Type yt-dlp --help to see a list of all options.')
908 if opts
.load_info_filename
is not None:
909 return ydl
.download_with_info_file(expand_path(opts
.load_info_filename
))
911 return ydl
.download(all_urls
)
912 except DownloadCancelled
:
913 ydl
.to_screen('Aborting remaining downloads')
919 _exit(*variadic(_real_main(argv
)))
920 except DownloadError
:
922 except SameFileError
as e
:
924 except KeyboardInterrupt:
925 _exit('\nERROR: Interrupted by user')
926 except BrokenPipeError
as e
:
927 # https://docs.python.org/3/library/signal.html#note-on-sigpipe
928 devnull
= os
.open(os
.devnull
, os
.O_WRONLY
)
929 os
.dup2(devnull
, sys
.stdout
.fileno())
930 _exit(f
'\nERROR: {e}')
931 except optparse
.OptParseError
as e
:
935 from .extractor
import gen_extractors
, list_extractors