youtube_dl/__init__.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 from __future__ import unicode_literals
   5
   6 __license__ = 'Public Domain'
   7
   8 import codecs
   9 import io
  10 import os
  11 import random
  12 import sys
  13
  14
  15 from .options import (
  16     parseOpts,
  17 )
  18 from .compat import (
  19     compat_expanduser,
  20     compat_getpass,
  21     compat_shlex_split,
  22     workaround_optparse_bug9161,
  23 )
  24 from .utils import (
  25     DateRange,
  26     decodeOption,
  27     DEFAULT_OUTTMPL,
  28     DownloadError,
  29     match_filter_func,
  30     MaxDownloadsReached,
  31     preferredencoding,
  32     read_batch_urls,
  33     SameFileError,
  34     setproctitle,
  35     std_headers,
  36     write_string,
  37     render_table,
  38 )
  39 from .update import update_self
  40 from .downloader import (
  41     FileDownloader,
  42 )
  43 from .extractor import gen_extractors, list_extractors
  44 from .extractor.adobepass import MSO_INFO
  45 from .YoutubeDL import YoutubeDL
  46
  47
  48 def _real_main(argv=None):
  49     # Compatibility fixes for Windows
  50     if sys.platform == 'win32':
  51         # https://github.com/rg3/youtube-dl/issues/820
  52         codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
  53
  54     workaround_optparse_bug9161()
  55
  56     setproctitle('youtube-dl')
  57
  58     parser, opts, args = parseOpts(argv)
  59
  60     # Set user agent
  61     if opts.user_agent is not None:
  62         std_headers['User-Agent'] = opts.user_agent
  63
  64     # Set referer
  65     if opts.referer is not None:
  66         std_headers['Referer'] = opts.referer
  67
  68     # Custom HTTP headers
  69     if opts.headers is not None:
  70         for h in opts.headers:
  71             if ':' not in h:
  72                 parser.error('wrong header formatting, it should be key:value, not "%s"' % h)
  73             key, value = h.split(':', 1)
  74             if opts.verbose:
  75                 write_string('[debug] Adding header from command line option %s:%s\n' % (key, value))
  76             std_headers[key] = value
  77
  78     # Dump user agent
  79     if opts.dump_user_agent:
  80         write_string(std_headers['User-Agent'] + '\n', out=sys.stdout)
  81         sys.exit(0)
  82
  83     # Batch file verification
  84     batch_urls = []
  85     if opts.batchfile is not None:
  86         try:
  87             if opts.batchfile == '-':
  88                 batchfd = sys.stdin
  89             else:
  90                 batchfd = io.open(
  91                     compat_expanduser(opts.batchfile),
  92                     'r', encoding='utf-8', errors='ignore')
  93             batch_urls = read_batch_urls(batchfd)
  94             if opts.verbose:
  95                 write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n')
  96         except IOError:
  97             sys.exit('ERROR: batch file could not be read')
  98     all_urls = batch_urls + args
  99     all_urls = [url.strip() for url in all_urls]
 100     _enc = preferredencoding()
 101     all_urls = [url.decode(_enc, 'ignore') if isinstance(url, bytes) else url for url in all_urls]
 102
 103     if opts.list_extractors:
 104         for ie in list_extractors(opts.age_limit):
 105             write_string(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else '') + '\n', out=sys.stdout)
 106             matchedUrls = [url for url in all_urls if ie.suitable(url)]
 107             for mu in matchedUrls:
 108                 write_string('  ' + mu + '\n', out=sys.stdout)
 109         sys.exit(0)
 110     if opts.list_extractor_descriptions:
 111         for ie in list_extractors(opts.age_limit):
 112             if not ie._WORKING:
 113                 continue
 114             desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
 115             if desc is False:
 116                 continue
 117             if hasattr(ie, 'SEARCH_KEY'):
 118                 _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
 119                 _COUNTS = ('', '5', '10', 'all')
 120                 desc += ' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES))
 121             write_string(desc + '\n', out=sys.stdout)
 122         sys.exit(0)
 123     if opts.ap_list_mso:
 124         table = [[mso_id, mso_info['name']] for mso_id, mso_info in MSO_INFO.items()]
 125         write_string('Supported TV Providers:\n' + render_table(['mso', 'mso name'], table) + '\n', out=sys.stdout)
 126         sys.exit(0)
 127
 128     # Conflicting, missing and erroneous options
 129     if opts.usenetrc and (opts.username is not None or opts.password is not None):
 130         parser.error('using .netrc conflicts with giving username/password')
 131     if opts.password is not None and opts.username is None:
 132         parser.error('account username missing\n')
 133     if opts.ap_password is not None and opts.ap_username is None:
 134         parser.error('TV Provider account username missing\n')
 135     if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
 136         parser.error('using output template conflicts with using title, video ID or auto number')
 137     if opts.usetitle and opts.useid:
 138         parser.error('using title conflicts with using video ID')
 139     if opts.username is not None and opts.password is None:
 140         opts.password = compat_getpass('Type account password and press [Return]: ')
 141     if opts.ap_username is not None and opts.ap_password is None:
 142         opts.ap_password = compat_getpass('Type TV provider account password and press [Return]: ')
 143     if opts.ratelimit is not None:
 144         numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
 145         if numeric_limit is None:
 146             parser.error('invalid rate limit specified')
 147         opts.ratelimit = numeric_limit
 148     if opts.min_filesize is not None:
 149         numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
 150         if numeric_limit is None:
 151             parser.error('invalid min_filesize specified')
 152         opts.min_filesize = numeric_limit
 153     if opts.max_filesize is not None:
 154         numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
 155         if numeric_limit is None:
 156             parser.error('invalid max_filesize specified')
 157         opts.max_filesize = numeric_limit
 158     if opts.sleep_interval is not None:
 159         if opts.sleep_interval < 0:
 160             parser.error('sleep interval must be positive or 0')
 161     if opts.max_sleep_interval is not None:
 162         if opts.max_sleep_interval < 0:
 163             parser.error('max sleep interval must be positive or 0')
 164         if opts.max_sleep_interval < opts.sleep_interval:
 165             parser.error('max sleep interval must be greater than or equal to min sleep interval')
 166     else:
 167         opts.max_sleep_interval = opts.sleep_interval
 168     if opts.ap_mso and opts.ap_mso not in MSO_INFO:
 169         parser.error('Unsupported TV Provider, use --ap-list-mso to get a list of supported TV Providers')
 170
 171     def parse_retries(retries):
 172         if retries in ('inf', 'infinite'):
 173             parsed_retries = float('inf')
 174         else:
 175             try:
 176                 parsed_retries = int(retries)
 177             except (TypeError, ValueError):
 178                 parser.error('invalid retry count specified')
 179         return parsed_retries
 180     if opts.retries is not None:
 181         opts.retries = parse_retries(opts.retries)
 182     if opts.fragment_retries is not None:
 183         opts.fragment_retries = parse_retries(opts.fragment_retries)
 184     if opts.buffersize is not None:
 185         numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
 186         if numeric_buffersize is None:
 187             parser.error('invalid buffer size specified')
 188         opts.buffersize = numeric_buffersize
 189     if opts.playliststart <= 0:
 190         raise ValueError('Playlist start must be positive')
 191     if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart:
 192         raise ValueError('Playlist end must be greater than playlist start')
 193     if opts.extractaudio:
 194         if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']:
 195             parser.error('invalid audio format specified')
 196     if opts.audioquality:
 197         opts.audioquality = opts.audioquality.strip('k').strip('K')
 198         if not opts.audioquality.isdigit():
 199             parser.error('invalid audio quality specified')
 200     if opts.recodevideo is not None:
 201         if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg', 'mkv', 'avi']:
 202             parser.error('invalid video recode format specified')
 203     if opts.convertsubtitles is not None:
 204         if opts.convertsubtitles not in ['srt', 'vtt', 'ass']:
 205             parser.error('invalid subtitle format specified')
 206
 207     if opts.date is not None:
 208         date = DateRange.day(opts.date)
 209     else:
 210         date = DateRange(opts.dateafter, opts.datebefore)
 211
 212     # Do not download videos when there are audio-only formats
 213     if opts.extractaudio and not opts.keepvideo and opts.format is None:
 214         opts.format = 'bestaudio/best'
 215
 216     # --all-sub automatically sets --write-sub if --write-auto-sub is not given
 217     # this was the old behaviour if only --all-sub was given.
 218     if opts.allsubtitles and not opts.writeautomaticsub:
 219         opts.writesubtitles = True
 220
 221     outtmpl = ((opts.outtmpl is not None and opts.outtmpl) or
 222                (opts.format == '-1' and opts.usetitle and '%(title)s-%(id)s-%(format)s.%(ext)s') or
 223                (opts.format == '-1' and '%(id)s-%(format)s.%(ext)s') or
 224                (opts.usetitle and opts.autonumber and '%(autonumber)s-%(title)s-%(id)s.%(ext)s') or
 225                (opts.usetitle and '%(title)s-%(id)s.%(ext)s') or
 226                (opts.useid and '%(id)s.%(ext)s') or
 227                (opts.autonumber and '%(autonumber)s-%(id)s.%(ext)s') or
 228                DEFAULT_OUTTMPL)
 229     if not os.path.splitext(outtmpl)[1] and opts.extractaudio:
 230         parser.error('Cannot download a video and extract audio into the same'
 231                      ' file! Use "{0}.%(ext)s" instead of "{0}" as the output'
 232                      ' template'.format(outtmpl))
 233
 234     any_getting = 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
 235     any_printing = opts.print_json
 236     download_archive_fn = compat_expanduser(opts.download_archive) if opts.download_archive is not None else opts.download_archive
 237
 238     # PostProcessors
 239     postprocessors = []
 240     # Add the metadata pp first, the other pps will copy it
 241     if opts.metafromtitle:
 242         postprocessors.append({
 243             'key': 'MetadataFromTitle',
 244             'titleformat': opts.metafromtitle
 245         })
 246     if opts.addmetadata:
 247         postprocessors.append({'key': 'FFmpegMetadata'})
 248     if opts.extractaudio:
 249         postprocessors.append({
 250             'key': 'FFmpegExtractAudio',
 251             'preferredcodec': opts.audioformat,
 252             'preferredquality': opts.audioquality,
 253             'nopostoverwrites': opts.nopostoverwrites,
 254         })
 255     if opts.recodevideo:
 256         postprocessors.append({
 257             'key': 'FFmpegVideoConvertor',
 258             'preferedformat': opts.recodevideo,
 259         })
 260     if opts.convertsubtitles:
 261         postprocessors.append({
 262             'key': 'FFmpegSubtitlesConvertor',
 263             'format': opts.convertsubtitles,
 264         })
 265     if opts.embedsubtitles:
 266         postprocessors.append({
 267             'key': 'FFmpegEmbedSubtitle',
 268         })
 269     if opts.xattrs:
 270         postprocessors.append({'key': 'XAttrMetadata'})
 271     if opts.embedthumbnail:
 272         already_have_thumbnail = opts.writethumbnail or opts.write_all_thumbnails
 273         postprocessors.append({
 274             'key': 'EmbedThumbnail',
 275             'already_have_thumbnail': already_have_thumbnail
 276         })
 277         if not already_have_thumbnail:
 278             opts.writethumbnail = True
 279     # Please keep ExecAfterDownload towards the bottom as it allows the user to modify the final file in any way.
 280     # So if the user is able to remove the file before your postprocessor runs it might cause a few problems.
 281     if opts.exec_cmd:
 282         postprocessors.append({
 283             'key': 'ExecAfterDownload',
 284             'exec_cmd': opts.exec_cmd,
 285         })
 286     external_downloader_args = None
 287     if opts.external_downloader_args:
 288         external_downloader_args = compat_shlex_split(opts.external_downloader_args)
 289     postprocessor_args = None
 290     if opts.postprocessor_args:
 291         postprocessor_args = compat_shlex_split(opts.postprocessor_args)
 292     match_filter = (
 293         None if opts.match_filter is None
 294         else match_filter_func(opts.match_filter))
 295
 296     ydl_opts = {
 297         'usenetrc': opts.usenetrc,
 298         'username': opts.username,
 299         'password': opts.password,
 300         'twofactor': opts.twofactor,
 301         'videopassword': opts.videopassword,
 302         'ap_mso': opts.ap_mso,
 303         'ap_username': opts.ap_username,
 304         'ap_password': opts.ap_password,
 305         'quiet': (opts.quiet or any_getting or any_printing),
 306         'no_warnings': opts.no_warnings,
 307         'forceurl': opts.geturl,
 308         'forcetitle': opts.gettitle,
 309         'forceid': opts.getid,
 310         'forcethumbnail': opts.getthumbnail,
 311         'forcedescription': opts.getdescription,
 312         'forceduration': opts.getduration,
 313         'forcefilename': opts.getfilename,
 314         'forceformat': opts.getformat,
 315         'forcejson': opts.dumpjson or opts.print_json,
 316         'dump_single_json': opts.dump_single_json,
 317         'simulate': opts.simulate or any_getting,
 318         'skip_download': opts.skip_download,
 319         'format': opts.format,
 320         'listformats': opts.listformats,
 321         'outtmpl': outtmpl,
 322         'autonumber_size': opts.autonumber_size,
 323         'restrictfilenames': opts.restrictfilenames,
 324         'ignoreerrors': opts.ignoreerrors,
 325         'force_generic_extractor': opts.force_generic_extractor,
 326         'ratelimit': opts.ratelimit,
 327         'nooverwrites': opts.nooverwrites,
 328         'retries': opts.retries,
 329         'fragment_retries': opts.fragment_retries,
 330         'skip_unavailable_fragments': opts.skip_unavailable_fragments,
 331         'buffersize': opts.buffersize,
 332         'noresizebuffer': opts.noresizebuffer,
 333         'continuedl': opts.continue_dl,
 334         'noprogress': opts.noprogress,
 335         'progress_with_newline': opts.progress_with_newline,
 336         'playliststart': opts.playliststart,
 337         'playlistend': opts.playlistend,
 338         'playlistreverse': opts.playlist_reverse,
 339         'noplaylist': opts.noplaylist,
 340         'logtostderr': opts.outtmpl == '-',
 341         'consoletitle': opts.consoletitle,
 342         'nopart': opts.nopart,
 343         'updatetime': opts.updatetime,
 344         'writedescription': opts.writedescription,
 345         'writeannotations': opts.writeannotations,
 346         'writeinfojson': opts.writeinfojson,
 347         'writethumbnail': opts.writethumbnail,
 348         'write_all_thumbnails': opts.write_all_thumbnails,
 349         'writesubtitles': opts.writesubtitles,
 350         'writeautomaticsub': opts.writeautomaticsub,
 351         'allsubtitles': opts.allsubtitles,
 352         'listsubtitles': opts.listsubtitles,
 353         'subtitlesformat': opts.subtitlesformat,
 354         'subtitleslangs': opts.subtitleslangs,
 355         'matchtitle': decodeOption(opts.matchtitle),
 356         'rejecttitle': decodeOption(opts.rejecttitle),
 357         'max_downloads': opts.max_downloads,
 358         'prefer_free_formats': opts.prefer_free_formats,
 359         'verbose': opts.verbose,
 360         'dump_intermediate_pages': opts.dump_intermediate_pages,
 361         'write_pages': opts.write_pages,
 362         'test': opts.test,
 363         'keepvideo': opts.keepvideo,
 364         'min_filesize': opts.min_filesize,
 365         'max_filesize': opts.max_filesize,
 366         'min_views': opts.min_views,
 367         'max_views': opts.max_views,
 368         'daterange': date,
 369         'cachedir': opts.cachedir,
 370         'youtube_print_sig_code': opts.youtube_print_sig_code,
 371         'age_limit': opts.age_limit,
 372         'download_archive': download_archive_fn,
 373         'cookiefile': opts.cookiefile,
 374         'nocheckcertificate': opts.no_check_certificate,
 375         'prefer_insecure': opts.prefer_insecure,
 376         'proxy': opts.proxy,
 377         'socket_timeout': opts.socket_timeout,
 378         'bidi_workaround': opts.bidi_workaround,
 379         'debug_printtraffic': opts.debug_printtraffic,
 380         'prefer_ffmpeg': opts.prefer_ffmpeg,
 381         'include_ads': opts.include_ads,
 382         'default_search': opts.default_search,
 383         'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
 384         'encoding': opts.encoding,
 385         'extract_flat': opts.extract_flat,
 386         'mark_watched': opts.mark_watched,
 387         'merge_output_format': opts.merge_output_format,
 388         'postprocessors': postprocessors,
 389         'fixup': opts.fixup,
 390         'source_address': opts.source_address,
 391         'call_home': opts.call_home,
 392         'sleep_interval': opts.sleep_interval,
 393         'max_sleep_interval': opts.max_sleep_interval,
 394         'external_downloader': opts.external_downloader,
 395         'list_thumbnails': opts.list_thumbnails,
 396         'playlist_items': opts.playlist_items,
 397         'xattr_set_filesize': opts.xattr_set_filesize,
 398         'match_filter': match_filter,
 399         'no_color': opts.no_color,
 400         'ffmpeg_location': opts.ffmpeg_location,
 401         'hls_prefer_native': opts.hls_prefer_native,
 402         'hls_use_mpegts': opts.hls_use_mpegts,
 403         'external_downloader_args': external_downloader_args,
 404         'postprocessor_args': postprocessor_args,
 405         'cn_verification_proxy': opts.cn_verification_proxy,
 406         'geo_verification_proxy': opts.geo_verification_proxy,
 407
 408     }
 409
 410     with YoutubeDL(ydl_opts) as ydl:
 411         # Update version
 412         if opts.update_self:
 413             update_self(ydl.to_screen, opts.verbose, ydl._opener)
 414
 415         # Remove cache dir
 416         if opts.rm_cachedir:
 417             ydl.cache.remove()
 418
 419         # Maybe do nothing
 420         if (len(all_urls) < 1) and (opts.load_info_filename is None):
 421             if opts.update_self or opts.rm_cachedir:
 422                 sys.exit()
 423
 424             ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv)
 425             parser.error(
 426                 'You must provide at least one URL.\n'
 427                 'Type youtube-dl --help to see a list of all options.')
 428
 429         try:
 430             if opts.load_info_filename is not None:
 431                 retcode = ydl.download_with_info_file(compat_expanduser(opts.load_info_filename))
 432             else:
 433                 retcode = ydl.download(all_urls)
 434         except MaxDownloadsReached:
 435             ydl.to_screen('--max-download limit reached, aborting.')
 436             retcode = 101
 437
 438     sys.exit(retcode)
 439
 440
 441 def main(argv=None):
 442     try:
 443         _real_main(argv)
 444     except DownloadError:
 445         sys.exit(1)
 446     except SameFileError:
 447         sys.exit('ERROR: fixed output name but more than one file to download')
 448     except KeyboardInterrupt:
 449         sys.exit('\nERROR: Interrupted by user')
 450
 451 __all__ = ['main', 'YoutubeDL', 'gen_extractors', 'list_extractors']