_ Git - youtube-dl/blob - youtube_dl/YoutubeDL.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 from __future__ import absolute_import, unicode_literals
   5
   6 import collections
   7 import contextlib
   8 import datetime
   9 import errno
  10 import fileinput
  11 import io
  12 import itertools
  13 import json
  14 import locale
  15 import operator
  16 import os
  17 import platform
  18 import re
  19 import shutil
  20 import subprocess
  21 import socket
  22 import sys
  23 import time
  24 import tokenize
  25 import traceback
  26
  27 if os.name == 'nt':
  28     import ctypes
  29
  30 from .compat import (
  31     compat_basestring,
  32     compat_cookiejar,
  33     compat_expanduser,
  34     compat_get_terminal_size,
  35     compat_http_client,
  36     compat_kwargs,
  37     compat_str,
  38     compat_tokenize_tokenize,
  39     compat_urllib_error,
  40     compat_urllib_request,
  41 )
  42 from .utils import (
  43     escape_url,
  44     ContentTooShortError,
  45     date_from_str,
  46     DateRange,
  47     DEFAULT_OUTTMPL,
  48     determine_ext,
  49     DownloadError,
  50     encodeFilename,
  51     ExtractorError,
  52     format_bytes,
  53     formatSeconds,
  54     HEADRequest,
  55     locked_file,
  56     make_HTTPS_handler,
  57     MaxDownloadsReached,
  58     PagedList,
  59     parse_filesize,
  60     PerRequestProxyHandler,
  61     PostProcessingError,
  62     platform_name,
  63     preferredencoding,
  64     render_table,
  65     SameFileError,
  66     sanitize_filename,
  67     sanitize_path,
  68     std_headers,
  69     subtitles_filename,
  70     UnavailableVideoError,
  71     url_basename,
  72     version_tuple,
  73     write_json_file,
  74     write_string,
  75     YoutubeDLHandler,
  76     prepend_extension,
  77     replace_extension,
  78     args_to_str,
  79     age_restricted,
  80 )
  81 from .cache import Cache
  82 from .extractor import get_info_extractor, gen_extractors
  83 from .downloader import get_suitable_downloader
  84 from .downloader.rtmp import rtmpdump_version
  85 from .postprocessor import (
  86     FFmpegFixupM4aPP,
  87     FFmpegFixupStretchedPP,
  88     FFmpegMergerPP,
  89     FFmpegPostProcessor,
  90     get_postprocessor,
  91 )
  92 from .version import __version__
  93
  94
  95 class YoutubeDL(object):
  96     """YoutubeDL class.
  97
  98     YoutubeDL objects are the ones responsible of downloading the
  99     actual video file and writing it to disk if the user has requested
 100     it, among some other tasks. In most cases there should be one per
 101     program. As, given a video URL, the downloader doesn't know how to
 102     extract all the needed information, task that InfoExtractors do, it
 103     has to pass the URL to one of them.
 104
 105     For this, YoutubeDL objects have a method that allows
 106     InfoExtractors to be registered in a given order. When it is passed
 107     a URL, the YoutubeDL object handles it to the first InfoExtractor it
 108     finds that reports being able to handle it. The InfoExtractor extracts
 109     all the information about the video or videos the URL refers to, and
 110     YoutubeDL process the extracted information, possibly using a File
 111     Downloader to download the video.
 112
 113     YoutubeDL objects accept a lot of parameters. In order not to saturate
 114     the object constructor with arguments, it receives a dictionary of
 115     options instead. These options are available through the params
 116     attribute for the InfoExtractors to use. The YoutubeDL also
 117     registers itself as the downloader in charge for the InfoExtractors
 118     that are added to it, so this is a "mutual registration".
 119
 120     Available options:
 121
 122     username:          Username for authentication purposes.
 123     password:          Password for authentication purposes.
 124     videopassword:     Password for accessing a video.
 125     usenetrc:          Use netrc for authentication instead.
 126     verbose:           Print additional info to stdout.
 127     quiet:             Do not print messages to stdout.
 128     no_warnings:       Do not print out anything for warnings.
 129     forceurl:          Force printing final URL.
 130     forcetitle:        Force printing title.
 131     forceid:           Force printing ID.
 132     forcethumbnail:    Force printing thumbnail URL.
 133     forcedescription:  Force printing description.
 134     forcefilename:     Force printing final filename.
 135     forceduration:     Force printing duration.
 136     forcejson:         Force printing info_dict as JSON.
 137     dump_single_json:  Force printing the info_dict of the whole playlist
 138                        (or video) as a single JSON line.
 139     simulate:          Do not download the video files.
 140     format:            Video format code. See options.py for more information.
 141     outtmpl:           Template for output names.
 142     restrictfilenames: Do not allow "&" and spaces in file names
 143     ignoreerrors:      Do not stop on download errors.
 144     force_generic_extractor: Force downloader to use the generic extractor
 145     nooverwrites:      Prevent overwriting files.
 146     playliststart:     Playlist item to start at.
 147     playlistend:       Playlist item to end at.
 148     playlist_items:    Specific indices of playlist to download.
 149     playlistreverse:   Download playlist items in reverse order.
 150     matchtitle:        Download only matching titles.
 151     rejecttitle:       Reject downloads for matching titles.
 152     logger:            Log messages to a logging.Logger instance.
 153     logtostderr:       Log messages to stderr instead of stdout.
 154     writedescription:  Write the video description to a .description file
 155     writeinfojson:     Write the video description to a .info.json file
 156     writeannotations:  Write the video annotations to a .annotations.xml file
 157     writethumbnail:    Write the thumbnail image to a file
 158     write_all_thumbnails:  Write all thumbnail formats to files
 159     writesubtitles:    Write the video subtitles to a file
 160     writeautomaticsub: Write the automatic subtitles to a file
 161     allsubtitles:      Downloads all the subtitles of the video
 162                        (requires writesubtitles or writeautomaticsub)
 163     listsubtitles:     Lists all available subtitles for the video
 164     subtitlesformat:   The format code for subtitles
 165     subtitleslangs:    List of languages of the subtitles to download
 166     keepvideo:         Keep the video file after post-processing
 167     daterange:         A DateRange object, download only if the upload_date is in the range.
 168     skip_download:     Skip the actual download of the video file
 169     cachedir:          Location of the cache files in the filesystem.
 170                        False to disable filesystem cache.
 171     noplaylist:        Download single video instead of a playlist if in doubt.
 172     age_limit:         An integer representing the user's age in years.
 173                        Unsuitable videos for the given age are skipped.
 174     min_views:         An integer representing the minimum view count the video
 175                        must have in order to not be skipped.
 176                        Videos without view count information are always
 177                        downloaded. None for no limit.
 178     max_views:         An integer representing the maximum view count.
 179                        Videos that are more popular than that are not
 180                        downloaded.
 181                        Videos without view count information are always
 182                        downloaded. None for no limit.
 183     download_archive:  File name of a file where all downloads are recorded.
 184                        Videos already present in the file are not downloaded
 185                        again.
 186     cookiefile:        File name where cookies should be read from and dumped to.
 187     nocheckcertificate:Do not verify SSL certificates
 188     prefer_insecure:   Use HTTP instead of HTTPS to retrieve information.
 189                        At the moment, this is only supported by YouTube.
 190     proxy:             URL of the proxy server to use
 191     cn_verification_proxy:  URL of the proxy to use for IP address verification
 192                        on Chinese sites. (Experimental)
 193     socket_timeout:    Time to wait for unresponsive hosts, in seconds
 194     bidi_workaround:   Work around buggy terminals without bidirectional text
 195                        support, using fridibi
 196     debug_printtraffic:Print out sent and received HTTP traffic
 197     include_ads:       Download ads as well
 198     default_search:    Prepend this string if an input url is not valid.
 199                        'auto' for elaborate guessing
 200     encoding:          Use this encoding instead of the system-specified.
 201     extract_flat:      Do not resolve URLs, return the immediate result.
 202                        Pass in 'in_playlist' to only show this behavior for
 203                        playlist items.
 204     postprocessors:    A list of dictionaries, each with an entry
 205                        * key:  The name of the postprocessor. See
 206                                youtube_dl/postprocessor/__init__.py for a list.
 207                        as well as any further keyword arguments for the
 208                        postprocessor.
 209     progress_hooks:    A list of functions that get called on download
 210                        progress, with a dictionary with the entries
 211                        * status: One of "downloading", "error", or "finished".
 212                                  Check this first and ignore unknown values.
 213
 214                        If status is one of "downloading", or "finished", the
 215                        following properties may also be present:
 216                        * filename: The final filename (always present)
 217                        * tmpfilename: The filename we're currently writing to
 218                        * downloaded_bytes: Bytes on disk
 219                        * total_bytes: Size of the whole file, None if unknown
 220                        * total_bytes_estimate: Guess of the eventual file size,
 221                                                None if unavailable.
 222                        * elapsed: The number of seconds since download started.
 223                        * eta: The estimated time in seconds, None if unknown
 224                        * speed: The download speed in bytes/second, None if
 225                                 unknown
 226                        * fragment_index: The counter of the currently
 227                                          downloaded video fragment.
 228                        * fragment_count: The number of fragments (= individual
 229                                          files that will be merged)
 230
 231                        Progress hooks are guaranteed to be called at least once
 232                        (with status "finished") if the download is successful.
 233     merge_output_format: Extension to use when merging formats.
 234     fixup:             Automatically correct known faults of the file.
 235                        One of:
 236                        - "never": do nothing
 237                        - "warn": only emit a warning
 238                        - "detect_or_warn": check whether we can do anything
 239                                            about it, warn otherwise (default)
 240     source_address:    (Experimental) Client-side IP address to bind to.
 241     call_home:         Boolean, true iff we are allowed to contact the
 242                        youtube-dl servers for debugging.
 243     sleep_interval:    Number of seconds to sleep before each download.
 244     listformats:       Print an overview of available video formats and exit.
 245     list_thumbnails:   Print a table of all thumbnails and exit.
 246     match_filter:      A function that gets called with the info_dict of
 247                        every video.
 248                        If it returns a message, the video is ignored.
 249                        If it returns None, the video is downloaded.
 250                        match_filter_func in utils.py is one example for this.
 251     no_color:          Do not emit color codes in output.
 252
 253     The following options determine which downloader is picked:
 254     external_downloader: Executable of the external downloader to call.
 255                        None or unset for standard (built-in) downloader.
 256     hls_prefer_native: Use the native HLS downloader instead of ffmpeg/avconv.
 257
 258     The following parameters are not used by YoutubeDL itself, they are used by
 259     the downloader (see youtube_dl/downloader/common.py):
 260     nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
 261     noresizebuffer, retries, continuedl, noprogress, consoletitle,
 262     xattr_set_filesize, external_downloader_args.
 263
 264     The following options are used by the post processors:
 265     prefer_ffmpeg:     If True, use ffmpeg instead of avconv if both are available,
 266                        otherwise prefer avconv.
 267     """
 268
 269     params = None
 270     _ies = []
 271     _pps = []
 272     _download_retcode = None
 273     _num_downloads = None
 274     _screen_file = None
 275
 276     def __init__(self, params=None, auto_init=True):
 277         """Create a FileDownloader object with the given options."""
 278         if params is None:
 279             params = {}
 280         self._ies = []
 281         self._ies_instances = {}
 282         self._pps = []
 283         self._progress_hooks = []
 284         self._download_retcode = 0
 285         self._num_downloads = 0
 286         self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
 287         self._err_file = sys.stderr
 288         self.params = params
 289         self.cache = Cache(self)
 290
 291         if params.get('bidi_workaround', False):
 292             try:
 293                 import pty
 294                 master, slave = pty.openpty()
 295                 width = compat_get_terminal_size().columns
 296                 if width is None:
 297                     width_args = []
 298                 else:
 299                     width_args = ['-w', str(width)]
 300                 sp_kwargs = dict(
 301                     stdin=subprocess.PIPE,
 302                     stdout=slave,
 303                     stderr=self._err_file)
 304                 try:
 305                     self._output_process = subprocess.Popen(
 306                         ['bidiv'] + width_args, **sp_kwargs
 307                     )
 308                 except OSError:
 309                     self._output_process = subprocess.Popen(
 310                         ['fribidi', '-c', 'UTF-8'] + width_args, **sp_kwargs)
 311                 self._output_channel = os.fdopen(master, 'rb')
 312             except OSError as ose:
 313                 if ose.errno == 2:
 314                     self.report_warning('Could not find fribidi executable, ignoring --bidi-workaround . Make sure that  fribidi  is an executable file in one of the directories in your $PATH.')
 315                 else:
 316                     raise
 317
 318         if (sys.version_info >= (3,) and sys.platform != 'win32' and
 319                 sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968'] and
 320                 not params.get('restrictfilenames', False)):
 321             # On Python 3, the Unicode filesystem API will throw errors (#1474)
 322             self.report_warning(
 323                 'Assuming --restrict-filenames since file system encoding '
 324                 'cannot encode all characters. '
 325                 'Set the LC_ALL environment variable to fix this.')
 326             self.params['restrictfilenames'] = True
 327
 328         if isinstance(params.get('outtmpl'), bytes):
 329             self.report_warning(
 330                 'Parameter outtmpl is bytes, but should be a unicode string. '
 331                 'Put  from __future__ import unicode_literals  at the top of your code file or consider switching to Python 3.x.')
 332
 333         self._setup_opener()
 334
 335         if auto_init:
 336             self.print_debug_header()
 337             self.add_default_info_extractors()
 338
 339         for pp_def_raw in self.params.get('postprocessors', []):
 340             pp_class = get_postprocessor(pp_def_raw['key'])
 341             pp_def = dict(pp_def_raw)
 342             del pp_def['key']
 343             pp = pp_class(self, **compat_kwargs(pp_def))
 344             self.add_post_processor(pp)
 345
 346         for ph in self.params.get('progress_hooks', []):
 347             self.add_progress_hook(ph)
 348
 349     def warn_if_short_id(self, argv):
 350         # short YouTube ID starting with dash?
 351         idxs = [
 352             i for i, a in enumerate(argv)
 353             if re.match(r'^-[0-9A-Za-z_-]{10}$', a)]
 354         if idxs:
 355             correct_argv = (
 356                 ['youtube-dl'] +
 357                 [a for i, a in enumerate(argv) if i not in idxs] +
 358                 ['--'] + [argv[i] for i in idxs]
 359             )
 360             self.report_warning(
 361                 'Long argument string detected. '
 362                 'Use -- to separate parameters and URLs, like this:\n%s\n' %
 363                 args_to_str(correct_argv))
 364
 365     def add_info_extractor(self, ie):
 366         """Add an InfoExtractor object to the end of the list."""
 367         self._ies.append(ie)
 368         self._ies_instances[ie.ie_key()] = ie
 369         ie.set_downloader(self)
 370
 371     def get_info_extractor(self, ie_key):
 372         """
 373         Get an instance of an IE with name ie_key, it will try to get one from
 374         the _ies list, if there's no instance it will create a new one and add
 375         it to the extractor list.
 376         """
 377         ie = self._ies_instances.get(ie_key)
 378         if ie is None:
 379             ie = get_info_extractor(ie_key)()
 380             self.add_info_extractor(ie)
 381         return ie
 382
 383     def add_default_info_extractors(self):
 384         """
 385         Add the InfoExtractors returned by gen_extractors to the end of the list
 386         """
 387         for ie in gen_extractors():
 388             self.add_info_extractor(ie)
 389
 390     def add_post_processor(self, pp):
 391         """Add a PostProcessor object to the end of the chain."""
 392         self._pps.append(pp)
 393         pp.set_downloader(self)
 394
 395     def add_progress_hook(self, ph):
 396         """Add the progress hook (currently only for the file downloader)"""
 397         self._progress_hooks.append(ph)
 398
 399     def _bidi_workaround(self, message):
 400         if not hasattr(self, '_output_channel'):
 401             return message
 402
 403         assert hasattr(self, '_output_process')
 404         assert isinstance(message, compat_str)
 405         line_count = message.count('\n') + 1
 406         self._output_process.stdin.write((message + '\n').encode('utf-8'))
 407         self._output_process.stdin.flush()
 408         res = ''.join(self._output_channel.readline().decode('utf-8')
 409                       for _ in range(line_count))
 410         return res[:-len('\n')]
 411
 412     def to_screen(self, message, skip_eol=False):
 413         """Print message to stdout if not in quiet mode."""
 414         return self.to_stdout(message, skip_eol, check_quiet=True)
 415
 416     def _write_string(self, s, out=None):
 417         write_string(s, out=out, encoding=self.params.get('encoding'))
 418
 419     def to_stdout(self, message, skip_eol=False, check_quiet=False):
 420         """Print message to stdout if not in quiet mode."""
 421         if self.params.get('logger'):
 422             self.params['logger'].debug(message)
 423         elif not check_quiet or not self.params.get('quiet', False):
 424             message = self._bidi_workaround(message)
 425             terminator = ['\n', ''][skip_eol]
 426             output = message + terminator
 427
 428             self._write_string(output, self._screen_file)
 429
 430     def to_stderr(self, message):
 431         """Print message to stderr."""
 432         assert isinstance(message, compat_str)
 433         if self.params.get('logger'):
 434             self.params['logger'].error(message)
 435         else:
 436             message = self._bidi_workaround(message)
 437             output = message + '\n'
 438             self._write_string(output, self._err_file)
 439
 440     def to_console_title(self, message):
 441         if not self.params.get('consoletitle', False):
 442             return
 443         if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
 444             # c_wchar_p() might not be necessary if `message` is
 445             # already of type unicode()
 446             ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
 447         elif 'TERM' in os.environ:
 448             self._write_string('\033]0;%s\007' % message, self._screen_file)
 449
 450     def save_console_title(self):
 451         if not self.params.get('consoletitle', False):
 452             return
 453         if 'TERM' in os.environ:
 454             # Save the title on stack
 455             self._write_string('\033[22;0t', self._screen_file)
 456
 457     def restore_console_title(self):
 458         if not self.params.get('consoletitle', False):
 459             return
 460         if 'TERM' in os.environ:
 461             # Restore the title from stack
 462             self._write_string('\033[23;0t', self._screen_file)
 463
 464     def __enter__(self):
 465         self.save_console_title()
 466         return self
 467
 468     def __exit__(self, *args):
 469         self.restore_console_title()
 470
 471         if self.params.get('cookiefile') is not None:
 472             self.cookiejar.save()
 473
 474     def trouble(self, message=None, tb=None):
 475         """Determine action to take when a download problem appears.
 476
 477         Depending on if the downloader has been configured to ignore
 478         download errors or not, this method may throw an exception or
 479         not when errors are found, after printing the message.
 480
 481         tb, if given, is additional traceback information.
 482         """
 483         if message is not None:
 484             self.to_stderr(message)
 485         if self.params.get('verbose'):
 486             if tb is None:
 487                 if sys.exc_info()[0]:  # if .trouble has been called from an except block
 488                     tb = ''
 489                     if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
 490                         tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
 491                     tb += compat_str(traceback.format_exc())
 492                 else:
 493                     tb_data = traceback.format_list(traceback.extract_stack())
 494                     tb = ''.join(tb_data)
 495             self.to_stderr(tb)
 496         if not self.params.get('ignoreerrors', False):
 497             if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
 498                 exc_info = sys.exc_info()[1].exc_info
 499             else:
 500                 exc_info = sys.exc_info()
 501             raise DownloadError(message, exc_info)
 502         self._download_retcode = 1
 503
 504     def report_warning(self, message):
 505         '''
 506         Print the message to stderr, it will be prefixed with 'WARNING:'
 507         If stderr is a tty file the 'WARNING:' will be colored
 508         '''
 509         if self.params.get('logger') is not None:
 510             self.params['logger'].warning(message)
 511         else:
 512             if self.params.get('no_warnings'):
 513                 return
 514             if not self.params.get('no_color') and self._err_file.isatty() and os.name != 'nt':
 515                 _msg_header = '\033[0;33mWARNING:\033[0m'
 516             else:
 517                 _msg_header = 'WARNING:'
 518             warning_message = '%s %s' % (_msg_header, message)
 519             self.to_stderr(warning_message)
 520
 521     def report_error(self, message, tb=None):
 522         '''
 523         Do the same as trouble, but prefixes the message with 'ERROR:', colored
 524         in red if stderr is a tty file.
 525         '''
 526         if not self.params.get('no_color') and self._err_file.isatty() and os.name != 'nt':
 527             _msg_header = '\033[0;31mERROR:\033[0m'
 528         else:
 529             _msg_header = 'ERROR:'
 530         error_message = '%s %s' % (_msg_header, message)
 531         self.trouble(error_message, tb)
 532
 533     def report_file_already_downloaded(self, file_name):
 534         """Report file has already been fully downloaded."""
 535         try:
 536             self.to_screen('[download] %s has already been downloaded' % file_name)
 537         except UnicodeEncodeError:
 538             self.to_screen('[download] The file has already been downloaded')
 539
 540     def prepare_filename(self, info_dict):
 541         """Generate the output filename."""
 542         try:
 543             template_dict = dict(info_dict)
 544
 545             template_dict['epoch'] = int(time.time())
 546             autonumber_size = self.params.get('autonumber_size')
 547             if autonumber_size is None:
 548                 autonumber_size = 5
 549             autonumber_templ = '%0' + str(autonumber_size) + 'd'
 550             template_dict['autonumber'] = autonumber_templ % self._num_downloads
 551             if template_dict.get('playlist_index') is not None:
 552                 template_dict['playlist_index'] = '%0*d' % (len(str(template_dict['n_entries'])), template_dict['playlist_index'])
 553             if template_dict.get('resolution') is None:
 554                 if template_dict.get('width') and template_dict.get('height'):
 555                     template_dict['resolution'] = '%dx%d' % (template_dict['width'], template_dict['height'])
 556                 elif template_dict.get('height'):
 557                     template_dict['resolution'] = '%sp' % template_dict['height']
 558                 elif template_dict.get('width'):
 559                     template_dict['resolution'] = '?x%d' % template_dict['width']
 560
 561             sanitize = lambda k, v: sanitize_filename(
 562                 compat_str(v),
 563                 restricted=self.params.get('restrictfilenames'),
 564                 is_id=(k == 'id'))
 565             template_dict = dict((k, sanitize(k, v))
 566                                  for k, v in template_dict.items()
 567                                  if v is not None)
 568             template_dict = collections.defaultdict(lambda: 'NA', template_dict)
 569
 570             outtmpl = sanitize_path(self.params.get('outtmpl', DEFAULT_OUTTMPL))
 571             tmpl = compat_expanduser(outtmpl)
 572             filename = tmpl % template_dict
 573             # Temporary fix for #4787
 574             # 'Treat' all problem characters by passing filename through preferredencoding
 575             # to workaround encoding issues with subprocess on python2 @ Windows
 576             if sys.version_info < (3, 0) and sys.platform == 'win32':
 577                 filename = encodeFilename(filename, True).decode(preferredencoding())
 578             return filename
 579         except ValueError as err:
 580             self.report_error('Error in output template: ' + str(err) + ' (encoding: ' + repr(preferredencoding()) + ')')
 581             return None
 582
 583     def _match_entry(self, info_dict, incomplete):
 584         """ Returns None iff the file should be downloaded """
 585
 586         video_title = info_dict.get('title', info_dict.get('id', 'video'))
 587         if 'title' in info_dict:
 588             # This can happen when we're just evaluating the playlist
 589             title = info_dict['title']
 590             matchtitle = self.params.get('matchtitle', False)
 591             if matchtitle:
 592                 if not re.search(matchtitle, title, re.IGNORECASE):
 593                     return '"' + title + '" title did not match pattern "' + matchtitle + '"'
 594             rejecttitle = self.params.get('rejecttitle', False)
 595             if rejecttitle:
 596                 if re.search(rejecttitle, title, re.IGNORECASE):
 597                     return '"' + title + '" title matched reject pattern "' + rejecttitle + '"'
 598         date = info_dict.get('upload_date', None)
 599         if date is not None:
 600             dateRange = self.params.get('daterange', DateRange())
 601             if date not in dateRange:
 602                 return '%s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
 603         view_count = info_dict.get('view_count', None)
 604         if view_count is not None:
 605             min_views = self.params.get('min_views')
 606             if min_views is not None and view_count < min_views:
 607                 return 'Skipping %s, because it has not reached minimum view count (%d/%d)' % (video_title, view_count, min_views)
 608             max_views = self.params.get('max_views')
 609             if max_views is not None and view_count > max_views:
 610                 return 'Skipping %s, because it has exceeded the maximum view count (%d/%d)' % (video_title, view_count, max_views)
 611         if age_restricted(info_dict.get('age_limit'), self.params.get('age_limit')):
 612             return 'Skipping "%s" because it is age restricted' % video_title
 613         if self.in_download_archive(info_dict):
 614             return '%s has already been recorded in archive' % video_title
 615
 616         if not incomplete:
 617             match_filter = self.params.get('match_filter')
 618             if match_filter is not None:
 619                 ret = match_filter(info_dict)
 620                 if ret is not None:
 621                     return ret
 622
 623         return None
 624
 625     @staticmethod
 626     def add_extra_info(info_dict, extra_info):
 627         '''Set the keys from extra_info in info dict if they are missing'''
 628         for key, value in extra_info.items():
 629             info_dict.setdefault(key, value)
 630
 631     def extract_info(self, url, download=True, ie_key=None, extra_info={},
 632                      process=True, force_generic_extractor=False):
 633         '''
 634         Returns a list with a dictionary for each video we find.
 635         If 'download', also downloads the videos.
 636         extra_info is a dict containing the extra values to add to each result
 637         '''
 638
 639         if not ie_key and force_generic_extractor:
 640             ie_key = 'Generic'
 641
 642         if ie_key:
 643             ies = [self.get_info_extractor(ie_key)]
 644         else:
 645             ies = self._ies
 646
 647         for ie in ies:
 648             if not ie.suitable(url):
 649                 continue
 650
 651             if not ie.working():
 652                 self.report_warning('The program functionality for this site has been marked as broken, '
 653                                     'and will probably not work.')
 654
 655             try:
 656                 ie_result = ie.extract(url)
 657                 if ie_result is None:  # Finished already (backwards compatibility; listformats and friends should be moved here)
 658                     break
 659                 if isinstance(ie_result, list):
 660                     # Backwards compatibility: old IE result format
 661                     ie_result = {
 662                         '_type': 'compat_list',
 663                         'entries': ie_result,
 664                     }
 665                 self.add_default_extra_info(ie_result, ie, url)
 666                 if process:
 667                     return self.process_ie_result(ie_result, download, extra_info)
 668                 else:
 669                     return ie_result
 670             except ExtractorError as de:  # An error we somewhat expected
 671                 self.report_error(compat_str(de), de.format_traceback())
 672                 break
 673             except MaxDownloadsReached:
 674                 raise
 675             except Exception as e:
 676                 if self.params.get('ignoreerrors', False):
 677                     self.report_error(compat_str(e), tb=compat_str(traceback.format_exc()))
 678                     break
 679                 else:
 680                     raise
 681         else:
 682             self.report_error('no suitable InfoExtractor for URL %s' % url)
 683
 684     def add_default_extra_info(self, ie_result, ie, url):
 685         self.add_extra_info(ie_result, {
 686             'extractor': ie.IE_NAME,
 687             'webpage_url': url,
 688             'webpage_url_basename': url_basename(url),
 689             'extractor_key': ie.ie_key(),
 690         })
 691
 692     def process_ie_result(self, ie_result, download=True, extra_info={}):
 693         """
 694         Take the result of the ie(may be modified) and resolve all unresolved
 695         references (URLs, playlist items).
 696
 697         It will also download the videos if 'download'.
 698         Returns the resolved ie_result.
 699         """
 700
 701         result_type = ie_result.get('_type', 'video')
 702
 703         if result_type in ('url', 'url_transparent'):
 704             extract_flat = self.params.get('extract_flat', False)
 705             if ((extract_flat == 'in_playlist' and 'playlist' in extra_info) or
 706                     extract_flat is True):
 707                 if self.params.get('forcejson', False):
 708                     self.to_stdout(json.dumps(ie_result))
 709                 return ie_result
 710
 711         if result_type == 'video':
 712             self.add_extra_info(ie_result, extra_info)
 713             return self.process_video_result(ie_result, download=download)
 714         elif result_type == 'url':
 715             # We have to add extra_info to the results because it may be
 716             # contained in a playlist
 717             return self.extract_info(ie_result['url'],
 718                                      download,
 719                                      ie_key=ie_result.get('ie_key'),
 720                                      extra_info=extra_info)
 721         elif result_type == 'url_transparent':
 722             # Use the information from the embedding page
 723             info = self.extract_info(
 724                 ie_result['url'], ie_key=ie_result.get('ie_key'),
 725                 extra_info=extra_info, download=False, process=False)
 726
 727             force_properties = dict(
 728                 (k, v) for k, v in ie_result.items() if v is not None)
 729             for f in ('_type', 'url'):
 730                 if f in force_properties:
 731                     del force_properties[f]
 732             new_result = info.copy()
 733             new_result.update(force_properties)
 734
 735             assert new_result.get('_type') != 'url_transparent'
 736
 737             return self.process_ie_result(
 738                 new_result, download=download, extra_info=extra_info)
 739         elif result_type == 'playlist' or result_type == 'multi_video':
 740             # We process each entry in the playlist
 741             playlist = ie_result.get('title', None) or ie_result.get('id', None)
 742             self.to_screen('[download] Downloading playlist: %s' % playlist)
 743
 744             playlist_results = []
 745
 746             playliststart = self.params.get('playliststart', 1) - 1
 747             playlistend = self.params.get('playlistend', None)
 748             # For backwards compatibility, interpret -1 as whole list
 749             if playlistend == -1:
 750                 playlistend = None
 751
 752             playlistitems_str = self.params.get('playlist_items', None)
 753             playlistitems = None
 754             if playlistitems_str is not None:
 755                 def iter_playlistitems(format):
 756                     for string_segment in format.split(','):
 757                         if '-' in string_segment:
 758                             start, end = string_segment.split('-')
 759                             for item in range(int(start), int(end) + 1):
 760                                 yield int(item)
 761                         else:
 762                             yield int(string_segment)
 763                 playlistitems = iter_playlistitems(playlistitems_str)
 764
 765             ie_entries = ie_result['entries']
 766             if isinstance(ie_entries, list):
 767                 n_all_entries = len(ie_entries)
 768                 if playlistitems:
 769                     entries = [
 770                         ie_entries[i - 1] for i in playlistitems
 771                         if -n_all_entries <= i - 1 < n_all_entries]
 772                 else:
 773                     entries = ie_entries[playliststart:playlistend]
 774                 n_entries = len(entries)
 775                 self.to_screen(
 776                     "[%s] playlist %s: Collected %d video ids (downloading %d of them)" %
 777                     (ie_result['extractor'], playlist, n_all_entries, n_entries))
 778             elif isinstance(ie_entries, PagedList):
 779                 if playlistitems:
 780                     entries = []
 781                     for item in playlistitems:
 782                         entries.extend(ie_entries.getslice(
 783                             item - 1, item
 784                         ))
 785                 else:
 786                     entries = ie_entries.getslice(
 787                         playliststart, playlistend)
 788                 n_entries = len(entries)
 789                 self.to_screen(
 790                     "[%s] playlist %s: Downloading %d videos" %
 791                     (ie_result['extractor'], playlist, n_entries))
 792             else:  # iterable
 793                 if playlistitems:
 794                     entry_list = list(ie_entries)
 795                     entries = [entry_list[i - 1] for i in playlistitems]
 796                 else:
 797                     entries = list(itertools.islice(
 798                         ie_entries, playliststart, playlistend))
 799                 n_entries = len(entries)
 800                 self.to_screen(
 801                     "[%s] playlist %s: Downloading %d videos" %
 802                     (ie_result['extractor'], playlist, n_entries))
 803
 804             if self.params.get('playlistreverse', False):
 805                 entries = entries[::-1]
 806
 807             for i, entry in enumerate(entries, 1):
 808                 self.to_screen('[download] Downloading video %s of %s' % (i, n_entries))
 809                 extra = {
 810                     'n_entries': n_entries,
 811                     'playlist': playlist,
 812                     'playlist_id': ie_result.get('id'),
 813                     'playlist_title': ie_result.get('title'),
 814                     'playlist_index': i + playliststart,
 815                     'extractor': ie_result['extractor'],
 816                     'webpage_url': ie_result['webpage_url'],
 817                     'webpage_url_basename': url_basename(ie_result['webpage_url']),
 818                     'extractor_key': ie_result['extractor_key'],
 819                 }
 820
 821                 reason = self._match_entry(entry, incomplete=True)
 822                 if reason is not None:
 823                     self.to_screen('[download] ' + reason)
 824                     continue
 825
 826                 entry_result = self.process_ie_result(entry,
 827                                                       download=download,
 828                                                       extra_info=extra)
 829                 playlist_results.append(entry_result)
 830             ie_result['entries'] = playlist_results
 831             return ie_result
 832         elif result_type == 'compat_list':
 833             self.report_warning(
 834                 'Extractor %s returned a compat_list result. '
 835                 'It needs to be updated.' % ie_result.get('extractor'))
 836
 837             def _fixup(r):
 838                 self.add_extra_info(
 839                     r,
 840                     {
 841                         'extractor': ie_result['extractor'],
 842                         'webpage_url': ie_result['webpage_url'],
 843                         'webpage_url_basename': url_basename(ie_result['webpage_url']),
 844                         'extractor_key': ie_result['extractor_key'],
 845                     }
 846                 )
 847                 return r
 848             ie_result['entries'] = [
 849                 self.process_ie_result(_fixup(r), download, extra_info)
 850                 for r in ie_result['entries']
 851             ]
 852             return ie_result
 853         else:
 854             raise Exception('Invalid result type: %s' % result_type)
 855
 856     def _build_format_filter(self, filter_spec):
 857         " Returns a function to filter the formats according to the filter_spec "
 858
 859         OPERATORS = {
 860             '<': operator.lt,
 861             '<=': operator.le,
 862             '>': operator.gt,
 863             '>=': operator.ge,
 864             '=': operator.eq,
 865             '!=': operator.ne,
 866         }
 867         operator_rex = re.compile(r'''(?x)\s*
 868             (?P<key>width|height|tbr|abr|vbr|asr|filesize|fps)
 869             \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
 870             (?P<value>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)
 871             $
 872             ''' % '|'.join(map(re.escape, OPERATORS.keys())))
 873         m = operator_rex.search(filter_spec)
 874         if m:
 875             try:
 876                 comparison_value = int(m.group('value'))
 877             except ValueError:
 878                 comparison_value = parse_filesize(m.group('value'))
 879                 if comparison_value is None:
 880                     comparison_value = parse_filesize(m.group('value') + 'B')
 881                 if comparison_value is None:
 882                     raise ValueError(
 883                         'Invalid value %r in format specification %r' % (
 884                             m.group('value'), filter_spec))
 885             op = OPERATORS[m.group('op')]
 886
 887         if not m:
 888             STR_OPERATORS = {
 889                 '=': operator.eq,
 890                 '!=': operator.ne,
 891             }
 892             str_operator_rex = re.compile(r'''(?x)
 893                 \s*(?P<key>ext|acodec|vcodec|container|protocol)
 894                 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?
 895                 \s*(?P<value>[a-zA-Z0-9_-]+)
 896                 \s*$
 897                 ''' % '|'.join(map(re.escape, STR_OPERATORS.keys())))
 898             m = str_operator_rex.search(filter_spec)
 899             if m:
 900                 comparison_value = m.group('value')
 901                 op = STR_OPERATORS[m.group('op')]
 902
 903         if not m:
 904             raise ValueError('Invalid filter specification %r' % filter_spec)
 905
 906         def _filter(f):
 907             actual_value = f.get(m.group('key'))
 908             if actual_value is None:
 909                 return m.group('none_inclusive')
 910             return op(actual_value, comparison_value)
 911         return _filter
 912
 913     def build_format_selector(self, format_spec):
 914         def syntax_error(note, start):
 915             message = (
 916                 'Invalid format specification: '
 917                 '{0}\n\t{1}\n\t{2}^'.format(note, format_spec, ' ' * start[1]))
 918             return SyntaxError(message)
 919
 920         PICKFIRST = 'PICKFIRST'
 921         MERGE = 'MERGE'
 922         SINGLE = 'SINGLE'
 923         FormatSelector = collections.namedtuple('FormatSelector', ['type', 'selector', 'filters'])
 924
 925         def _parse_filter(tokens):
 926             filter_parts = []
 927             for type, string, start, _, _ in tokens:
 928                 if type == tokenize.OP and string == ']':
 929                     return ''.join(filter_parts)
 930                 else:
 931                     filter_parts.append(string)
 932
 933         def _parse_format_selection(tokens, endwith=[]):
 934             selectors = []
 935             current_selector = None
 936             for type, string, start, _, _ in tokens:
 937                 # ENCODING is only defined in python 3.x
 938                 if type == getattr(tokenize, 'ENCODING', None):
 939                     continue
 940                 elif type in [tokenize.NAME, tokenize.NUMBER]:
 941                     current_selector = FormatSelector(SINGLE, string, [])
 942                 elif type == tokenize.OP:
 943                     if string in endwith:
 944                         break
 945                     if string == ',':
 946                         selectors.append(current_selector)
 947                         current_selector = None
 948                     elif string == '/':
 949                         first_choice = current_selector
 950                         second_choice = _parse_format_selection(tokens, [','])
 951                         current_selector = None
 952                         selectors.append(FormatSelector(PICKFIRST, (first_choice, second_choice), []))
 953                     elif string == '[':
 954                         if not current_selector:
 955                             current_selector = FormatSelector(SINGLE, 'best', [])
 956                         format_filter = _parse_filter(tokens)
 957                         current_selector.filters.append(format_filter)
 958                     elif string == '+':
 959                         video_selector = current_selector
 960                         audio_selector = _parse_format_selection(tokens, [','])
 961                         current_selector = None
 962                         selectors.append(FormatSelector(MERGE, (video_selector, audio_selector), []))
 963                     else:
 964                         raise syntax_error('Operator not recognized: "{0}"'.format(string), start)
 965                 elif type == tokenize.ENDMARKER:
 966                     break
 967             if current_selector:
 968                 selectors.append(current_selector)
 969             return selectors
 970
 971         def _build_selector_function(selector):
 972             if isinstance(selector, list):
 973                 fs = [_build_selector_function(s) for s in selector]
 974
 975                 def selector_function(formats):
 976                     for f in fs:
 977                         for format in f(formats):
 978                             yield format
 979                 return selector_function
 980             elif selector.type == PICKFIRST:
 981                 fs = [_build_selector_function(s) for s in selector.selector]
 982
 983                 def selector_function(formats):
 984                     for f in fs:
 985                         picked_formats = list(f(formats))
 986                         if picked_formats:
 987                             return picked_formats
 988                     return []
 989             elif selector.type == SINGLE:
 990                 format_spec = selector.selector
 991
 992                 def selector_function(formats):
 993                     if format_spec == 'all':
 994                         for f in formats:
 995                             yield f
 996                     elif format_spec in ['best', 'worst', None]:
 997                         format_idx = 0 if format_spec == 'worst' else -1
 998                         audiovideo_formats = [
 999                             f for f in formats
1000                             if f.get('vcodec') != 'none' and f.get('acodec') != 'none']
1001                         if audiovideo_formats:
1002                             yield audiovideo_formats[format_idx]
1003                         # for audio only (soundcloud) or video only (imgur) urls, select the best/worst audio format
1004                         elif (all(f.get('acodec') != 'none' for f in formats) or
1005                               all(f.get('vcodec') != 'none' for f in formats)):
1006                             yield formats[format_idx]
1007                     elif format_spec == 'bestaudio':
1008                         audio_formats = [
1009                             f for f in formats
1010                             if f.get('vcodec') == 'none']
1011                         if audio_formats:
1012                             yield audio_formats[-1]
1013                     elif format_spec == 'worstaudio':
1014                         audio_formats = [
1015                             f for f in formats
1016                             if f.get('vcodec') == 'none']
1017                         if audio_formats:
1018                             yield audio_formats[0]
1019                     elif format_spec == 'bestvideo':
1020                         video_formats = [
1021                             f for f in formats
1022                             if f.get('acodec') == 'none']
1023                         if video_formats:
1024                             yield video_formats[-1]
1025                     elif format_spec == 'worstvideo':
1026                         video_formats = [
1027                             f for f in formats
1028                             if f.get('acodec') == 'none']
1029                         if video_formats:
1030                             yield video_formats[0]
1031                     else:
1032                         extensions = ['mp4', 'flv', 'webm', '3gp', 'm4a', 'mp3', 'ogg', 'aac', 'wav']
1033                         if format_spec in extensions:
1034                             filter_f = lambda f: f['ext'] == format_spec
1035                         else:
1036                             filter_f = lambda f: f['format_id'] == format_spec
1037                         matches = list(filter(filter_f, formats))
1038                         if matches:
1039                             yield matches[-1]
1040             elif selector.type == MERGE:
1041                 def _merge(formats_info):
1042                     format_1, format_2 = [f['format_id'] for f in formats_info]
1043                     # The first format must contain the video and the
1044                     # second the audio
1045                     if formats_info[0].get('vcodec') == 'none':
1046                         self.report_error('The first format must '
1047                                           'contain the video, try using '
1048                                           '"-f %s+%s"' % (format_2, format_1))
1049                         return
1050                     output_ext = (
1051                         formats_info[0]['ext']
1052                         if self.params.get('merge_output_format') is None
1053                         else self.params['merge_output_format'])
1054                     return {
1055                         'requested_formats': formats_info,
1056                         'format': '%s+%s' % (formats_info[0].get('format'),
1057                                              formats_info[1].get('format')),
1058                         'format_id': '%s+%s' % (formats_info[0].get('format_id'),
1059                                                 formats_info[1].get('format_id')),
1060                         'width': formats_info[0].get('width'),
1061                         'height': formats_info[0].get('height'),
1062                         'resolution': formats_info[0].get('resolution'),
1063                         'fps': formats_info[0].get('fps'),
1064                         'vcodec': formats_info[0].get('vcodec'),
1065                         'vbr': formats_info[0].get('vbr'),
1066                         'stretched_ratio': formats_info[0].get('stretched_ratio'),
1067                         'acodec': formats_info[1].get('acodec'),
1068                         'abr': formats_info[1].get('abr'),
1069                         'ext': output_ext,
1070                     }
1071                 video_selector, audio_selector = map(_build_selector_function, selector.selector)
1072
1073                 def selector_function(formats):
1074                     formats = list(formats)
1075                     for pair in itertools.product(video_selector(formats), audio_selector(formats)):
1076                         yield _merge(pair)
1077
1078             filters = [self._build_format_filter(f) for f in selector.filters]
1079
1080             def final_selector(formats):
1081                 for _filter in filters:
1082                     formats = list(filter(_filter, formats))
1083                 return selector_function(formats)
1084             return final_selector
1085
1086         stream = io.BytesIO(format_spec.encode('utf-8'))
1087         tokens = compat_tokenize_tokenize(stream.readline)
1088         parsed_selector = _parse_format_selection(tokens)
1089         return _build_selector_function(parsed_selector)
1090
1091     def _calc_headers(self, info_dict):
1092         res = std_headers.copy()
1093
1094         add_headers = info_dict.get('http_headers')
1095         if add_headers:
1096             res.update(add_headers)
1097
1098         cookies = self._calc_cookies(info_dict)
1099         if cookies:
1100             res['Cookie'] = cookies
1101
1102         return res
1103
1104     def _calc_cookies(self, info_dict):
1105         pr = compat_urllib_request.Request(info_dict['url'])
1106         self.cookiejar.add_cookie_header(pr)
1107         return pr.get_header('Cookie')
1108
1109     def process_video_result(self, info_dict, download=True):
1110         assert info_dict.get('_type', 'video') == 'video'
1111
1112         if 'id' not in info_dict:
1113             raise ExtractorError('Missing "id" field in extractor result')
1114         if 'title' not in info_dict:
1115             raise ExtractorError('Missing "title" field in extractor result')
1116
1117         if 'playlist' not in info_dict:
1118             # It isn't part of a playlist
1119             info_dict['playlist'] = None
1120             info_dict['playlist_index'] = None
1121
1122         thumbnails = info_dict.get('thumbnails')
1123         if thumbnails is None:
1124             thumbnail = info_dict.get('thumbnail')
1125             if thumbnail:
1126                 info_dict['thumbnails'] = thumbnails = [{'url': thumbnail}]
1127         if thumbnails:
1128             thumbnails.sort(key=lambda t: (
1129                 t.get('preference'), t.get('width'), t.get('height'),
1130                 t.get('id'), t.get('url')))
1131             for i, t in enumerate(thumbnails):
1132                 if 'width' in t and 'height' in t:
1133                     t['resolution'] = '%dx%d' % (t['width'], t['height'])
1134                 if t.get('id') is None:
1135                     t['id'] = '%d' % i
1136
1137         if thumbnails and 'thumbnail' not in info_dict:
1138             info_dict['thumbnail'] = thumbnails[-1]['url']
1139
1140         if 'display_id' not in info_dict and 'id' in info_dict:
1141             info_dict['display_id'] = info_dict['id']
1142
1143         if info_dict.get('upload_date') is None and info_dict.get('timestamp') is not None:
1144             # Working around out-of-range timestamp values (e.g. negative ones on Windows,
1145             # see http://bugs.python.org/issue1646728)
1146             try:
1147                 upload_date = datetime.datetime.utcfromtimestamp(info_dict['timestamp'])
1148                 info_dict['upload_date'] = upload_date.strftime('%Y%m%d')
1149             except (ValueError, OverflowError, OSError):
1150                 pass
1151
1152         if self.params.get('listsubtitles', False):
1153             if 'automatic_captions' in info_dict:
1154                 self.list_subtitles(info_dict['id'], info_dict.get('automatic_captions'), 'automatic captions')
1155             self.list_subtitles(info_dict['id'], info_dict.get('subtitles'), 'subtitles')
1156             return
1157         info_dict['requested_subtitles'] = self.process_subtitles(
1158             info_dict['id'], info_dict.get('subtitles'),
1159             info_dict.get('automatic_captions'))
1160
1161         # We now pick which formats have to be downloaded
1162         if info_dict.get('formats') is None:
1163             # There's only one format available
1164             formats = [info_dict]
1165         else:
1166             formats = info_dict['formats']
1167
1168         if not formats:
1169             raise ExtractorError('No video formats found!')
1170
1171         formats_dict = {}
1172
1173         # We check that all the formats have the format and format_id fields
1174         for i, format in enumerate(formats):
1175             if 'url' not in format:
1176                 raise ExtractorError('Missing "url" key in result (index %d)' % i)
1177
1178             if format.get('format_id') is None:
1179                 format['format_id'] = compat_str(i)
1180             format_id = format['format_id']
1181             if format_id not in formats_dict:
1182                 formats_dict[format_id] = []
1183             formats_dict[format_id].append(format)
1184
1185         # Make sure all formats have unique format_id
1186         for format_id, ambiguous_formats in formats_dict.items():
1187             if len(ambiguous_formats) > 1:
1188                 for i, format in enumerate(ambiguous_formats):
1189                     format['format_id'] = '%s-%d' % (format_id, i)
1190
1191         for i, format in enumerate(formats):
1192             if format.get('format') is None:
1193                 format['format'] = '{id} - {res}{note}'.format(
1194                     id=format['format_id'],
1195                     res=self.format_resolution(format),
1196                     note=' ({0})'.format(format['format_note']) if format.get('format_note') is not None else '',
1197                 )
1198             # Automatically determine file extension if missing
1199             if 'ext' not in format:
1200                 format['ext'] = determine_ext(format['url']).lower()
1201             # Add HTTP headers, so that external programs can use them from the
1202             # json output
1203             full_format_info = info_dict.copy()
1204             full_format_info.update(format)
1205             format['http_headers'] = self._calc_headers(full_format_info)
1206
1207         # TODO Central sorting goes here
1208
1209         if formats[0] is not info_dict:
1210             # only set the 'formats' fields if the original info_dict list them
1211             # otherwise we end up with a circular reference, the first (and unique)
1212             # element in the 'formats' field in info_dict is info_dict itself,
1213             # wich can't be exported to json
1214             info_dict['formats'] = formats
1215         if self.params.get('listformats'):
1216             self.list_formats(info_dict)
1217             return
1218         if self.params.get('list_thumbnails'):
1219             self.list_thumbnails(info_dict)
1220             return
1221
1222         req_format = self.params.get('format')
1223         if req_format is None:
1224             req_format_list = []
1225             if (self.params.get('outtmpl', DEFAULT_OUTTMPL) != '-' and
1226                     info_dict['extractor'] in ['youtube', 'ted']):
1227                 merger = FFmpegMergerPP(self)
1228                 if merger.available and merger.can_merge():
1229                     req_format_list.append('bestvideo+bestaudio')
1230             req_format_list.append('best')
1231             req_format = '/'.join(req_format_list)
1232         format_selector = self.build_format_selector(req_format)
1233         formats_to_download = list(format_selector(formats))
1234         if not formats_to_download:
1235             raise ExtractorError('requested format not available',
1236                                  expected=True)
1237
1238         if download:
1239             if len(formats_to_download) > 1:
1240                 self.to_screen('[info] %s: downloading video in %s formats' % (info_dict['id'], len(formats_to_download)))
1241             for format in formats_to_download:
1242                 new_info = dict(info_dict)
1243                 new_info.update(format)
1244                 self.process_info(new_info)
1245         # We update the info dict with the best quality format (backwards compatibility)
1246         info_dict.update(formats_to_download[-1])
1247         return info_dict
1248
1249     def process_subtitles(self, video_id, normal_subtitles, automatic_captions):
1250         """Select the requested subtitles and their format"""
1251         available_subs = {}
1252         if normal_subtitles and self.params.get('writesubtitles'):
1253             available_subs.update(normal_subtitles)
1254         if automatic_captions and self.params.get('writeautomaticsub'):
1255             for lang, cap_info in automatic_captions.items():
1256                 if lang not in available_subs:
1257                     available_subs[lang] = cap_info
1258
1259         if (not self.params.get('writesubtitles') and not
1260                 self.params.get('writeautomaticsub') or not
1261                 available_subs):
1262             return None
1263
1264         if self.params.get('allsubtitles', False):
1265             requested_langs = available_subs.keys()
1266         else:
1267             if self.params.get('subtitleslangs', False):
1268                 requested_langs = self.params.get('subtitleslangs')
1269             elif 'en' in available_subs:
1270                 requested_langs = ['en']
1271             else:
1272                 requested_langs = [list(available_subs.keys())[0]]
1273
1274         formats_query = self.params.get('subtitlesformat', 'best')
1275         formats_preference = formats_query.split('/') if formats_query else []
1276         subs = {}
1277         for lang in requested_langs:
1278             formats = available_subs.get(lang)
1279             if formats is None:
1280                 self.report_warning('%s subtitles not available for %s' % (lang, video_id))
1281                 continue
1282             for ext in formats_preference:
1283                 if ext == 'best':
1284                     f = formats[-1]
1285                     break
1286                 matches = list(filter(lambda f: f['ext'] == ext, formats))
1287                 if matches:
1288                     f = matches[-1]
1289                     break
1290             else:
1291                 f = formats[-1]
1292                 self.report_warning(
1293                     'No subtitle format found matching "%s" for language %s, '
1294                     'using %s' % (formats_query, lang, f['ext']))
1295             subs[lang] = f
1296         return subs
1297
1298     def process_info(self, info_dict):
1299         """Process a single resolved IE result."""
1300
1301         assert info_dict.get('_type', 'video') == 'video'
1302
1303         max_downloads = self.params.get('max_downloads')
1304         if max_downloads is not None:
1305             if self._num_downloads >= int(max_downloads):
1306                 raise MaxDownloadsReached()
1307
1308         info_dict['fulltitle'] = info_dict['title']
1309         if len(info_dict['title']) > 200:
1310             info_dict['title'] = info_dict['title'][:197] + '...'
1311
1312         if 'format' not in info_dict:
1313             info_dict['format'] = info_dict['ext']
1314
1315         reason = self._match_entry(info_dict, incomplete=False)
1316         if reason is not None:
1317             self.to_screen('[download] ' + reason)
1318             return
1319
1320         self._num_downloads += 1
1321
1322         info_dict['_filename'] = filename = self.prepare_filename(info_dict)
1323
1324         # Forced printings
1325         if self.params.get('forcetitle', False):
1326             self.to_stdout(info_dict['fulltitle'])
1327         if self.params.get('forceid', False):
1328             self.to_stdout(info_dict['id'])
1329         if self.params.get('forceurl', False):
1330             if info_dict.get('requested_formats') is not None:
1331                 for f in info_dict['requested_formats']:
1332                     self.to_stdout(f['url'] + f.get('play_path', ''))
1333             else:
1334                 # For RTMP URLs, also include the playpath
1335                 self.to_stdout(info_dict['url'] + info_dict.get('play_path', ''))
1336         if self.params.get('forcethumbnail', False) and info_dict.get('thumbnail') is not None:
1337             self.to_stdout(info_dict['thumbnail'])
1338         if self.params.get('forcedescription', False) and info_dict.get('description') is not None:
1339             self.to_stdout(info_dict['description'])
1340         if self.params.get('forcefilename', False) and filename is not None:
1341             self.to_stdout(filename)
1342         if self.params.get('forceduration', False) and info_dict.get('duration') is not None:
1343             self.to_stdout(formatSeconds(info_dict['duration']))
1344         if self.params.get('forceformat', False):
1345             self.to_stdout(info_dict['format'])
1346         if self.params.get('forcejson', False):
1347             self.to_stdout(json.dumps(info_dict))
1348
1349         # Do nothing else if in simulate mode
1350         if self.params.get('simulate', False):
1351             return
1352
1353         if filename is None:
1354             return
1355
1356         try:
1357             dn = os.path.dirname(sanitize_path(encodeFilename(filename)))
1358             if dn and not os.path.exists(dn):
1359                 os.makedirs(dn)
1360         except (OSError, IOError) as err:
1361             self.report_error('unable to create directory ' + compat_str(err))
1362             return
1363
1364         if self.params.get('writedescription', False):
1365             descfn = replace_extension(filename, 'description', info_dict.get('ext'))
1366             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(descfn)):
1367                 self.to_screen('[info] Video description is already present')
1368             elif info_dict.get('description') is None:
1369                 self.report_warning('There\'s no description to write.')
1370             else:
1371                 try:
1372                     self.to_screen('[info] Writing video description to: ' + descfn)
1373                     with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
1374                         descfile.write(info_dict['description'])
1375                 except (OSError, IOError):
1376                     self.report_error('Cannot write description file ' + descfn)
1377                     return
1378
1379         if self.params.get('writeannotations', False):
1380             annofn = replace_extension(filename, 'annotations.xml', info_dict.get('ext'))
1381             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(annofn)):
1382                 self.to_screen('[info] Video annotations are already present')
1383             else:
1384                 try:
1385                     self.to_screen('[info] Writing video annotations to: ' + annofn)
1386                     with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
1387                         annofile.write(info_dict['annotations'])
1388                 except (KeyError, TypeError):
1389                     self.report_warning('There are no annotations to write.')
1390                 except (OSError, IOError):
1391                     self.report_error('Cannot write annotations file: ' + annofn)
1392                     return
1393
1394         subtitles_are_requested = any([self.params.get('writesubtitles', False),
1395                                        self.params.get('writeautomaticsub')])
1396
1397         if subtitles_are_requested and info_dict.get('requested_subtitles'):
1398             # subtitles download errors are already managed as troubles in relevant IE
1399             # that way it will silently go on when used with unsupporting IE
1400             subtitles = info_dict['requested_subtitles']
1401             ie = self.get_info_extractor(info_dict['extractor_key'])
1402             for sub_lang, sub_info in subtitles.items():
1403                 sub_format = sub_info['ext']
1404                 if sub_info.get('data') is not None:
1405                     sub_data = sub_info['data']
1406                 else:
1407                     try:
1408                         sub_data = ie._download_webpage(
1409                             sub_info['url'], info_dict['id'], note=False)
1410                     except ExtractorError as err:
1411                         self.report_warning('Unable to download subtitle for "%s": %s' %
1412                                             (sub_lang, compat_str(err.cause)))
1413                         continue
1414                 try:
1415                     sub_filename = subtitles_filename(filename, sub_lang, sub_format)
1416                     if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(sub_filename)):
1417                         self.to_screen('[info] Video subtitle %s.%s is already_present' % (sub_lang, sub_format))
1418                     else:
1419                         self.to_screen('[info] Writing video subtitles to: ' + sub_filename)
1420                         with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
1421                             subfile.write(sub_data)
1422                 except (OSError, IOError):
1423                     self.report_error('Cannot write subtitles file ' + sub_filename)
1424                     return
1425
1426         if self.params.get('writeinfojson', False):
1427             infofn = replace_extension(filename, 'info.json', info_dict.get('ext'))
1428             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(infofn)):
1429                 self.to_screen('[info] Video description metadata is already present')
1430             else:
1431                 self.to_screen('[info] Writing video description metadata as JSON to: ' + infofn)
1432                 try:
1433                     write_json_file(self.filter_requested_info(info_dict), infofn)
1434                 except (OSError, IOError):
1435                     self.report_error('Cannot write metadata to JSON file ' + infofn)
1436                     return
1437
1438         self._write_thumbnails(info_dict, filename)
1439
1440         if not self.params.get('skip_download', False):
1441             try:
1442                 def dl(name, info):
1443                     fd = get_suitable_downloader(info, self.params)(self, self.params)
1444                     for ph in self._progress_hooks:
1445                         fd.add_progress_hook(ph)
1446                     if self.params.get('verbose'):
1447                         self.to_stdout('[debug] Invoking downloader on %r' % info.get('url'))
1448                     return fd.download(name, info)
1449
1450                 if info_dict.get('requested_formats') is not None:
1451                     downloaded = []
1452                     success = True
1453                     merger = FFmpegMergerPP(self)
1454                     if not merger.available:
1455                         postprocessors = []
1456                         self.report_warning('You have requested multiple '
1457                                             'formats but ffmpeg or avconv are not installed.'
1458                                             ' The formats won\'t be merged.')
1459                     else:
1460                         postprocessors = [merger]
1461
1462                     def compatible_formats(formats):
1463                         video, audio = formats
1464                         # Check extension
1465                         video_ext, audio_ext = audio.get('ext'), video.get('ext')
1466                         if video_ext and audio_ext:
1467                             COMPATIBLE_EXTS = (
1468                                 ('mp3', 'mp4', 'm4a', 'm4p', 'm4b', 'm4r', 'm4v'),
1469                                 ('webm')
1470                             )
1471                             for exts in COMPATIBLE_EXTS:
1472                                 if video_ext in exts and audio_ext in exts:
1473                                     return True
1474                         # TODO: Check acodec/vcodec
1475                         return False
1476
1477                     filename_real_ext = os.path.splitext(filename)[1][1:]
1478                     filename_wo_ext = (
1479                         os.path.splitext(filename)[0]
1480                         if filename_real_ext == info_dict['ext']
1481                         else filename)
1482                     requested_formats = info_dict['requested_formats']
1483                     if self.params.get('merge_output_format') is None and not compatible_formats(requested_formats):
1484                         info_dict['ext'] = 'mkv'
1485                         self.report_warning(
1486                             'Requested formats are incompatible for merge and will be merged into mkv.')
1487                     # Ensure filename always has a correct extension for successful merge
1488                     filename = '%s.%s' % (filename_wo_ext, info_dict['ext'])
1489                     if os.path.exists(encodeFilename(filename)):
1490                         self.to_screen(
1491                             '[download] %s has already been downloaded and '
1492                             'merged' % filename)
1493                     else:
1494                         for f in requested_formats:
1495                             new_info = dict(info_dict)
1496                             new_info.update(f)
1497                             fname = self.prepare_filename(new_info)
1498                             fname = prepend_extension(fname, 'f%s' % f['format_id'], new_info['ext'])
1499                             downloaded.append(fname)
1500                             partial_success = dl(fname, new_info)
1501                             success = success and partial_success
1502                         info_dict['__postprocessors'] = postprocessors
1503                         info_dict['__files_to_merge'] = downloaded
1504                 else:
1505                     # Just a single file
1506                     success = dl(filename, info_dict)
1507             except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1508                 self.report_error('unable to download video data: %s' % str(err))
1509                 return
1510             except (OSError, IOError) as err:
1511                 raise UnavailableVideoError(err)
1512             except (ContentTooShortError, ) as err:
1513                 self.report_error('content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
1514                 return
1515
1516             if success:
1517                 # Fixup content
1518                 fixup_policy = self.params.get('fixup')
1519                 if fixup_policy is None:
1520                     fixup_policy = 'detect_or_warn'
1521
1522                 stretched_ratio = info_dict.get('stretched_ratio')
1523                 if stretched_ratio is not None and stretched_ratio != 1:
1524                     if fixup_policy == 'warn':
1525                         self.report_warning('%s: Non-uniform pixel ratio (%s)' % (
1526                             info_dict['id'], stretched_ratio))
1527                     elif fixup_policy == 'detect_or_warn':
1528                         stretched_pp = FFmpegFixupStretchedPP(self)
1529                         if stretched_pp.available:
1530                             info_dict.setdefault('__postprocessors', [])
1531                             info_dict['__postprocessors'].append(stretched_pp)
1532                         else:
1533                             self.report_warning(
1534                                 '%s: Non-uniform pixel ratio (%s). Install ffmpeg or avconv to fix this automatically.' % (
1535                                     info_dict['id'], stretched_ratio))
1536                     else:
1537                         assert fixup_policy in ('ignore', 'never')
1538
1539                 if info_dict.get('requested_formats') is None and info_dict.get('container') == 'm4a_dash':
1540                     if fixup_policy == 'warn':
1541                         self.report_warning('%s: writing DASH m4a. Only some players support this container.' % (
1542                             info_dict['id']))
1543                     elif fixup_policy == 'detect_or_warn':
1544                         fixup_pp = FFmpegFixupM4aPP(self)
1545                         if fixup_pp.available:
1546                             info_dict.setdefault('__postprocessors', [])
1547                             info_dict['__postprocessors'].append(fixup_pp)
1548                         else:
1549                             self.report_warning(
1550                                 '%s: writing DASH m4a. Only some players support this container. Install ffmpeg or avconv to fix this automatically.' % (
1551                                     info_dict['id']))
1552                     else:
1553                         assert fixup_policy in ('ignore', 'never')
1554
1555                 try:
1556                     self.post_process(filename, info_dict)
1557                 except (PostProcessingError) as err:
1558                     self.report_error('postprocessing: %s' % str(err))
1559                     return
1560                 self.record_download_archive(info_dict)
1561
1562     def download(self, url_list):
1563         """Download a given list of URLs."""
1564         outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
1565         if (len(url_list) > 1 and
1566                 '%' not in outtmpl and
1567                 self.params.get('max_downloads') != 1):
1568             raise SameFileError(outtmpl)
1569
1570         for url in url_list:
1571             try:
1572                 # It also downloads the videos
1573                 res = self.extract_info(
1574                     url, force_generic_extractor=self.params.get('force_generic_extractor', False))
1575             except UnavailableVideoError:
1576                 self.report_error('unable to download video')
1577             except MaxDownloadsReached:
1578                 self.to_screen('[info] Maximum number of downloaded files reached.')
1579                 raise
1580             else:
1581                 if self.params.get('dump_single_json', False):
1582                     self.to_stdout(json.dumps(res))
1583
1584         return self._download_retcode
1585
1586     def download_with_info_file(self, info_filename):
1587         with contextlib.closing(fileinput.FileInput(
1588                 [info_filename], mode='r',
1589                 openhook=fileinput.hook_encoded('utf-8'))) as f:
1590             # FileInput doesn't have a read method, we can't call json.load
1591             info = self.filter_requested_info(json.loads('\n'.join(f)))
1592         try:
1593             self.process_ie_result(info, download=True)
1594         except DownloadError:
1595             webpage_url = info.get('webpage_url')
1596             if webpage_url is not None:
1597                 self.report_warning('The info failed to download, trying with "%s"' % webpage_url)
1598                 return self.download([webpage_url])
1599             else:
1600                 raise
1601         return self._download_retcode
1602
1603     @staticmethod
1604     def filter_requested_info(info_dict):
1605         return dict(
1606             (k, v) for k, v in info_dict.items()
1607             if k not in ['requested_formats', 'requested_subtitles'])
1608
1609     def post_process(self, filename, ie_info):
1610         """Run all the postprocessors on the given file."""
1611         info = dict(ie_info)
1612         info['filepath'] = filename
1613         pps_chain = []
1614         if ie_info.get('__postprocessors') is not None:
1615             pps_chain.extend(ie_info['__postprocessors'])
1616         pps_chain.extend(self._pps)
1617         for pp in pps_chain:
1618             files_to_delete = []
1619             try:
1620                 files_to_delete, info = pp.run(info)
1621             except PostProcessingError as e:
1622                 self.report_error(e.msg)
1623             if files_to_delete and not self.params.get('keepvideo', False):
1624                 for old_filename in files_to_delete:
1625                     self.to_screen('Deleting original file %s (pass -k to keep)' % old_filename)
1626                     try:
1627                         os.remove(encodeFilename(old_filename))
1628                     except (IOError, OSError):
1629                         self.report_warning('Unable to remove downloaded original file')
1630
1631     def _make_archive_id(self, info_dict):
1632         # Future-proof against any change in case
1633         # and backwards compatibility with prior versions
1634         extractor = info_dict.get('extractor_key')
1635         if extractor is None:
1636             if 'id' in info_dict:
1637                 extractor = info_dict.get('ie_key')  # key in a playlist
1638         if extractor is None:
1639             return None  # Incomplete video information
1640         return extractor.lower() + ' ' + info_dict['id']
1641
1642     def in_download_archive(self, info_dict):
1643         fn = self.params.get('download_archive')
1644         if fn is None:
1645             return False
1646
1647         vid_id = self._make_archive_id(info_dict)
1648         if vid_id is None:
1649             return False  # Incomplete video information
1650
1651         try:
1652             with locked_file(fn, 'r', encoding='utf-8') as archive_file:
1653                 for line in archive_file:
1654                     if line.strip() == vid_id:
1655                         return True
1656         except IOError as ioe:
1657             if ioe.errno != errno.ENOENT:
1658                 raise
1659         return False
1660
1661     def record_download_archive(self, info_dict):
1662         fn = self.params.get('download_archive')
1663         if fn is None:
1664             return
1665         vid_id = self._make_archive_id(info_dict)
1666         assert vid_id
1667         with locked_file(fn, 'a', encoding='utf-8') as archive_file:
1668             archive_file.write(vid_id + '\n')
1669
1670     @staticmethod
1671     def format_resolution(format, default='unknown'):
1672         if format.get('vcodec') == 'none':
1673             return 'audio only'
1674         if format.get('resolution') is not None:
1675             return format['resolution']
1676         if format.get('height') is not None:
1677             if format.get('width') is not None:
1678                 res = '%sx%s' % (format['width'], format['height'])
1679             else:
1680                 res = '%sp' % format['height']
1681         elif format.get('width') is not None:
1682             res = '?x%d' % format['width']
1683         else:
1684             res = default
1685         return res
1686
1687     def _format_note(self, fdict):
1688         res = ''
1689         if fdict.get('ext') in ['f4f', 'f4m']:
1690             res += '(unsupported) '
1691         if fdict.get('format_note') is not None:
1692             res += fdict['format_note'] + ' '
1693         if fdict.get('tbr') is not None:
1694             res += '%4dk ' % fdict['tbr']
1695         if fdict.get('container') is not None:
1696             if res:
1697                 res += ', '
1698             res += '%s container' % fdict['container']
1699         if (fdict.get('vcodec') is not None and
1700                 fdict.get('vcodec') != 'none'):
1701             if res:
1702                 res += ', '
1703             res += fdict['vcodec']
1704             if fdict.get('vbr') is not None:
1705                 res += '@'
1706         elif fdict.get('vbr') is not None and fdict.get('abr') is not None:
1707             res += 'video@'
1708         if fdict.get('vbr') is not None:
1709             res += '%4dk' % fdict['vbr']
1710         if fdict.get('fps') is not None:
1711             res += ', %sfps' % fdict['fps']
1712         if fdict.get('acodec') is not None:
1713             if res:
1714                 res += ', '
1715             if fdict['acodec'] == 'none':
1716                 res += 'video only'
1717             else:
1718                 res += '%-5s' % fdict['acodec']
1719         elif fdict.get('abr') is not None:
1720             if res:
1721                 res += ', '
1722             res += 'audio'
1723         if fdict.get('abr') is not None:
1724             res += '@%3dk' % fdict['abr']
1725         if fdict.get('asr') is not None:
1726             res += ' (%5dHz)' % fdict['asr']
1727         if fdict.get('filesize') is not None:
1728             if res:
1729                 res += ', '
1730             res += format_bytes(fdict['filesize'])
1731         elif fdict.get('filesize_approx') is not None:
1732             if res:
1733                 res += ', '
1734             res += '~' + format_bytes(fdict['filesize_approx'])
1735         return res
1736
1737     def list_formats(self, info_dict):
1738         formats = info_dict.get('formats', [info_dict])
1739         table = [
1740             [f['format_id'], f['ext'], self.format_resolution(f), self._format_note(f)]
1741             for f in formats
1742             if f.get('preference') is None or f['preference'] >= -1000]
1743         if len(formats) > 1:
1744             table[-1][-1] += (' ' if table[-1][-1] else '') + '(best)'
1745
1746         header_line = ['format code', 'extension', 'resolution', 'note']
1747         self.to_screen(
1748             '[info] Available formats for %s:\n%s' %
1749             (info_dict['id'], render_table(header_line, table)))
1750
1751     def list_thumbnails(self, info_dict):
1752         thumbnails = info_dict.get('thumbnails')
1753         if not thumbnails:
1754             tn_url = info_dict.get('thumbnail')
1755             if tn_url:
1756                 thumbnails = [{'id': '0', 'url': tn_url}]
1757             else:
1758                 self.to_screen(
1759                     '[info] No thumbnails present for %s' % info_dict['id'])
1760                 return
1761
1762         self.to_screen(
1763             '[info] Thumbnails for %s:' % info_dict['id'])
1764         self.to_screen(render_table(
1765             ['ID', 'width', 'height', 'URL'],
1766             [[t['id'], t.get('width', 'unknown'), t.get('height', 'unknown'), t['url']] for t in thumbnails]))
1767
1768     def list_subtitles(self, video_id, subtitles, name='subtitles'):
1769         if not subtitles:
1770             self.to_screen('%s has no %s' % (video_id, name))
1771             return
1772         self.to_screen(
1773             'Available %s for %s:' % (name, video_id))
1774         self.to_screen(render_table(
1775             ['Language', 'formats'],
1776             [[lang, ', '.join(f['ext'] for f in reversed(formats))]
1777                 for lang, formats in subtitles.items()]))
1778
1779     def urlopen(self, req):
1780         """ Start an HTTP download """
1781
1782         # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not
1783         # always respected by websites, some tend to give out URLs with non percent-encoded
1784         # non-ASCII characters (see telemb.py, ard.py [#3412])
1785         # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991)
1786         # To work around aforementioned issue we will replace request's original URL with
1787         # percent-encoded one
1788         req_is_string = isinstance(req, compat_basestring)
1789         url = req if req_is_string else req.get_full_url()
1790         url_escaped = escape_url(url)
1791
1792         # Substitute URL if any change after escaping
1793         if url != url_escaped:
1794             if req_is_string:
1795                 req = url_escaped
1796             else:
1797                 req_type = HEADRequest if req.get_method() == 'HEAD' else compat_urllib_request.Request
1798                 req = req_type(
1799                     url_escaped, data=req.data, headers=req.headers,
1800                     origin_req_host=req.origin_req_host, unverifiable=req.unverifiable)
1801
1802         return self._opener.open(req, timeout=self._socket_timeout)
1803
1804     def print_debug_header(self):
1805         if not self.params.get('verbose'):
1806             return
1807
1808         if type('') is not compat_str:
1809             # Python 2.6 on SLES11 SP1 (https://github.com/rg3/youtube-dl/issues/3326)
1810             self.report_warning(
1811                 'Your Python is broken! Update to a newer and supported version')
1812
1813         stdout_encoding = getattr(
1814             sys.stdout, 'encoding', 'missing (%s)' % type(sys.stdout).__name__)
1815         encoding_str = (
1816             '[debug] Encodings: locale %s, fs %s, out %s, pref %s\n' % (
1817                 locale.getpreferredencoding(),
1818                 sys.getfilesystemencoding(),
1819                 stdout_encoding,
1820                 self.get_encoding()))
1821         write_string(encoding_str, encoding=None)
1822
1823         self._write_string('[debug] youtube-dl version ' + __version__ + '\n')
1824         try:
1825             sp = subprocess.Popen(
1826                 ['git', 'rev-parse', '--short', 'HEAD'],
1827                 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
1828                 cwd=os.path.dirname(os.path.abspath(__file__)))
1829             out, err = sp.communicate()
1830             out = out.decode().strip()
1831             if re.match('[0-9a-f]+', out):
1832                 self._write_string('[debug] Git HEAD: ' + out + '\n')
1833         except Exception:
1834             try:
1835                 sys.exc_clear()
1836             except Exception:
1837                 pass
1838         self._write_string('[debug] Python version %s - %s\n' % (
1839             platform.python_version(), platform_name()))
1840
1841         exe_versions = FFmpegPostProcessor.get_versions(self)
1842         exe_versions['rtmpdump'] = rtmpdump_version()
1843         exe_str = ', '.join(
1844             '%s %s' % (exe, v)
1845             for exe, v in sorted(exe_versions.items())
1846             if v
1847         )
1848         if not exe_str:
1849             exe_str = 'none'
1850         self._write_string('[debug] exe versions: %s\n' % exe_str)
1851
1852         proxy_map = {}
1853         for handler in self._opener.handlers:
1854             if hasattr(handler, 'proxies'):
1855                 proxy_map.update(handler.proxies)
1856         self._write_string('[debug] Proxy map: ' + compat_str(proxy_map) + '\n')
1857
1858         if self.params.get('call_home', False):
1859             ipaddr = self.urlopen('https://yt-dl.org/ip').read().decode('utf-8')
1860             self._write_string('[debug] Public IP address: %s\n' % ipaddr)
1861             latest_version = self.urlopen(
1862                 'https://yt-dl.org/latest/version').read().decode('utf-8')
1863             if version_tuple(latest_version) > version_tuple(__version__):
1864                 self.report_warning(
1865                     'You are using an outdated version (newest version: %s)! '
1866                     'See https://yt-dl.org/update if you need help updating.' %
1867                     latest_version)
1868
1869     def _setup_opener(self):
1870         timeout_val = self.params.get('socket_timeout')
1871         self._socket_timeout = 600 if timeout_val is None else float(timeout_val)
1872
1873         opts_cookiefile = self.params.get('cookiefile')
1874         opts_proxy = self.params.get('proxy')
1875
1876         if opts_cookiefile is None:
1877             self.cookiejar = compat_cookiejar.CookieJar()
1878         else:
1879             self.cookiejar = compat_cookiejar.MozillaCookieJar(
1880                 opts_cookiefile)
1881             if os.access(opts_cookiefile, os.R_OK):
1882                 self.cookiejar.load()
1883
1884         cookie_processor = compat_urllib_request.HTTPCookieProcessor(
1885             self.cookiejar)
1886         if opts_proxy is not None:
1887             if opts_proxy == '':
1888                 proxies = {}
1889             else:
1890                 proxies = {'http': opts_proxy, 'https': opts_proxy}
1891         else:
1892             proxies = compat_urllib_request.getproxies()
1893             # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
1894             if 'http' in proxies and 'https' not in proxies:
1895                 proxies['https'] = proxies['http']
1896         proxy_handler = PerRequestProxyHandler(proxies)
1897
1898         debuglevel = 1 if self.params.get('debug_printtraffic') else 0
1899         https_handler = make_HTTPS_handler(self.params, debuglevel=debuglevel)
1900         ydlh = YoutubeDLHandler(self.params, debuglevel=debuglevel)
1901         opener = compat_urllib_request.build_opener(
1902             proxy_handler, https_handler, cookie_processor, ydlh)
1903
1904         # Delete the default user-agent header, which would otherwise apply in
1905         # cases where our custom HTTP handler doesn't come into play
1906         # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
1907         opener.addheaders = []
1908         self._opener = opener
1909
1910     def encode(self, s):
1911         if isinstance(s, bytes):
1912             return s  # Already encoded
1913
1914         try:
1915             return s.encode(self.get_encoding())
1916         except UnicodeEncodeError as err:
1917             err.reason = err.reason + '. Check your system encoding configuration or use the --encoding option.'
1918             raise
1919
1920     def get_encoding(self):
1921         encoding = self.params.get('encoding')
1922         if encoding is None:
1923             encoding = preferredencoding()
1924         return encoding
1925
1926     def _write_thumbnails(self, info_dict, filename):
1927         if self.params.get('writethumbnail', False):
1928             thumbnails = info_dict.get('thumbnails')
1929             if thumbnails:
1930                 thumbnails = [thumbnails[-1]]
1931         elif self.params.get('write_all_thumbnails', False):
1932             thumbnails = info_dict.get('thumbnails')
1933         else:
1934             return
1935
1936         if not thumbnails:
1937             # No thumbnails present, so return immediately
1938             return
1939
1940         for t in thumbnails:
1941             thumb_ext = determine_ext(t['url'], 'jpg')
1942             suffix = '_%s' % t['id'] if len(thumbnails) > 1 else ''
1943             thumb_display_id = '%s ' % t['id'] if len(thumbnails) > 1 else ''
1944             t['filename'] = thumb_filename = os.path.splitext(filename)[0] + suffix + '.' + thumb_ext
1945
1946             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(thumb_filename)):
1947                 self.to_screen('[%s] %s: Thumbnail %sis already present' %
1948                                (info_dict['extractor'], info_dict['id'], thumb_display_id))
1949             else:
1950                 self.to_screen('[%s] %s: Downloading thumbnail %s...' %
1951                                (info_dict['extractor'], info_dict['id'], thumb_display_id))
1952                 try:
1953                     uf = self.urlopen(t['url'])
1954                     with open(thumb_filename, 'wb') as thumbf:
1955                         shutil.copyfileobj(uf, thumbf)
1956                     self.to_screen('[%s] %s: Writing thumbnail %sto: %s' %
1957                                    (info_dict['extractor'], info_dict['id'], thumb_display_id, thumb_filename))
1958                 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1959                     self.report_warning('Unable to download thumbnail "%s": %s' %
1960                                         (t['url'], compat_str(err)))