yt_dlp/__init__.py

   1 #!/usr/bin/env python3
   2 # coding: utf-8
   3
   4 f'You are using an unsupported version of Python. Only Python versions 3.6 and above are supported by yt-dlp'  # noqa: F541
   5
   6 __license__ = 'Public Domain'
   7
   8 import codecs
   9 import io
  10 import itertools
  11 import os
  12 import random
  13 import re
  14 import sys
  15
  16 from .options import (
  17     parseOpts,
  18 )
  19 from .compat import (
  20     compat_getpass,
  21     compat_shlex_quote,
  22     workaround_optparse_bug9161,
  23 )
  24 from .cookies import SUPPORTED_BROWSERS
  25 from .utils import (
  26     DateRange,
  27     decodeOption,
  28     DownloadError,
  29     error_to_compat_str,
  30     ExistingVideoReached,
  31     expand_path,
  32     match_filter_func,
  33     MaxDownloadsReached,
  34     parse_duration,
  35     preferredencoding,
  36     read_batch_urls,
  37     RejectedVideoReached,
  38     render_table,
  39     SameFileError,
  40     setproctitle,
  41     std_headers,
  42     write_string,
  43 )
  44 from .update import run_update
  45 from .downloader import (
  46     FileDownloader,
  47 )
  48 from .extractor import gen_extractors, list_extractors
  49 from .extractor.common import InfoExtractor
  50 from .extractor.adobepass import MSO_INFO
  51 from .postprocessor import (
  52     FFmpegExtractAudioPP,
  53     FFmpegSubtitlesConvertorPP,
  54     FFmpegThumbnailsConvertorPP,
  55     FFmpegVideoConvertorPP,
  56     FFmpegVideoRemuxerPP,
  57     MetadataFromFieldPP,
  58     MetadataParserPP,
  59 )
  60 from .YoutubeDL import YoutubeDL
  61
  62
  63 def _real_main(argv=None):
  64     # Compatibility fixes for Windows
  65     if sys.platform == 'win32':
  66         # https://github.com/ytdl-org/youtube-dl/issues/820
  67         codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
  68
  69     workaround_optparse_bug9161()
  70
  71     setproctitle('yt-dlp')
  72
  73     parser, opts, args = parseOpts(argv)
  74     warnings = []
  75
  76     # Set user agent
  77     if opts.user_agent is not None:
  78         std_headers['User-Agent'] = opts.user_agent
  79
  80     # Set referer
  81     if opts.referer is not None:
  82         std_headers['Referer'] = opts.referer
  83
  84     # Custom HTTP headers
  85     std_headers.update(opts.headers)
  86
  87     # Dump user agent
  88     if opts.dump_user_agent:
  89         write_string(std_headers['User-Agent'] + '\n', out=sys.stdout)
  90         sys.exit(0)
  91
  92     # Batch file verification
  93     batch_urls = []
  94     if opts.batchfile is not None:
  95         try:
  96             if opts.batchfile == '-':
  97                 batchfd = sys.stdin
  98             else:
  99                 batchfd = io.open(
 100                     expand_path(opts.batchfile),
 101                     'r', encoding='utf-8', errors='ignore')
 102             batch_urls = read_batch_urls(batchfd)
 103             if opts.verbose:
 104                 write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n')
 105         except IOError:
 106             sys.exit('ERROR: batch file %s could not be read' % opts.batchfile)
 107     all_urls = batch_urls + [url.strip() for url in args]  # batch_urls are already striped in read_batch_urls
 108     _enc = preferredencoding()
 109     all_urls = [url.decode(_enc, 'ignore') if isinstance(url, bytes) else url for url in all_urls]
 110
 111     if opts.list_extractors:
 112         for ie in list_extractors(opts.age_limit):
 113             write_string(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie.working() else '') + '\n', out=sys.stdout)
 114             matchedUrls = [url for url in all_urls if ie.suitable(url)]
 115             for mu in matchedUrls:
 116                 write_string('  ' + mu + '\n', out=sys.stdout)
 117         sys.exit(0)
 118     if opts.list_extractor_descriptions:
 119         for ie in list_extractors(opts.age_limit):
 120             if not ie.working():
 121                 continue
 122             desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
 123             if desc is False:
 124                 continue
 125             if getattr(ie, 'SEARCH_KEY', None) is not None:
 126                 _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
 127                 _COUNTS = ('', '5', '10', 'all')
 128                 desc += f'; "{ie.SEARCH_KEY}:" prefix (Example: "{ie.SEARCH_KEY}{random.choice(_COUNTS)}:{random.choice(_SEARCHES)}")'
 129             write_string(desc + '\n', out=sys.stdout)
 130         sys.exit(0)
 131     if opts.ap_list_mso:
 132         table = [[mso_id, mso_info['name']] for mso_id, mso_info in MSO_INFO.items()]
 133         write_string('Supported TV Providers:\n' + render_table(['mso', 'mso name'], table) + '\n', out=sys.stdout)
 134         sys.exit(0)
 135
 136     # Conflicting, missing and erroneous options
 137     if opts.usenetrc and (opts.username is not None or opts.password is not None):
 138         parser.error('using .netrc conflicts with giving username/password')
 139     if opts.password is not None and opts.username is None:
 140         parser.error('account username missing\n')
 141     if opts.ap_password is not None and opts.ap_username is None:
 142         parser.error('TV Provider account username missing\n')
 143     if opts.autonumber_size is not None:
 144         if opts.autonumber_size <= 0:
 145             parser.error('auto number size must be positive')
 146     if opts.autonumber_start is not None:
 147         if opts.autonumber_start < 0:
 148             parser.error('auto number start must be positive or 0')
 149     if opts.username is not None and opts.password is None:
 150         opts.password = compat_getpass('Type account password and press [Return]: ')
 151     if opts.ap_username is not None and opts.ap_password is None:
 152         opts.ap_password = compat_getpass('Type TV provider account password and press [Return]: ')
 153     if opts.ratelimit is not None:
 154         numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
 155         if numeric_limit is None:
 156             parser.error('invalid rate limit specified')
 157         opts.ratelimit = numeric_limit
 158     if opts.throttledratelimit is not None:
 159         numeric_limit = FileDownloader.parse_bytes(opts.throttledratelimit)
 160         if numeric_limit is None:
 161             parser.error('invalid rate limit specified')
 162         opts.throttledratelimit = numeric_limit
 163     if opts.min_filesize is not None:
 164         numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
 165         if numeric_limit is None:
 166             parser.error('invalid min_filesize specified')
 167         opts.min_filesize = numeric_limit
 168     if opts.max_filesize is not None:
 169         numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
 170         if numeric_limit is None:
 171             parser.error('invalid max_filesize specified')
 172         opts.max_filesize = numeric_limit
 173     if opts.sleep_interval is not None:
 174         if opts.sleep_interval < 0:
 175             parser.error('sleep interval must be positive or 0')
 176     if opts.max_sleep_interval is not None:
 177         if opts.max_sleep_interval < 0:
 178             parser.error('max sleep interval must be positive or 0')
 179         if opts.sleep_interval is None:
 180             parser.error('min sleep interval must be specified, use --min-sleep-interval')
 181         if opts.max_sleep_interval < opts.sleep_interval:
 182             parser.error('max sleep interval must be greater than or equal to min sleep interval')
 183     else:
 184         opts.max_sleep_interval = opts.sleep_interval
 185     if opts.sleep_interval_subtitles is not None:
 186         if opts.sleep_interval_subtitles < 0:
 187             parser.error('subtitles sleep interval must be positive or 0')
 188     if opts.sleep_interval_requests is not None:
 189         if opts.sleep_interval_requests < 0:
 190             parser.error('requests sleep interval must be positive or 0')
 191     if opts.ap_mso and opts.ap_mso not in MSO_INFO:
 192         parser.error('Unsupported TV Provider, use --ap-list-mso to get a list of supported TV Providers')
 193     if opts.overwrites:  # --yes-overwrites implies --no-continue
 194         opts.continue_dl = False
 195     if opts.concurrent_fragment_downloads <= 0:
 196         raise ValueError('Concurrent fragments must be positive')
 197
 198     def parse_retries(retries, name=''):
 199         if retries in ('inf', 'infinite'):
 200             parsed_retries = float('inf')
 201         else:
 202             try:
 203                 parsed_retries = int(retries)
 204             except (TypeError, ValueError):
 205                 parser.error('invalid %sretry count specified' % name)
 206         return parsed_retries
 207     if opts.retries is not None:
 208         opts.retries = parse_retries(opts.retries)
 209     if opts.fragment_retries is not None:
 210         opts.fragment_retries = parse_retries(opts.fragment_retries, 'fragment ')
 211     if opts.extractor_retries is not None:
 212         opts.extractor_retries = parse_retries(opts.extractor_retries, 'extractor ')
 213     if opts.buffersize is not None:
 214         numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
 215         if numeric_buffersize is None:
 216             parser.error('invalid buffer size specified')
 217         opts.buffersize = numeric_buffersize
 218     if opts.http_chunk_size is not None:
 219         numeric_chunksize = FileDownloader.parse_bytes(opts.http_chunk_size)
 220         if not numeric_chunksize:
 221             parser.error('invalid http chunk size specified')
 222         opts.http_chunk_size = numeric_chunksize
 223     if opts.playliststart <= 0:
 224         raise ValueError('Playlist start must be positive')
 225     if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart:
 226         raise ValueError('Playlist end must be greater than playlist start')
 227     if opts.extractaudio:
 228         if opts.audioformat not in ['best'] + list(FFmpegExtractAudioPP.SUPPORTED_EXTS):
 229             parser.error('invalid audio format specified')
 230     if opts.audioquality:
 231         opts.audioquality = opts.audioquality.strip('k').strip('K')
 232         if not opts.audioquality.isdigit():
 233             parser.error('invalid audio quality specified')
 234     if opts.recodevideo is not None:
 235         opts.recodevideo = opts.recodevideo.replace(' ', '')
 236         if not re.match(FFmpegVideoConvertorPP.FORMAT_RE, opts.recodevideo):
 237             parser.error('invalid video remux format specified')
 238     if opts.remuxvideo is not None:
 239         opts.remuxvideo = opts.remuxvideo.replace(' ', '')
 240         if not re.match(FFmpegVideoRemuxerPP.FORMAT_RE, opts.remuxvideo):
 241             parser.error('invalid video remux format specified')
 242     if opts.convertsubtitles is not None:
 243         if opts.convertsubtitles not in FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS:
 244             parser.error('invalid subtitle format specified')
 245     if opts.convertthumbnails is not None:
 246         if opts.convertthumbnails not in FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS:
 247             parser.error('invalid thumbnail format specified')
 248
 249     if opts.cookiesfrombrowser is not None:
 250         opts.cookiesfrombrowser = [
 251             part.strip() or None for part in opts.cookiesfrombrowser.split(':', 1)]
 252         if opts.cookiesfrombrowser[0].lower() not in SUPPORTED_BROWSERS:
 253             parser.error('unsupported browser specified for cookies')
 254
 255     if opts.date is not None:
 256         date = DateRange.day(opts.date)
 257     else:
 258         date = DateRange(opts.dateafter, opts.datebefore)
 259
 260     compat_opts = opts.compat_opts
 261
 262     def report_conflict(arg1, arg2):
 263         warnings.append(f'{arg2} is ignored since {arg1} was given')
 264
 265     def _unused_compat_opt(name):
 266         if name not in compat_opts:
 267             return False
 268         compat_opts.discard(name)
 269         compat_opts.update(['*%s' % name])
 270         return True
 271
 272     def set_default_compat(compat_name, opt_name, default=True, remove_compat=True):
 273         attr = getattr(opts, opt_name)
 274         if compat_name in compat_opts:
 275             if attr is None:
 276                 setattr(opts, opt_name, not default)
 277                 return True
 278             else:
 279                 if remove_compat:
 280                     _unused_compat_opt(compat_name)
 281                 return False
 282         elif attr is None:
 283             setattr(opts, opt_name, default)
 284         return None
 285
 286     set_default_compat('abort-on-error', 'ignoreerrors', 'only_download')
 287     set_default_compat('no-playlist-metafiles', 'allow_playlist_files')
 288     set_default_compat('no-clean-infojson', 'clean_infojson')
 289     if 'format-sort' in compat_opts:
 290         opts.format_sort.extend(InfoExtractor.FormatSort.ytdl_default)
 291     _video_multistreams_set = set_default_compat('multistreams', 'allow_multiple_video_streams', False, remove_compat=False)
 292     _audio_multistreams_set = set_default_compat('multistreams', 'allow_multiple_audio_streams', False, remove_compat=False)
 293     if _video_multistreams_set is False and _audio_multistreams_set is False:
 294         _unused_compat_opt('multistreams')
 295     outtmpl_default = opts.outtmpl.get('default')
 296     if opts.useid:
 297         if outtmpl_default is None:
 298             outtmpl_default = opts.outtmpl['default'] = '%(id)s.%(ext)s'
 299         else:
 300             report_conflict('--output', '--id')
 301     if 'filename' in compat_opts:
 302         if outtmpl_default is None:
 303             outtmpl_default = opts.outtmpl['default'] = '%(title)s-%(id)s.%(ext)s'
 304         else:
 305             _unused_compat_opt('filename')
 306
 307     def validate_outtmpl(tmpl, msg):
 308         err = YoutubeDL.validate_outtmpl(tmpl)
 309         if err:
 310             parser.error('invalid %s %r: %s' % (msg, tmpl, error_to_compat_str(err)))
 311
 312     for k, tmpl in opts.outtmpl.items():
 313         validate_outtmpl(tmpl, f'{k} output template')
 314     opts.forceprint = opts.forceprint or []
 315     for tmpl in opts.forceprint or []:
 316         validate_outtmpl(tmpl, 'print template')
 317     validate_outtmpl(opts.sponsorblock_chapter_title, 'SponsorBlock chapter title')
 318     for k, tmpl in opts.progress_template.items():
 319         k = f'{k[:-6]} console title' if '-title' in k else f'{k} progress'
 320         validate_outtmpl(tmpl, f'{k} template')
 321
 322     if opts.extractaudio and not opts.keepvideo and opts.format is None:
 323         opts.format = 'bestaudio/best'
 324
 325     if outtmpl_default is not None and not os.path.splitext(outtmpl_default)[1] and opts.extractaudio:
 326         parser.error('Cannot download a video and extract audio into the same'
 327                      ' file! Use "{0}.%(ext)s" instead of "{0}" as the output'
 328                      ' template'.format(outtmpl_default))
 329
 330     for f in opts.format_sort:
 331         if re.match(InfoExtractor.FormatSort.regex, f) is None:
 332             parser.error('invalid format sort string "%s" specified' % f)
 333
 334     def metadataparser_actions(f):
 335         if isinstance(f, str):
 336             cmd = '--parse-metadata %s' % compat_shlex_quote(f)
 337             try:
 338                 actions = [MetadataFromFieldPP.to_action(f)]
 339             except Exception as err:
 340                 parser.error(f'{cmd} is invalid; {err}')
 341         else:
 342             cmd = '--replace-in-metadata %s' % ' '.join(map(compat_shlex_quote, f))
 343             actions = ((MetadataParserPP.Actions.REPLACE, x, *f[1:]) for x in f[0].split(','))
 344
 345         for action in actions:
 346             try:
 347                 MetadataParserPP.validate_action(*action)
 348             except Exception as err:
 349                 parser.error(f'{cmd} is invalid; {err}')
 350             yield action
 351
 352     if opts.parse_metadata is None:
 353         opts.parse_metadata = []
 354     if opts.metafromtitle is not None:
 355         opts.parse_metadata.append('title:%s' % opts.metafromtitle)
 356     opts.parse_metadata = list(itertools.chain(*map(metadataparser_actions, opts.parse_metadata)))
 357
 358     any_getting = opts.forceprint or opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.getduration or opts.dumpjson or opts.dump_single_json
 359     any_printing = opts.print_json
 360     download_archive_fn = expand_path(opts.download_archive) if opts.download_archive is not None else opts.download_archive
 361
 362     # If JSON is not printed anywhere, but comments are requested, save it to file
 363     printing_json = opts.dumpjson or opts.print_json or opts.dump_single_json
 364     if opts.getcomments and not printing_json:
 365         opts.writeinfojson = True
 366
 367     if opts.no_sponsorblock:
 368         opts.sponsorblock_mark = set()
 369         opts.sponsorblock_remove = set()
 370     sponsorblock_query = opts.sponsorblock_mark | opts.sponsorblock_remove
 371
 372     if (opts.addmetadata or opts.sponsorblock_mark) and opts.addchapters is None:
 373         opts.addchapters = True
 374     opts.remove_chapters = opts.remove_chapters or []
 375
 376     if (opts.remove_chapters or sponsorblock_query) and opts.sponskrub is not False:
 377         if opts.sponskrub:
 378             if opts.remove_chapters:
 379                 report_conflict('--remove-chapters', '--sponskrub')
 380             if opts.sponsorblock_mark:
 381                 report_conflict('--sponsorblock-mark', '--sponskrub')
 382             if opts.sponsorblock_remove:
 383                 report_conflict('--sponsorblock-remove', '--sponskrub')
 384         opts.sponskrub = False
 385     if opts.sponskrub_cut and opts.split_chapters and opts.sponskrub is not False:
 386         report_conflict('--split-chapter', '--sponskrub-cut')
 387         opts.sponskrub_cut = False
 388
 389     if opts.remuxvideo and opts.recodevideo:
 390         report_conflict('--recode-video', '--remux-video')
 391         opts.remuxvideo = False
 392
 393     if opts.allow_unplayable_formats:
 394         if opts.extractaudio:
 395             report_conflict('--allow-unplayable-formats', '--extract-audio')
 396             opts.extractaudio = False
 397         if opts.remuxvideo:
 398             report_conflict('--allow-unplayable-formats', '--remux-video')
 399             opts.remuxvideo = False
 400         if opts.recodevideo:
 401             report_conflict('--allow-unplayable-formats', '--recode-video')
 402             opts.recodevideo = False
 403         if opts.addmetadata:
 404             report_conflict('--allow-unplayable-formats', '--add-metadata')
 405             opts.addmetadata = False
 406         if opts.embedsubtitles:
 407             report_conflict('--allow-unplayable-formats', '--embed-subs')
 408             opts.embedsubtitles = False
 409         if opts.embedthumbnail:
 410             report_conflict('--allow-unplayable-formats', '--embed-thumbnail')
 411             opts.embedthumbnail = False
 412         if opts.xattrs:
 413             report_conflict('--allow-unplayable-formats', '--xattrs')
 414             opts.xattrs = False
 415         if opts.fixup and opts.fixup.lower() not in ('never', 'ignore'):
 416             report_conflict('--allow-unplayable-formats', '--fixup')
 417         opts.fixup = 'never'
 418         if opts.remove_chapters:
 419             report_conflict('--allow-unplayable-formats', '--remove-chapters')
 420             opts.remove_chapters = []
 421         if opts.sponsorblock_remove:
 422             report_conflict('--allow-unplayable-formats', '--sponsorblock-remove')
 423             opts.sponsorblock_remove = set()
 424         if opts.sponskrub:
 425             report_conflict('--allow-unplayable-formats', '--sponskrub')
 426         opts.sponskrub = False
 427
 428     # PostProcessors
 429     postprocessors = list(opts.add_postprocessors)
 430     if sponsorblock_query:
 431         postprocessors.append({
 432             'key': 'SponsorBlock',
 433             'categories': sponsorblock_query,
 434             'api': opts.sponsorblock_api,
 435             # Run this immediately after extraction is complete
 436             'when': 'pre_process'
 437         })
 438     if opts.parse_metadata:
 439         postprocessors.append({
 440             'key': 'MetadataParser',
 441             'actions': opts.parse_metadata,
 442             # Run this immediately after extraction is complete
 443             'when': 'pre_process'
 444         })
 445     if opts.convertsubtitles:
 446         postprocessors.append({
 447             'key': 'FFmpegSubtitlesConvertor',
 448             'format': opts.convertsubtitles,
 449             # Run this before the actual video download
 450             'when': 'before_dl'
 451         })
 452     if opts.convertthumbnails:
 453         postprocessors.append({
 454             'key': 'FFmpegThumbnailsConvertor',
 455             'format': opts.convertthumbnails,
 456             # Run this before the actual video download
 457             'when': 'before_dl'
 458         })
 459     # Must be after all other before_dl
 460     if opts.exec_before_dl_cmd:
 461         postprocessors.append({
 462             'key': 'Exec',
 463             'exec_cmd': opts.exec_before_dl_cmd,
 464             'when': 'before_dl'
 465         })
 466     if opts.extractaudio:
 467         postprocessors.append({
 468             'key': 'FFmpegExtractAudio',
 469             'preferredcodec': opts.audioformat,
 470             'preferredquality': opts.audioquality,
 471             'nopostoverwrites': opts.nopostoverwrites,
 472         })
 473     if opts.remuxvideo:
 474         postprocessors.append({
 475             'key': 'FFmpegVideoRemuxer',
 476             'preferedformat': opts.remuxvideo,
 477         })
 478     if opts.recodevideo:
 479         postprocessors.append({
 480             'key': 'FFmpegVideoConvertor',
 481             'preferedformat': opts.recodevideo,
 482         })
 483     # If ModifyChapters is going to remove chapters, subtitles must already be in the container.
 484     if opts.embedsubtitles:
 485         already_have_subtitle = opts.writesubtitles and 'no-keep-subs' not in compat_opts
 486         postprocessors.append({
 487             'key': 'FFmpegEmbedSubtitle',
 488             # already_have_subtitle = True prevents the file from being deleted after embedding
 489             'already_have_subtitle': already_have_subtitle
 490         })
 491         if not opts.writeautomaticsub and 'no-keep-subs' not in compat_opts:
 492             opts.writesubtitles = True
 493     # --all-sub automatically sets --write-sub if --write-auto-sub is not given
 494     # this was the old behaviour if only --all-sub was given.
 495     if opts.allsubtitles and not opts.writeautomaticsub:
 496         opts.writesubtitles = True
 497     # ModifyChapters must run before FFmpegMetadataPP
 498     remove_chapters_patterns, remove_ranges = [], []
 499     for regex in opts.remove_chapters:
 500         if regex.startswith('*'):
 501             dur = list(map(parse_duration, regex[1:].split('-')))
 502             if len(dur) == 2 and all(t is not None for t in dur):
 503                 remove_ranges.append(tuple(dur))
 504                 continue
 505             parser.error(f'invalid --remove-chapters time range {regex!r}. Must be of the form ?start-end')
 506         try:
 507             remove_chapters_patterns.append(re.compile(regex))
 508         except re.error as err:
 509             parser.error(f'invalid --remove-chapters regex {regex!r} - {err}')
 510     if opts.remove_chapters or sponsorblock_query:
 511         postprocessors.append({
 512             'key': 'ModifyChapters',
 513             'remove_chapters_patterns': remove_chapters_patterns,
 514             'remove_sponsor_segments': opts.sponsorblock_remove,
 515             'remove_ranges': remove_ranges,
 516             'sponsorblock_chapter_title': opts.sponsorblock_chapter_title,
 517             'force_keyframes': opts.force_keyframes_at_cuts
 518         })
 519     # FFmpegMetadataPP should be run after FFmpegVideoConvertorPP and
 520     # FFmpegExtractAudioPP as containers before conversion may not support
 521     # metadata (3gp, webm, etc.)
 522     # By default ffmpeg preserves metadata applicable for both
 523     # source and target containers. From this point the container won't change,
 524     # so metadata can be added here.
 525     if opts.addmetadata or opts.addchapters:
 526         postprocessors.append({
 527             'key': 'FFmpegMetadata',
 528             'add_chapters': opts.addchapters,
 529             'add_metadata': opts.addmetadata,
 530         })
 531     # Note: Deprecated
 532     # This should be above EmbedThumbnail since sponskrub removes the thumbnail attachment
 533     # but must be below EmbedSubtitle and FFmpegMetadata
 534     # See https://github.com/yt-dlp/yt-dlp/issues/204 , https://github.com/faissaloo/SponSkrub/issues/29
 535     # If opts.sponskrub is None, sponskrub is used, but it silently fails if the executable can't be found
 536     if opts.sponskrub is not False:
 537         postprocessors.append({
 538             'key': 'SponSkrub',
 539             'path': opts.sponskrub_path,
 540             'args': opts.sponskrub_args,
 541             'cut': opts.sponskrub_cut,
 542             'force': opts.sponskrub_force,
 543             'ignoreerror': opts.sponskrub is None,
 544         })
 545     if opts.embedthumbnail:
 546         already_have_thumbnail = opts.writethumbnail or opts.write_all_thumbnails
 547         postprocessors.append({
 548             'key': 'EmbedThumbnail',
 549             # already_have_thumbnail = True prevents the file from being deleted after embedding
 550             'already_have_thumbnail': already_have_thumbnail
 551         })
 552         if not already_have_thumbnail:
 553             opts.writethumbnail = True
 554             opts.outtmpl['pl_thumbnail'] = ''
 555     if opts.split_chapters:
 556         postprocessors.append({
 557             'key': 'FFmpegSplitChapters',
 558             'force_keyframes': opts.force_keyframes_at_cuts,
 559         })
 560     # XAttrMetadataPP should be run after post-processors that may change file contents
 561     if opts.xattrs:
 562         postprocessors.append({'key': 'XAttrMetadata'})
 563     # Exec must be the last PP
 564     if opts.exec_cmd:
 565         postprocessors.append({
 566             'key': 'Exec',
 567             'exec_cmd': opts.exec_cmd,
 568             # Run this only after the files have been moved to their final locations
 569             'when': 'after_move'
 570         })
 571
 572     def report_args_compat(arg, name):
 573         warnings.append('%s given without specifying name. The arguments will be given to all %s' % (arg, name))
 574
 575     if 'default' in opts.external_downloader_args:
 576         report_args_compat('--downloader-args', 'external downloaders')
 577
 578     if 'default-compat' in opts.postprocessor_args and 'default' not in opts.postprocessor_args:
 579         report_args_compat('--post-processor-args', 'post-processors')
 580         opts.postprocessor_args.setdefault('sponskrub', [])
 581         opts.postprocessor_args['default'] = opts.postprocessor_args['default-compat']
 582
 583     final_ext = (
 584         opts.recodevideo if opts.recodevideo in FFmpegVideoConvertorPP.SUPPORTED_EXTS
 585         else opts.remuxvideo if opts.remuxvideo in FFmpegVideoRemuxerPP.SUPPORTED_EXTS
 586         else opts.audioformat if (opts.extractaudio and opts.audioformat != 'best')
 587         else None)
 588
 589     match_filter = (
 590         None if opts.match_filter is None
 591         else match_filter_func(opts.match_filter))
 592
 593     ydl_opts = {
 594         'usenetrc': opts.usenetrc,
 595         'netrc_location': opts.netrc_location,
 596         'username': opts.username,
 597         'password': opts.password,
 598         'twofactor': opts.twofactor,
 599         'videopassword': opts.videopassword,
 600         'ap_mso': opts.ap_mso,
 601         'ap_username': opts.ap_username,
 602         'ap_password': opts.ap_password,
 603         'quiet': (opts.quiet or any_getting or any_printing),
 604         'no_warnings': opts.no_warnings,
 605         'forceurl': opts.geturl,
 606         'forcetitle': opts.gettitle,
 607         'forceid': opts.getid,
 608         'forcethumbnail': opts.getthumbnail,
 609         'forcedescription': opts.getdescription,
 610         'forceduration': opts.getduration,
 611         'forcefilename': opts.getfilename,
 612         'forceformat': opts.getformat,
 613         'forceprint': opts.forceprint,
 614         'forcejson': opts.dumpjson or opts.print_json,
 615         'dump_single_json': opts.dump_single_json,
 616         'force_write_download_archive': opts.force_write_download_archive,
 617         'simulate': (any_getting or None) if opts.simulate is None else opts.simulate,
 618         'skip_download': opts.skip_download,
 619         'format': opts.format,
 620         'allow_unplayable_formats': opts.allow_unplayable_formats,
 621         'ignore_no_formats_error': opts.ignore_no_formats_error,
 622         'format_sort': opts.format_sort,
 623         'format_sort_force': opts.format_sort_force,
 624         'allow_multiple_video_streams': opts.allow_multiple_video_streams,
 625         'allow_multiple_audio_streams': opts.allow_multiple_audio_streams,
 626         'check_formats': opts.check_formats,
 627         'listformats': opts.listformats,
 628         'listformats_table': opts.listformats_table,
 629         'outtmpl': opts.outtmpl,
 630         'outtmpl_na_placeholder': opts.outtmpl_na_placeholder,
 631         'paths': opts.paths,
 632         'autonumber_size': opts.autonumber_size,
 633         'autonumber_start': opts.autonumber_start,
 634         'restrictfilenames': opts.restrictfilenames,
 635         'windowsfilenames': opts.windowsfilenames,
 636         'ignoreerrors': opts.ignoreerrors,
 637         'force_generic_extractor': opts.force_generic_extractor,
 638         'ratelimit': opts.ratelimit,
 639         'throttledratelimit': opts.throttledratelimit,
 640         'overwrites': opts.overwrites,
 641         'retries': opts.retries,
 642         'fragment_retries': opts.fragment_retries,
 643         'extractor_retries': opts.extractor_retries,
 644         'skip_unavailable_fragments': opts.skip_unavailable_fragments,
 645         'keep_fragments': opts.keep_fragments,
 646         'concurrent_fragment_downloads': opts.concurrent_fragment_downloads,
 647         'buffersize': opts.buffersize,
 648         'noresizebuffer': opts.noresizebuffer,
 649         'http_chunk_size': opts.http_chunk_size,
 650         'continuedl': opts.continue_dl,
 651         'noprogress': opts.quiet if opts.noprogress is None else opts.noprogress,
 652         'progress_with_newline': opts.progress_with_newline,
 653         'progress_template': opts.progress_template,
 654         'playliststart': opts.playliststart,
 655         'playlistend': opts.playlistend,
 656         'playlistreverse': opts.playlist_reverse,
 657         'playlistrandom': opts.playlist_random,
 658         'noplaylist': opts.noplaylist,
 659         'logtostderr': outtmpl_default == '-',
 660         'consoletitle': opts.consoletitle,
 661         'nopart': opts.nopart,
 662         'updatetime': opts.updatetime,
 663         'writedescription': opts.writedescription,
 664         'writeannotations': opts.writeannotations,
 665         'writeinfojson': opts.writeinfojson,
 666         'allow_playlist_files': opts.allow_playlist_files,
 667         'clean_infojson': opts.clean_infojson,
 668         'getcomments': opts.getcomments,
 669         'writethumbnail': opts.writethumbnail,
 670         'write_all_thumbnails': opts.write_all_thumbnails,
 671         'writelink': opts.writelink,
 672         'writeurllink': opts.writeurllink,
 673         'writewebloclink': opts.writewebloclink,
 674         'writedesktoplink': opts.writedesktoplink,
 675         'writesubtitles': opts.writesubtitles,
 676         'writeautomaticsub': opts.writeautomaticsub,
 677         'allsubtitles': opts.allsubtitles,
 678         'listsubtitles': opts.listsubtitles,
 679         'subtitlesformat': opts.subtitlesformat,
 680         'subtitleslangs': opts.subtitleslangs,
 681         'matchtitle': decodeOption(opts.matchtitle),
 682         'rejecttitle': decodeOption(opts.rejecttitle),
 683         'max_downloads': opts.max_downloads,
 684         'prefer_free_formats': opts.prefer_free_formats,
 685         'trim_file_name': opts.trim_file_name,
 686         'verbose': opts.verbose,
 687         'dump_intermediate_pages': opts.dump_intermediate_pages,
 688         'write_pages': opts.write_pages,
 689         'test': opts.test,
 690         'keepvideo': opts.keepvideo,
 691         'min_filesize': opts.min_filesize,
 692         'max_filesize': opts.max_filesize,
 693         'min_views': opts.min_views,
 694         'max_views': opts.max_views,
 695         'daterange': date,
 696         'cachedir': opts.cachedir,
 697         'youtube_print_sig_code': opts.youtube_print_sig_code,
 698         'age_limit': opts.age_limit,
 699         'download_archive': download_archive_fn,
 700         'break_on_existing': opts.break_on_existing,
 701         'break_on_reject': opts.break_on_reject,
 702         'skip_playlist_after_errors': opts.skip_playlist_after_errors,
 703         'cookiefile': opts.cookiefile,
 704         'cookiesfrombrowser': opts.cookiesfrombrowser,
 705         'nocheckcertificate': opts.no_check_certificate,
 706         'prefer_insecure': opts.prefer_insecure,
 707         'proxy': opts.proxy,
 708         'socket_timeout': opts.socket_timeout,
 709         'bidi_workaround': opts.bidi_workaround,
 710         'debug_printtraffic': opts.debug_printtraffic,
 711         'prefer_ffmpeg': opts.prefer_ffmpeg,
 712         'include_ads': opts.include_ads,
 713         'default_search': opts.default_search,
 714         'dynamic_mpd': opts.dynamic_mpd,
 715         'extractor_args': opts.extractor_args,
 716         'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
 717         'youtube_include_hls_manifest': opts.youtube_include_hls_manifest,
 718         'encoding': opts.encoding,
 719         'extract_flat': opts.extract_flat,
 720         'mark_watched': opts.mark_watched,
 721         'merge_output_format': opts.merge_output_format,
 722         'final_ext': final_ext,
 723         'postprocessors': postprocessors,
 724         'fixup': opts.fixup,
 725         'source_address': opts.source_address,
 726         'call_home': opts.call_home,
 727         'sleep_interval_requests': opts.sleep_interval_requests,
 728         'sleep_interval': opts.sleep_interval,
 729         'max_sleep_interval': opts.max_sleep_interval,
 730         'sleep_interval_subtitles': opts.sleep_interval_subtitles,
 731         'external_downloader': opts.external_downloader,
 732         'list_thumbnails': opts.list_thumbnails,
 733         'playlist_items': opts.playlist_items,
 734         'xattr_set_filesize': opts.xattr_set_filesize,
 735         'match_filter': match_filter,
 736         'no_color': opts.no_color,
 737         'ffmpeg_location': opts.ffmpeg_location,
 738         'hls_prefer_native': opts.hls_prefer_native,
 739         'hls_use_mpegts': opts.hls_use_mpegts,
 740         'hls_split_discontinuity': opts.hls_split_discontinuity,
 741         'external_downloader_args': opts.external_downloader_args,
 742         'postprocessor_args': opts.postprocessor_args,
 743         'cn_verification_proxy': opts.cn_verification_proxy,
 744         'geo_verification_proxy': opts.geo_verification_proxy,
 745         'geo_bypass': opts.geo_bypass,
 746         'geo_bypass_country': opts.geo_bypass_country,
 747         'geo_bypass_ip_block': opts.geo_bypass_ip_block,
 748         '_warnings': warnings,
 749         'compat_opts': compat_opts,
 750     }
 751
 752     with YoutubeDL(ydl_opts) as ydl:
 753         actual_use = len(all_urls) or opts.load_info_filename
 754
 755         # Remove cache dir
 756         if opts.rm_cachedir:
 757             ydl.cache.remove()
 758
 759         # Update version
 760         if opts.update_self:
 761             # If updater returns True, exit. Required for windows
 762             if run_update(ydl):
 763                 if actual_use:
 764                     sys.exit('ERROR: The program must exit for the update to complete')
 765                 sys.exit()
 766
 767         # Maybe do nothing
 768         if not actual_use:
 769             if opts.update_self or opts.rm_cachedir:
 770                 sys.exit()
 771
 772             ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv)
 773             parser.error(
 774                 'You must provide at least one URL.\n'
 775                 'Type yt-dlp --help to see a list of all options.')
 776
 777         try:
 778             if opts.load_info_filename is not None:
 779                 retcode = ydl.download_with_info_file(expand_path(opts.load_info_filename))
 780             else:
 781                 retcode = ydl.download(all_urls)
 782         except (MaxDownloadsReached, ExistingVideoReached, RejectedVideoReached):
 783             ydl.to_screen('Aborting remaining downloads')
 784             retcode = 101
 785
 786     sys.exit(retcode)
 787
 788
 789 def main(argv=None):
 790     try:
 791         _real_main(argv)
 792     except DownloadError:
 793         sys.exit(1)
 794     except SameFileError:
 795         sys.exit('ERROR: fixed output name but more than one file to download')
 796     except KeyboardInterrupt:
 797         sys.exit('\nERROR: Interrupted by user')
 798     except BrokenPipeError:
 799         # https://docs.python.org/3/library/signal.html#note-on-sigpipe
 800         devnull = os.open(os.devnull, os.O_WRONLY)
 801         os.dup2(devnull, sys.stdout.fileno())
 802         sys.exit(r'\nERROR: {err}')
 803
 804
 805 __all__ = ['main', 'YoutubeDL', 'gen_extractors', 'list_extractors']