_ Git - youtube-dl/blob - youtube_dl/extractor/common.py

   1 from __future__ import unicode_literals
   2
   3 import base64
   4 import datetime
   5 import hashlib
   6 import json
   7 import netrc
   8 import os
   9 import re
  10 import socket
  11 import sys
  12 import time
  13 import math
  14
  15 from ..compat import (
  16     compat_cookiejar,
  17     compat_cookies,
  18     compat_etree_fromstring,
  19     compat_getpass,
  20     compat_http_client,
  21     compat_os_name,
  22     compat_str,
  23     compat_urllib_error,
  24     compat_urllib_parse_urlencode,
  25     compat_urllib_request,
  26     compat_urlparse,
  27 )
  28 from ..downloader.f4m import remove_encrypted_media
  29 from ..utils import (
  30     NO_DEFAULT,
  31     age_restricted,
  32     bug_reports_message,
  33     clean_html,
  34     compiled_regex_type,
  35     determine_ext,
  36     error_to_compat_str,
  37     ExtractorError,
  38     fix_xml_ampersands,
  39     float_or_none,
  40     int_or_none,
  41     parse_iso8601,
  42     RegexNotFoundError,
  43     sanitize_filename,
  44     sanitized_Request,
  45     unescapeHTML,
  46     unified_strdate,
  47     unified_timestamp,
  48     url_basename,
  49     xpath_element,
  50     xpath_text,
  51     xpath_with_ns,
  52     determine_protocol,
  53     parse_duration,
  54     mimetype2ext,
  55     update_Request,
  56     update_url_query,
  57     parse_m3u8_attributes,
  58     extract_attributes,
  59     parse_codecs,
  60 )
  61
  62
  63 class InfoExtractor(object):
  64     """Information Extractor class.
  65
  66     Information extractors are the classes that, given a URL, extract
  67     information about the video (or videos) the URL refers to. This
  68     information includes the real video URL, the video title, author and
  69     others. The information is stored in a dictionary which is then
  70     passed to the YoutubeDL. The YoutubeDL processes this
  71     information possibly downloading the video to the file system, among
  72     other possible outcomes.
  73
  74     The type field determines the type of the result.
  75     By far the most common value (and the default if _type is missing) is
  76     "video", which indicates a single video.
  77
  78     For a video, the dictionaries must include the following fields:
  79
  80     id:             Video identifier.
  81     title:          Video title, unescaped.
  82
  83     Additionally, it must contain either a formats entry or a url one:
  84
  85     formats:        A list of dictionaries for each format available, ordered
  86                     from worst to best quality.
  87
  88                     Potential fields:
  89                     * url        Mandatory. The URL of the video file
  90                     * ext        Will be calculated from URL if missing
  91                     * format     A human-readable description of the format
  92                                  ("mp4 container with h264/opus").
  93                                  Calculated from the format_id, width, height.
  94                                  and format_note fields if missing.
  95                     * format_id  A short description of the format
  96                                  ("mp4_h264_opus" or "19").
  97                                 Technically optional, but strongly recommended.
  98                     * format_note Additional info about the format
  99                                  ("3D" or "DASH video")
 100                     * width      Width of the video, if known
 101                     * height     Height of the video, if known
 102                     * resolution Textual description of width and height
 103                     * tbr        Average bitrate of audio and video in KBit/s
 104                     * abr        Average audio bitrate in KBit/s
 105                     * acodec     Name of the audio codec in use
 106                     * asr        Audio sampling rate in Hertz
 107                     * vbr        Average video bitrate in KBit/s
 108                     * fps        Frame rate
 109                     * vcodec     Name of the video codec in use
 110                     * container  Name of the container format
 111                     * filesize   The number of bytes, if known in advance
 112                     * filesize_approx  An estimate for the number of bytes
 113                     * player_url SWF Player URL (used for rtmpdump).
 114                     * protocol   The protocol that will be used for the actual
 115                                  download, lower-case.
 116                                  "http", "https", "rtsp", "rtmp", "rtmpe",
 117                                  "m3u8", "m3u8_native" or "http_dash_segments".
 118                     * preference Order number of this format. If this field is
 119                                  present and not None, the formats get sorted
 120                                  by this field, regardless of all other values.
 121                                  -1 for default (order by other properties),
 122                                  -2 or smaller for less than default.
 123                                  < -1000 to hide the format (if there is
 124                                     another one which is strictly better)
 125                     * language   Language code, e.g. "de" or "en-US".
 126                     * language_preference  Is this in the language mentioned in
 127                                  the URL?
 128                                  10 if it's what the URL is about,
 129                                  -1 for default (don't know),
 130                                  -10 otherwise, other values reserved for now.
 131                     * quality    Order number of the video quality of this
 132                                  format, irrespective of the file format.
 133                                  -1 for default (order by other properties),
 134                                  -2 or smaller for less than default.
 135                     * source_preference  Order number for this video source
 136                                   (quality takes higher priority)
 137                                  -1 for default (order by other properties),
 138                                  -2 or smaller for less than default.
 139                     * http_headers  A dictionary of additional HTTP headers
 140                                  to add to the request.
 141                     * stretched_ratio  If given and not 1, indicates that the
 142                                  video's pixels are not square.
 143                                  width : height ratio as float.
 144                     * no_resume  The server does not support resuming the
 145                                  (HTTP or RTMP) download. Boolean.
 146
 147     url:            Final video URL.
 148     ext:            Video filename extension.
 149     format:         The video format, defaults to ext (used for --get-format)
 150     player_url:     SWF Player URL (used for rtmpdump).
 151
 152     The following fields are optional:
 153
 154     alt_title:      A secondary title of the video.
 155     display_id      An alternative identifier for the video, not necessarily
 156                     unique, but available before title. Typically, id is
 157                     something like "4234987", title "Dancing naked mole rats",
 158                     and display_id "dancing-naked-mole-rats"
 159     thumbnails:     A list of dictionaries, with the following entries:
 160                         * "id" (optional, string) - Thumbnail format ID
 161                         * "url"
 162                         * "preference" (optional, int) - quality of the image
 163                         * "width" (optional, int)
 164                         * "height" (optional, int)
 165                         * "resolution" (optional, string "{width}x{height"},
 166                                         deprecated)
 167                         * "filesize" (optional, int)
 168     thumbnail:      Full URL to a video thumbnail image.
 169     description:    Full video description.
 170     uploader:       Full name of the video uploader.
 171     license:        License name the video is licensed under.
 172     creator:        The creator of the video.
 173     release_date:   The date (YYYYMMDD) when the video was released.
 174     timestamp:      UNIX timestamp of the moment the video became available.
 175     upload_date:    Video upload date (YYYYMMDD).
 176                     If not explicitly set, calculated from timestamp.
 177     uploader_id:    Nickname or id of the video uploader.
 178     uploader_url:   Full URL to a personal webpage of the video uploader.
 179     location:       Physical location where the video was filmed.
 180     subtitles:      The available subtitles as a dictionary in the format
 181                     {language: subformats}. "subformats" is a list sorted from
 182                     lower to higher preference, each element is a dictionary
 183                     with the "ext" entry and one of:
 184                         * "data": The subtitles file contents
 185                         * "url": A URL pointing to the subtitles file
 186                     "ext" will be calculated from URL if missing
 187     automatic_captions: Like 'subtitles', used by the YoutubeIE for
 188                     automatically generated captions
 189     duration:       Length of the video in seconds, as an integer or float.
 190     view_count:     How many users have watched the video on the platform.
 191     like_count:     Number of positive ratings of the video
 192     dislike_count:  Number of negative ratings of the video
 193     repost_count:   Number of reposts of the video
 194     average_rating: Average rating give by users, the scale used depends on the webpage
 195     comment_count:  Number of comments on the video
 196     comments:       A list of comments, each with one or more of the following
 197                     properties (all but one of text or html optional):
 198                         * "author" - human-readable name of the comment author
 199                         * "author_id" - user ID of the comment author
 200                         * "id" - Comment ID
 201                         * "html" - Comment as HTML
 202                         * "text" - Plain text of the comment
 203                         * "timestamp" - UNIX timestamp of comment
 204                         * "parent" - ID of the comment this one is replying to.
 205                                      Set to "root" to indicate that this is a
 206                                      comment to the original video.
 207     age_limit:      Age restriction for the video, as an integer (years)
 208     webpage_url:    The URL to the video webpage, if given to youtube-dl it
 209                     should allow to get the same result again. (It will be set
 210                     by YoutubeDL if it's missing)
 211     categories:     A list of categories that the video falls in, for example
 212                     ["Sports", "Berlin"]
 213     tags:           A list of tags assigned to the video, e.g. ["sweden", "pop music"]
 214     is_live:        True, False, or None (=unknown). Whether this video is a
 215                     live stream that goes on instead of a fixed-length video.
 216     start_time:     Time in seconds where the reproduction should start, as
 217                     specified in the URL.
 218     end_time:       Time in seconds where the reproduction should end, as
 219                     specified in the URL.
 220
 221     The following fields should only be used when the video belongs to some logical
 222     chapter or section:
 223
 224     chapter:        Name or title of the chapter the video belongs to.
 225     chapter_number: Number of the chapter the video belongs to, as an integer.
 226     chapter_id:     Id of the chapter the video belongs to, as a unicode string.
 227
 228     The following fields should only be used when the video is an episode of some
 229     series or programme:
 230
 231     series:         Title of the series or programme the video episode belongs to.
 232     season:         Title of the season the video episode belongs to.
 233     season_number:  Number of the season the video episode belongs to, as an integer.
 234     season_id:      Id of the season the video episode belongs to, as a unicode string.
 235     episode:        Title of the video episode. Unlike mandatory video title field,
 236                     this field should denote the exact title of the video episode
 237                     without any kind of decoration.
 238     episode_number: Number of the video episode within a season, as an integer.
 239     episode_id:     Id of the video episode, as a unicode string.
 240
 241     The following fields should only be used when the media is a track or a part of
 242     a music album:
 243
 244     track:          Title of the track.
 245     track_number:   Number of the track within an album or a disc, as an integer.
 246     track_id:       Id of the track (useful in case of custom indexing, e.g. 6.iii),
 247                     as a unicode string.
 248     artist:         Artist(s) of the track.
 249     genre:          Genre(s) of the track.
 250     album:          Title of the album the track belongs to.
 251     album_type:     Type of the album (e.g. "Demo", "Full-length", "Split", "Compilation", etc).
 252     album_artist:   List of all artists appeared on the album (e.g.
 253                     "Ash Borer / Fell Voices" or "Various Artists", useful for splits
 254                     and compilations).
 255     disc_number:    Number of the disc or other physical medium the track belongs to,
 256                     as an integer.
 257     release_year:   Year (YYYY) when the album was released.
 258
 259     Unless mentioned otherwise, the fields should be Unicode strings.
 260
 261     Unless mentioned otherwise, None is equivalent to absence of information.
 262
 263
 264     _type "playlist" indicates multiple videos.
 265     There must be a key "entries", which is a list, an iterable, or a PagedList
 266     object, each element of which is a valid dictionary by this specification.
 267
 268     Additionally, playlists can have "title", "description" and "id" attributes
 269     with the same semantics as videos (see above).
 270
 271
 272     _type "multi_video" indicates that there are multiple videos that
 273     form a single show, for examples multiple acts of an opera or TV episode.
 274     It must have an entries key like a playlist and contain all the keys
 275     required for a video at the same time.
 276
 277
 278     _type "url" indicates that the video must be extracted from another
 279     location, possibly by a different extractor. Its only required key is:
 280     "url" - the next URL to extract.
 281     The key "ie_key" can be set to the class name (minus the trailing "IE",
 282     e.g. "Youtube") if the extractor class is known in advance.
 283     Additionally, the dictionary may have any properties of the resolved entity
 284     known in advance, for example "title" if the title of the referred video is
 285     known ahead of time.
 286
 287
 288     _type "url_transparent" entities have the same specification as "url", but
 289     indicate that the given additional information is more precise than the one
 290     associated with the resolved URL.
 291     This is useful when a site employs a video service that hosts the video and
 292     its technical metadata, but that video service does not embed a useful
 293     title, description etc.
 294
 295
 296     Subclasses of this one should re-define the _real_initialize() and
 297     _real_extract() methods and define a _VALID_URL regexp.
 298     Probably, they should also be added to the list of extractors.
 299
 300     Finally, the _WORKING attribute should be set to False for broken IEs
 301     in order to warn the users and skip the tests.
 302     """
 303
 304     _ready = False
 305     _downloader = None
 306     _WORKING = True
 307
 308     def __init__(self, downloader=None):
 309         """Constructor. Receives an optional downloader."""
 310         self._ready = False
 311         self.set_downloader(downloader)
 312
 313     @classmethod
 314     def suitable(cls, url):
 315         """Receives a URL and returns True if suitable for this IE."""
 316
 317         # This does not use has/getattr intentionally - we want to know whether
 318         # we have cached the regexp for *this* class, whereas getattr would also
 319         # match the superclass
 320         if '_VALID_URL_RE' not in cls.__dict__:
 321             cls._VALID_URL_RE = re.compile(cls._VALID_URL)
 322         return cls._VALID_URL_RE.match(url) is not None
 323
 324     @classmethod
 325     def _match_id(cls, url):
 326         if '_VALID_URL_RE' not in cls.__dict__:
 327             cls._VALID_URL_RE = re.compile(cls._VALID_URL)
 328         m = cls._VALID_URL_RE.match(url)
 329         assert m
 330         return m.group('id')
 331
 332     @classmethod
 333     def working(cls):
 334         """Getter method for _WORKING."""
 335         return cls._WORKING
 336
 337     def initialize(self):
 338         """Initializes an instance (authentication, etc)."""
 339         if not self._ready:
 340             self._real_initialize()
 341             self._ready = True
 342
 343     def extract(self, url):
 344         """Extracts URL information and returns it in list of dicts."""
 345         try:
 346             self.initialize()
 347             return self._real_extract(url)
 348         except ExtractorError:
 349             raise
 350         except compat_http_client.IncompleteRead as e:
 351             raise ExtractorError('A network error has occurred.', cause=e, expected=True)
 352         except (KeyError, StopIteration) as e:
 353             raise ExtractorError('An extractor error has occurred.', cause=e)
 354
 355     def set_downloader(self, downloader):
 356         """Sets the downloader for this IE."""
 357         self._downloader = downloader
 358
 359     def _real_initialize(self):
 360         """Real initialization process. Redefine in subclasses."""
 361         pass
 362
 363     def _real_extract(self, url):
 364         """Real extraction process. Redefine in subclasses."""
 365         pass
 366
 367     @classmethod
 368     def ie_key(cls):
 369         """A string for getting the InfoExtractor with get_info_extractor"""
 370         return compat_str(cls.__name__[:-2])
 371
 372     @property
 373     def IE_NAME(self):
 374         return compat_str(type(self).__name__[:-2])
 375
 376     def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
 377         """ Returns the response handle """
 378         if note is None:
 379             self.report_download_webpage(video_id)
 380         elif note is not False:
 381             if video_id is None:
 382                 self.to_screen('%s' % (note,))
 383             else:
 384                 self.to_screen('%s: %s' % (video_id, note))
 385         if isinstance(url_or_request, compat_urllib_request.Request):
 386             url_or_request = update_Request(
 387                 url_or_request, data=data, headers=headers, query=query)
 388         else:
 389             if query:
 390                 url_or_request = update_url_query(url_or_request, query)
 391             if data is not None or headers:
 392                 url_or_request = sanitized_Request(url_or_request, data, headers)
 393         try:
 394             return self._downloader.urlopen(url_or_request)
 395         except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
 396             if errnote is False:
 397                 return False
 398             if errnote is None:
 399                 errnote = 'Unable to download webpage'
 400
 401             errmsg = '%s: %s' % (errnote, error_to_compat_str(err))
 402             if fatal:
 403                 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
 404             else:
 405                 self._downloader.report_warning(errmsg)
 406                 return False
 407
 408     def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True, encoding=None, data=None, headers={}, query={}):
 409         """ Returns a tuple (page content as string, URL handle) """
 410         # Strip hashes from the URL (#1038)
 411         if isinstance(url_or_request, (compat_str, str)):
 412             url_or_request = url_or_request.partition('#')[0]
 413
 414         urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal, data=data, headers=headers, query=query)
 415         if urlh is False:
 416             assert not fatal
 417             return False
 418         content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding)
 419         return (content, urlh)
 420
 421     @staticmethod
 422     def _guess_encoding_from_content(content_type, webpage_bytes):
 423         m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
 424         if m:
 425             encoding = m.group(1)
 426         else:
 427             m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
 428                           webpage_bytes[:1024])
 429             if m:
 430                 encoding = m.group(1).decode('ascii')
 431             elif webpage_bytes.startswith(b'\xff\xfe'):
 432                 encoding = 'utf-16'
 433             else:
 434                 encoding = 'utf-8'
 435
 436         return encoding
 437
 438     def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None):
 439         content_type = urlh.headers.get('Content-Type', '')
 440         webpage_bytes = urlh.read()
 441         if prefix is not None:
 442             webpage_bytes = prefix + webpage_bytes
 443         if not encoding:
 444             encoding = self._guess_encoding_from_content(content_type, webpage_bytes)
 445         if self._downloader.params.get('dump_intermediate_pages', False):
 446             try:
 447                 url = url_or_request.get_full_url()
 448             except AttributeError:
 449                 url = url_or_request
 450             self.to_screen('Dumping request to ' + url)
 451             dump = base64.b64encode(webpage_bytes).decode('ascii')
 452             self._downloader.to_screen(dump)
 453         if self._downloader.params.get('write_pages', False):
 454             try:
 455                 url = url_or_request.get_full_url()
 456             except AttributeError:
 457                 url = url_or_request
 458             basen = '%s_%s' % (video_id, url)
 459             if len(basen) > 240:
 460                 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
 461                 basen = basen[:240 - len(h)] + h
 462             raw_filename = basen + '.dump'
 463             filename = sanitize_filename(raw_filename, restricted=True)
 464             self.to_screen('Saving request to ' + filename)
 465             # Working around MAX_PATH limitation on Windows (see
 466             # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
 467             if compat_os_name == 'nt':
 468                 absfilepath = os.path.abspath(filename)
 469                 if len(absfilepath) > 259:
 470                     filename = '\\\\?\\' + absfilepath
 471             with open(filename, 'wb') as outf:
 472                 outf.write(webpage_bytes)
 473
 474         try:
 475             content = webpage_bytes.decode(encoding, 'replace')
 476         except LookupError:
 477             content = webpage_bytes.decode('utf-8', 'replace')
 478
 479         if ('<title>Access to this site is blocked</title>' in content and
 480                 'Websense' in content[:512]):
 481             msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
 482             blocked_iframe = self._html_search_regex(
 483                 r'<iframe src="([^"]+)"', content,
 484                 'Websense information URL', default=None)
 485             if blocked_iframe:
 486                 msg += ' Visit %s for more details' % blocked_iframe
 487             raise ExtractorError(msg, expected=True)
 488         if '<title>The URL you requested has been blocked</title>' in content[:512]:
 489             msg = (
 490                 'Access to this webpage has been blocked by Indian censorship. '
 491                 'Use a VPN or proxy server (with --proxy) to route around it.')
 492             block_msg = self._html_search_regex(
 493                 r'</h1><p>(.*?)</p>',
 494                 content, 'block message', default=None)
 495             if block_msg:
 496                 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
 497             raise ExtractorError(msg, expected=True)
 498
 499         return content
 500
 501     def _download_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, tries=1, timeout=5, encoding=None, data=None, headers={}, query={}):
 502         """ Returns the data of the page as a string """
 503         success = False
 504         try_count = 0
 505         while success is False:
 506             try:
 507                 res = self._download_webpage_handle(url_or_request, video_id, note, errnote, fatal, encoding=encoding, data=data, headers=headers, query=query)
 508                 success = True
 509             except compat_http_client.IncompleteRead as e:
 510                 try_count += 1
 511                 if try_count >= tries:
 512                     raise e
 513                 self._sleep(timeout, video_id)
 514         if res is False:
 515             return res
 516         else:
 517             content, _ = res
 518             return content
 519
 520     def _download_xml(self, url_or_request, video_id,
 521                       note='Downloading XML', errnote='Unable to download XML',
 522                       transform_source=None, fatal=True, encoding=None, data=None, headers={}, query={}):
 523         """Return the xml as an xml.etree.ElementTree.Element"""
 524         xml_string = self._download_webpage(
 525             url_or_request, video_id, note, errnote, fatal=fatal, encoding=encoding, data=data, headers=headers, query=query)
 526         if xml_string is False:
 527             return xml_string
 528         if transform_source:
 529             xml_string = transform_source(xml_string)
 530         return compat_etree_fromstring(xml_string.encode('utf-8'))
 531
 532     def _download_json(self, url_or_request, video_id,
 533                        note='Downloading JSON metadata',
 534                        errnote='Unable to download JSON metadata',
 535                        transform_source=None,
 536                        fatal=True, encoding=None, data=None, headers={}, query={}):
 537         json_string = self._download_webpage(
 538             url_or_request, video_id, note, errnote, fatal=fatal,
 539             encoding=encoding, data=data, headers=headers, query=query)
 540         if (not fatal) and json_string is False:
 541             return None
 542         return self._parse_json(
 543             json_string, video_id, transform_source=transform_source, fatal=fatal)
 544
 545     def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
 546         if transform_source:
 547             json_string = transform_source(json_string)
 548         try:
 549             return json.loads(json_string)
 550         except ValueError as ve:
 551             errmsg = '%s: Failed to parse JSON ' % video_id
 552             if fatal:
 553                 raise ExtractorError(errmsg, cause=ve)
 554             else:
 555                 self.report_warning(errmsg + str(ve))
 556
 557     def report_warning(self, msg, video_id=None):
 558         idstr = '' if video_id is None else '%s: ' % video_id
 559         self._downloader.report_warning(
 560             '[%s] %s%s' % (self.IE_NAME, idstr, msg))
 561
 562     def to_screen(self, msg):
 563         """Print msg to screen, prefixing it with '[ie_name]'"""
 564         self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
 565
 566     def report_extraction(self, id_or_name):
 567         """Report information extraction."""
 568         self.to_screen('%s: Extracting information' % id_or_name)
 569
 570     def report_download_webpage(self, video_id):
 571         """Report webpage download."""
 572         self.to_screen('%s: Downloading webpage' % video_id)
 573
 574     def report_age_confirmation(self):
 575         """Report attempt to confirm age."""
 576         self.to_screen('Confirming age')
 577
 578     def report_login(self):
 579         """Report attempt to log in."""
 580         self.to_screen('Logging in')
 581
 582     @staticmethod
 583     def raise_login_required(msg='This video is only available for registered users'):
 584         raise ExtractorError(
 585             '%s. Use --username and --password or --netrc to provide account credentials.' % msg,
 586             expected=True)
 587
 588     @staticmethod
 589     def raise_geo_restricted(msg='This video is not available from your location due to geo restriction'):
 590         raise ExtractorError(
 591             '%s. You might want to use --proxy to workaround.' % msg,
 592             expected=True)
 593
 594     # Methods for following #608
 595     @staticmethod
 596     def url_result(url, ie=None, video_id=None, video_title=None):
 597         """Returns a URL that points to a page that should be processed"""
 598         # TODO: ie should be the class used for getting the info
 599         video_info = {'_type': 'url',
 600                       'url': url,
 601                       'ie_key': ie}
 602         if video_id is not None:
 603             video_info['id'] = video_id
 604         if video_title is not None:
 605             video_info['title'] = video_title
 606         return video_info
 607
 608     @staticmethod
 609     def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None):
 610         """Returns a playlist"""
 611         video_info = {'_type': 'playlist',
 612                       'entries': entries}
 613         if playlist_id:
 614             video_info['id'] = playlist_id
 615         if playlist_title:
 616             video_info['title'] = playlist_title
 617         if playlist_description:
 618             video_info['description'] = playlist_description
 619         return video_info
 620
 621     def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
 622         """
 623         Perform a regex search on the given string, using a single or a list of
 624         patterns returning the first matching group.
 625         In case of failure return a default value or raise a WARNING or a
 626         RegexNotFoundError, depending on fatal, specifying the field name.
 627         """
 628         if isinstance(pattern, (str, compat_str, compiled_regex_type)):
 629             mobj = re.search(pattern, string, flags)
 630         else:
 631             for p in pattern:
 632                 mobj = re.search(p, string, flags)
 633                 if mobj:
 634                     break
 635
 636         if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
 637             _name = '\033[0;34m%s\033[0m' % name
 638         else:
 639             _name = name
 640
 641         if mobj:
 642             if group is None:
 643                 # return the first matching group
 644                 return next(g for g in mobj.groups() if g is not None)
 645             else:
 646                 return mobj.group(group)
 647         elif default is not NO_DEFAULT:
 648             return default
 649         elif fatal:
 650             raise RegexNotFoundError('Unable to extract %s' % _name)
 651         else:
 652             self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message())
 653             return None
 654
 655     def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
 656         """
 657         Like _search_regex, but strips HTML tags and unescapes entities.
 658         """
 659         res = self._search_regex(pattern, string, name, default, fatal, flags, group)
 660         if res:
 661             return clean_html(res).strip()
 662         else:
 663             return res
 664
 665     def _get_netrc_login_info(self, netrc_machine=None):
 666         username = None
 667         password = None
 668         netrc_machine = netrc_machine or self._NETRC_MACHINE
 669
 670         if self._downloader.params.get('usenetrc', False):
 671             try:
 672                 info = netrc.netrc().authenticators(netrc_machine)
 673                 if info is not None:
 674                     username = info[0]
 675                     password = info[2]
 676                 else:
 677                     raise netrc.NetrcParseError('No authenticators for %s' % netrc_machine)
 678             except (IOError, netrc.NetrcParseError) as err:
 679                 self._downloader.report_warning('parsing .netrc: %s' % error_to_compat_str(err))
 680
 681         return (username, password)
 682
 683     def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
 684         """
 685         Get the login info as (username, password)
 686         First look for the manually specified credentials using username_option
 687         and password_option as keys in params dictionary. If no such credentials
 688         available look in the netrc file using the netrc_machine or _NETRC_MACHINE
 689         value.
 690         If there's no info available, return (None, None)
 691         """
 692         if self._downloader is None:
 693             return (None, None)
 694
 695         downloader_params = self._downloader.params
 696
 697         # Attempt to use provided username and password or .netrc data
 698         if downloader_params.get(username_option) is not None:
 699             username = downloader_params[username_option]
 700             password = downloader_params[password_option]
 701         else:
 702             username, password = self._get_netrc_login_info(netrc_machine)
 703
 704         return username, password
 705
 706     def _get_tfa_info(self, note='two-factor verification code'):
 707         """
 708         Get the two-factor authentication info
 709         TODO - asking the user will be required for sms/phone verify
 710         currently just uses the command line option
 711         If there's no info available, return None
 712         """
 713         if self._downloader is None:
 714             return None
 715         downloader_params = self._downloader.params
 716
 717         if downloader_params.get('twofactor') is not None:
 718             return downloader_params['twofactor']
 719
 720         return compat_getpass('Type %s and press [Return]: ' % note)
 721
 722     # Helper functions for extracting OpenGraph info
 723     @staticmethod
 724     def _og_regexes(prop):
 725         content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
 726         property_re = (r'(?:name|property)=(?:\'og:%(prop)s\'|"og:%(prop)s"|\s*og:%(prop)s\b)'
 727                        % {'prop': re.escape(prop)})
 728         template = r'<meta[^>]+?%s[^>]+?%s'
 729         return [
 730             template % (property_re, content_re),
 731             template % (content_re, property_re),
 732         ]
 733
 734     @staticmethod
 735     def _meta_regex(prop):
 736         return r'''(?isx)<meta
 737                     (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
 738                     [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
 739
 740     def _og_search_property(self, prop, html, name=None, **kargs):
 741         if not isinstance(prop, (list, tuple)):
 742             prop = [prop]
 743         if name is None:
 744             name = 'OpenGraph %s' % prop[0]
 745         og_regexes = []
 746         for p in prop:
 747             og_regexes.extend(self._og_regexes(p))
 748         escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
 749         if escaped is None:
 750             return None
 751         return unescapeHTML(escaped)
 752
 753     def _og_search_thumbnail(self, html, **kargs):
 754         return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
 755
 756     def _og_search_description(self, html, **kargs):
 757         return self._og_search_property('description', html, fatal=False, **kargs)
 758
 759     def _og_search_title(self, html, **kargs):
 760         return self._og_search_property('title', html, **kargs)
 761
 762     def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
 763         regexes = self._og_regexes('video') + self._og_regexes('video:url')
 764         if secure:
 765             regexes = self._og_regexes('video:secure_url') + regexes
 766         return self._html_search_regex(regexes, html, name, **kargs)
 767
 768     def _og_search_url(self, html, **kargs):
 769         return self._og_search_property('url', html, **kargs)
 770
 771     def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
 772         if not isinstance(name, (list, tuple)):
 773             name = [name]
 774         if display_name is None:
 775             display_name = name[0]
 776         return self._html_search_regex(
 777             [self._meta_regex(n) for n in name],
 778             html, display_name, fatal=fatal, group='content', **kwargs)
 779
 780     def _dc_search_uploader(self, html):
 781         return self._html_search_meta('dc.creator', html, 'uploader')
 782
 783     def _rta_search(self, html):
 784         # See http://www.rtalabel.org/index.php?content=howtofaq#single
 785         if re.search(r'(?ix)<meta\s+name="rating"\s+'
 786                      r'     content="RTA-5042-1996-1400-1577-RTA"',
 787                      html):
 788             return 18
 789         return 0
 790
 791     def _media_rating_search(self, html):
 792         # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
 793         rating = self._html_search_meta('rating', html)
 794
 795         if not rating:
 796             return None
 797
 798         RATING_TABLE = {
 799             'safe for kids': 0,
 800             'general': 8,
 801             '14 years': 14,
 802             'mature': 17,
 803             'restricted': 19,
 804         }
 805         return RATING_TABLE.get(rating.lower())
 806
 807     def _family_friendly_search(self, html):
 808         # See http://schema.org/VideoObject
 809         family_friendly = self._html_search_meta('isFamilyFriendly', html)
 810
 811         if not family_friendly:
 812             return None
 813
 814         RATING_TABLE = {
 815             '1': 0,
 816             'true': 0,
 817             '0': 18,
 818             'false': 18,
 819         }
 820         return RATING_TABLE.get(family_friendly.lower())
 821
 822     def _twitter_search_player(self, html):
 823         return self._html_search_meta('twitter:player', html,
 824                                       'twitter card player')
 825
 826     def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
 827         json_ld = self._search_regex(
 828             r'(?s)<script[^>]+type=(["\'])application/ld\+json\1[^>]*>(?P<json_ld>.+?)</script>',
 829             html, 'JSON-LD', group='json_ld', **kwargs)
 830         default = kwargs.get('default', NO_DEFAULT)
 831         if not json_ld:
 832             return default if default is not NO_DEFAULT else {}
 833         # JSON-LD may be malformed and thus `fatal` should be respected.
 834         # At the same time `default` may be passed that assumes `fatal=False`
 835         # for _search_regex. Let's simulate the same behavior here as well.
 836         fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
 837         return self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
 838
 839     def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
 840         if isinstance(json_ld, compat_str):
 841             json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
 842         if not json_ld:
 843             return {}
 844         info = {}
 845         if not isinstance(json_ld, (list, tuple, dict)):
 846             return info
 847         if isinstance(json_ld, dict):
 848             json_ld = [json_ld]
 849         for e in json_ld:
 850             if e.get('@context') == 'http://schema.org':
 851                 item_type = e.get('@type')
 852                 if expected_type is not None and expected_type != item_type:
 853                     return info
 854                 if item_type == 'TVEpisode':
 855                     info.update({
 856                         'episode': unescapeHTML(e.get('name')),
 857                         'episode_number': int_or_none(e.get('episodeNumber')),
 858                         'description': unescapeHTML(e.get('description')),
 859                     })
 860                     part_of_season = e.get('partOfSeason')
 861                     if isinstance(part_of_season, dict) and part_of_season.get('@type') == 'TVSeason':
 862                         info['season_number'] = int_or_none(part_of_season.get('seasonNumber'))
 863                     part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
 864                     if isinstance(part_of_series, dict) and part_of_series.get('@type') == 'TVSeries':
 865                         info['series'] = unescapeHTML(part_of_series.get('name'))
 866                 elif item_type == 'Article':
 867                     info.update({
 868                         'timestamp': parse_iso8601(e.get('datePublished')),
 869                         'title': unescapeHTML(e.get('headline')),
 870                         'description': unescapeHTML(e.get('articleBody')),
 871                     })
 872                 elif item_type == 'VideoObject':
 873                     info.update({
 874                         'url': e.get('contentUrl'),
 875                         'title': unescapeHTML(e.get('name')),
 876                         'description': unescapeHTML(e.get('description')),
 877                         'thumbnail': e.get('thumbnailUrl'),
 878                         'duration': parse_duration(e.get('duration')),
 879                         'timestamp': unified_timestamp(e.get('uploadDate')),
 880                         'filesize': float_or_none(e.get('contentSize')),
 881                         'tbr': int_or_none(e.get('bitrate')),
 882                         'width': int_or_none(e.get('width')),
 883                         'height': int_or_none(e.get('height')),
 884                     })
 885                 break
 886         return dict((k, v) for k, v in info.items() if v is not None)
 887
 888     @staticmethod
 889     def _hidden_inputs(html):
 890         html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
 891         hidden_inputs = {}
 892         for input in re.findall(r'(?i)(<input[^>]+>)', html):
 893             attrs = extract_attributes(input)
 894             if not input:
 895                 continue
 896             if attrs.get('type') not in ('hidden', 'submit'):
 897                 continue
 898             name = attrs.get('name') or attrs.get('id')
 899             value = attrs.get('value')
 900             if name and value is not None:
 901                 hidden_inputs[name] = value
 902         return hidden_inputs
 903
 904     def _form_hidden_inputs(self, form_id, html):
 905         form = self._search_regex(
 906             r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
 907             html, '%s form' % form_id, group='form')
 908         return self._hidden_inputs(form)
 909
 910     def _sort_formats(self, formats, field_preference=None):
 911         if not formats:
 912             raise ExtractorError('No video formats found')
 913
 914         for f in formats:
 915             # Automatically determine tbr when missing based on abr and vbr (improves
 916             # formats sorting in some cases)
 917             if 'tbr' not in f and f.get('abr') is not None and f.get('vbr') is not None:
 918                 f['tbr'] = f['abr'] + f['vbr']
 919
 920         def _formats_key(f):
 921             # TODO remove the following workaround
 922             from ..utils import determine_ext
 923             if not f.get('ext') and 'url' in f:
 924                 f['ext'] = determine_ext(f['url'])
 925
 926             if isinstance(field_preference, (list, tuple)):
 927                 return tuple(
 928                     f.get(field)
 929                     if f.get(field) is not None
 930                     else ('' if field == 'format_id' else -1)
 931                     for field in field_preference)
 932
 933             preference = f.get('preference')
 934             if preference is None:
 935                 preference = 0
 936                 if f.get('ext') in ['f4f', 'f4m']:  # Not yet supported
 937                     preference -= 0.5
 938
 939             protocol = f.get('protocol') or determine_protocol(f)
 940             proto_preference = 0 if protocol in ['http', 'https'] else (-0.5 if protocol == 'rtsp' else -0.1)
 941
 942             if f.get('vcodec') == 'none':  # audio only
 943                 preference -= 50
 944                 if self._downloader.params.get('prefer_free_formats'):
 945                     ORDER = ['aac', 'mp3', 'm4a', 'webm', 'ogg', 'opus']
 946                 else:
 947                     ORDER = ['webm', 'opus', 'ogg', 'mp3', 'aac', 'm4a']
 948                 ext_preference = 0
 949                 try:
 950                     audio_ext_preference = ORDER.index(f['ext'])
 951                 except ValueError:
 952                     audio_ext_preference = -1
 953             else:
 954                 if f.get('acodec') == 'none':  # video only
 955                     preference -= 40
 956                 if self._downloader.params.get('prefer_free_formats'):
 957                     ORDER = ['flv', 'mp4', 'webm']
 958                 else:
 959                     ORDER = ['webm', 'flv', 'mp4']
 960                 try:
 961                     ext_preference = ORDER.index(f['ext'])
 962                 except ValueError:
 963                     ext_preference = -1
 964                 audio_ext_preference = 0
 965
 966             return (
 967                 preference,
 968                 f.get('language_preference') if f.get('language_preference') is not None else -1,
 969                 f.get('quality') if f.get('quality') is not None else -1,
 970                 f.get('tbr') if f.get('tbr') is not None else -1,
 971                 f.get('filesize') if f.get('filesize') is not None else -1,
 972                 f.get('vbr') if f.get('vbr') is not None else -1,
 973                 f.get('height') if f.get('height') is not None else -1,
 974                 f.get('width') if f.get('width') is not None else -1,
 975                 proto_preference,
 976                 ext_preference,
 977                 f.get('abr') if f.get('abr') is not None else -1,
 978                 audio_ext_preference,
 979                 f.get('fps') if f.get('fps') is not None else -1,
 980                 f.get('filesize_approx') if f.get('filesize_approx') is not None else -1,
 981                 f.get('source_preference') if f.get('source_preference') is not None else -1,
 982                 f.get('format_id') if f.get('format_id') is not None else '',
 983             )
 984         formats.sort(key=_formats_key)
 985
 986     def _check_formats(self, formats, video_id):
 987         if formats:
 988             formats[:] = filter(
 989                 lambda f: self._is_valid_url(
 990                     f['url'], video_id,
 991                     item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
 992                 formats)
 993
 994     @staticmethod
 995     def _remove_duplicate_formats(formats):
 996         format_urls = set()
 997         unique_formats = []
 998         for f in formats:
 999             if f['url'] not in format_urls:
1000                 format_urls.add(f['url'])
1001                 unique_formats.append(f)
1002         formats[:] = unique_formats
1003
1004     def _is_valid_url(self, url, video_id, item='video'):
1005         url = self._proto_relative_url(url, scheme='http:')
1006         # For now assume non HTTP(S) URLs always valid
1007         if not (url.startswith('http://') or url.startswith('https://')):
1008             return True
1009         try:
1010             self._request_webpage(url, video_id, 'Checking %s URL' % item)
1011             return True
1012         except ExtractorError as e:
1013             if isinstance(e.cause, compat_urllib_error.URLError):
1014                 self.to_screen(
1015                     '%s: %s URL is invalid, skipping' % (video_id, item))
1016                 return False
1017             raise
1018
1019     def http_scheme(self):
1020         """ Either "http:" or "https:", depending on the user's preferences """
1021         return (
1022             'http:'
1023             if self._downloader.params.get('prefer_insecure', False)
1024             else 'https:')
1025
1026     def _proto_relative_url(self, url, scheme=None):
1027         if url is None:
1028             return url
1029         if url.startswith('//'):
1030             if scheme is None:
1031                 scheme = self.http_scheme()
1032             return scheme + url
1033         else:
1034             return url
1035
1036     def _sleep(self, timeout, video_id, msg_template=None):
1037         if msg_template is None:
1038             msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
1039         msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1040         self.to_screen(msg)
1041         time.sleep(timeout)
1042
1043     def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None,
1044                              transform_source=lambda s: fix_xml_ampersands(s).strip(),
1045                              fatal=True, m3u8_id=None):
1046         manifest = self._download_xml(
1047             manifest_url, video_id, 'Downloading f4m manifest',
1048             'Unable to download f4m manifest',
1049             # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
1050             # (see https://github.com/rg3/youtube-dl/issues/6215#issuecomment-121704244)
1051             transform_source=transform_source,
1052             fatal=fatal)
1053
1054         if manifest is False:
1055             return []
1056
1057         return self._parse_f4m_formats(
1058             manifest, manifest_url, video_id, preference=preference, f4m_id=f4m_id,
1059             transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
1060
1061     def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, f4m_id=None,
1062                            transform_source=lambda s: fix_xml_ampersands(s).strip(),
1063                            fatal=True, m3u8_id=None):
1064         # currently youtube-dl cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
1065         akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1066         if akamai_pv is not None and ';' in akamai_pv.text:
1067             playerVerificationChallenge = akamai_pv.text.split(';')[0]
1068             if playerVerificationChallenge.strip() != '':
1069                 return []
1070
1071         formats = []
1072         manifest_version = '1.0'
1073         media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
1074         if not media_nodes:
1075             manifest_version = '2.0'
1076             media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
1077         # Remove unsupported DRM protected media from final formats
1078         # rendition (see https://github.com/rg3/youtube-dl/issues/8573).
1079         media_nodes = remove_encrypted_media(media_nodes)
1080         if not media_nodes:
1081             return formats
1082         base_url = xpath_text(
1083             manifest, ['{http://ns.adobe.com/f4m/1.0}baseURL', '{http://ns.adobe.com/f4m/2.0}baseURL'],
1084             'base URL', default=None)
1085         if base_url:
1086             base_url = base_url.strip()
1087
1088         bootstrap_info = xpath_element(
1089             manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1090             'bootstrap info', default=None)
1091
1092         for i, media_el in enumerate(media_nodes):
1093             tbr = int_or_none(media_el.attrib.get('bitrate'))
1094             width = int_or_none(media_el.attrib.get('width'))
1095             height = int_or_none(media_el.attrib.get('height'))
1096             format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
1097             # If <bootstrapInfo> is present, the specified f4m is a
1098             # stream-level manifest, and only set-level manifests may refer to
1099             # external resources.  See section 11.4 and section 4 of F4M spec
1100             if bootstrap_info is None:
1101                 media_url = None
1102                 # @href is introduced in 2.0, see section 11.6 of F4M spec
1103                 if manifest_version == '2.0':
1104                     media_url = media_el.attrib.get('href')
1105                 if media_url is None:
1106                     media_url = media_el.attrib.get('url')
1107                 if not media_url:
1108                     continue
1109                 manifest_url = (
1110                     media_url if media_url.startswith('http://') or media_url.startswith('https://')
1111                     else ((base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
1112                 # If media_url is itself a f4m manifest do the recursive extraction
1113                 # since bitrates in parent manifest (this one) and media_url manifest
1114                 # may differ leading to inability to resolve the format by requested
1115                 # bitrate in f4m downloader
1116                 ext = determine_ext(manifest_url)
1117                 if ext == 'f4m':
1118                     f4m_formats = self._extract_f4m_formats(
1119                         manifest_url, video_id, preference=preference, f4m_id=f4m_id,
1120                         transform_source=transform_source, fatal=fatal)
1121                     # Sometimes stream-level manifest contains single media entry that
1122                     # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1123                     # At the same time parent's media entry in set-level manifest may
1124                     # contain it. We will copy it from parent in such cases.
1125                     if len(f4m_formats) == 1:
1126                         f = f4m_formats[0]
1127                         f.update({
1128                             'tbr': f.get('tbr') or tbr,
1129                             'width': f.get('width') or width,
1130                             'height': f.get('height') or height,
1131                             'format_id': f.get('format_id') if not tbr else format_id,
1132                         })
1133                     formats.extend(f4m_formats)
1134                     continue
1135                 elif ext == 'm3u8':
1136                     formats.extend(self._extract_m3u8_formats(
1137                         manifest_url, video_id, 'mp4', preference=preference,
1138                         m3u8_id=m3u8_id, fatal=fatal))
1139                     continue
1140             formats.append({
1141                 'format_id': format_id,
1142                 'url': manifest_url,
1143                 'ext': 'flv' if bootstrap_info is not None else None,
1144                 'tbr': tbr,
1145                 'width': width,
1146                 'height': height,
1147                 'preference': preference,
1148             })
1149         return formats
1150
1151     def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, m3u8_id=None):
1152         return {
1153             'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
1154             'url': m3u8_url,
1155             'ext': ext,
1156             'protocol': 'm3u8',
1157             'preference': preference - 100 if preference else -100,
1158             'resolution': 'multiple',
1159             'format_note': 'Quality selection URL',
1160         }
1161
1162     def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
1163                               entry_protocol='m3u8', preference=None,
1164                               m3u8_id=None, note=None, errnote=None,
1165                               fatal=True, live=False):
1166
1167         res = self._download_webpage_handle(
1168             m3u8_url, video_id,
1169             note=note or 'Downloading m3u8 information',
1170             errnote=errnote or 'Failed to download m3u8 information',
1171             fatal=fatal)
1172         if res is False:
1173             return []
1174         m3u8_doc, urlh = res
1175         m3u8_url = urlh.geturl()
1176
1177         formats = [self._m3u8_meta_format(m3u8_url, ext, preference, m3u8_id)]
1178
1179         format_url = lambda u: (
1180             u
1181             if re.match(r'^https?://', u)
1182             else compat_urlparse.urljoin(m3u8_url, u))
1183
1184         # We should try extracting formats only from master playlists [1], i.e.
1185         # playlists that describe available qualities. On the other hand media
1186         # playlists [2] should be returned as is since they contain just the media
1187         # without qualities renditions.
1188         # Fortunately, master playlist can be easily distinguished from media
1189         # playlist based on particular tags availability. As of [1, 2] master
1190         # playlist tags MUST NOT appear in a media playist and vice versa.
1191         # As of [3] #EXT-X-TARGETDURATION tag is REQUIRED for every media playlist
1192         # and MUST NOT appear in master playlist thus we can clearly detect media
1193         # playlist with this criterion.
1194         # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.4
1195         # 2. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.3
1196         # 3. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.3.1
1197         if '#EXT-X-TARGETDURATION' in m3u8_doc:  # media playlist, return as is
1198             return [{
1199                 'url': m3u8_url,
1200                 'format_id': m3u8_id,
1201                 'ext': ext,
1202                 'protocol': entry_protocol,
1203                 'preference': preference,
1204             }]
1205         last_info = {}
1206         last_media = {}
1207         for line in m3u8_doc.splitlines():
1208             if line.startswith('#EXT-X-STREAM-INF:'):
1209                 last_info = parse_m3u8_attributes(line)
1210             elif line.startswith('#EXT-X-MEDIA:'):
1211                 media = parse_m3u8_attributes(line)
1212                 media_type = media.get('TYPE')
1213                 if media_type in ('VIDEO', 'AUDIO'):
1214                     media_url = media.get('URI')
1215                     if media_url:
1216                         format_id = []
1217                         for v in (media.get('GROUP-ID'), media.get('NAME')):
1218                             if v:
1219                                 format_id.append(v)
1220                         formats.append({
1221                             'format_id': '-'.join(format_id),
1222                             'url': format_url(media_url),
1223                             'language': media.get('LANGUAGE'),
1224                             'vcodec': 'none' if media_type == 'AUDIO' else None,
1225                             'ext': ext,
1226                             'protocol': entry_protocol,
1227                             'preference': preference,
1228                         })
1229                     else:
1230                         # When there is no URI in EXT-X-MEDIA let this tag's
1231                         # data be used by regular URI lines below
1232                         last_media = media
1233             elif line.startswith('#') or not line.strip():
1234                 continue
1235             else:
1236                 tbr = int_or_none(last_info.get('AVERAGE-BANDWIDTH') or last_info.get('BANDWIDTH'), scale=1000)
1237                 format_id = []
1238                 if m3u8_id:
1239                     format_id.append(m3u8_id)
1240                 # Despite specification does not mention NAME attribute for
1241                 # EXT-X-STREAM-INF it still sometimes may be present
1242                 stream_name = last_info.get('NAME') or last_media.get('NAME')
1243                 # Bandwidth of live streams may differ over time thus making
1244                 # format_id unpredictable. So it's better to keep provided
1245                 # format_id intact.
1246                 if not live:
1247                     format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
1248                 f = {
1249                     'format_id': '-'.join(format_id),
1250                     'url': format_url(line.strip()),
1251                     'tbr': tbr,
1252                     'ext': ext,
1253                     'fps': float_or_none(last_info.get('FRAME-RATE')),
1254                     'protocol': entry_protocol,
1255                     'preference': preference,
1256                 }
1257                 resolution = last_info.get('RESOLUTION')
1258                 if resolution:
1259                     width_str, height_str = resolution.split('x')
1260                     f['width'] = int(width_str)
1261                     f['height'] = int(height_str)
1262                 # Unified Streaming Platform
1263                 mobj = re.search(
1264                     r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
1265                 if mobj:
1266                     abr, vbr = mobj.groups()
1267                     abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
1268                     f.update({
1269                         'vbr': vbr,
1270                         'abr': abr,
1271                     })
1272                 f.update(parse_codecs(last_info.get('CODECS')))
1273                 formats.append(f)
1274                 last_info = {}
1275                 last_media = {}
1276         return formats
1277
1278     @staticmethod
1279     def _xpath_ns(path, namespace=None):
1280         if not namespace:
1281             return path
1282         out = []
1283         for c in path.split('/'):
1284             if not c or c == '.':
1285                 out.append(c)
1286             else:
1287                 out.append('{%s}%s' % (namespace, c))
1288         return '/'.join(out)
1289
1290     def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
1291         smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
1292
1293         if smil is False:
1294             assert not fatal
1295             return []
1296
1297         namespace = self._parse_smil_namespace(smil)
1298
1299         return self._parse_smil_formats(
1300             smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1301
1302     def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
1303         smil = self._download_smil(smil_url, video_id, fatal=fatal)
1304         if smil is False:
1305             return {}
1306         return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
1307
1308     def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
1309         return self._download_xml(
1310             smil_url, video_id, 'Downloading SMIL file',
1311             'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
1312
1313     def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
1314         namespace = self._parse_smil_namespace(smil)
1315
1316         formats = self._parse_smil_formats(
1317             smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1318         subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
1319
1320         video_id = os.path.splitext(url_basename(smil_url))[0]
1321         title = None
1322         description = None
1323         upload_date = None
1324         for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1325             name = meta.attrib.get('name')
1326             content = meta.attrib.get('content')
1327             if not name or not content:
1328                 continue
1329             if not title and name == 'title':
1330                 title = content
1331             elif not description and name in ('description', 'abstract'):
1332                 description = content
1333             elif not upload_date and name == 'date':
1334                 upload_date = unified_strdate(content)
1335
1336         thumbnails = [{
1337             'id': image.get('type'),
1338             'url': image.get('src'),
1339             'width': int_or_none(image.get('width')),
1340             'height': int_or_none(image.get('height')),
1341         } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
1342
1343         return {
1344             'id': video_id,
1345             'title': title or video_id,
1346             'description': description,
1347             'upload_date': upload_date,
1348             'thumbnails': thumbnails,
1349             'formats': formats,
1350             'subtitles': subtitles,
1351         }
1352
1353     def _parse_smil_namespace(self, smil):
1354         return self._search_regex(
1355             r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
1356
1357     def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
1358         base = smil_url
1359         for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1360             b = meta.get('base') or meta.get('httpBase')
1361             if b:
1362                 base = b
1363                 break
1364
1365         formats = []
1366         rtmp_count = 0
1367         http_count = 0
1368         m3u8_count = 0
1369
1370         srcs = []
1371         media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
1372         for medium in media:
1373             src = medium.get('src')
1374             if not src or src in srcs:
1375                 continue
1376             srcs.append(src)
1377
1378             bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
1379             filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
1380             width = int_or_none(medium.get('width'))
1381             height = int_or_none(medium.get('height'))
1382             proto = medium.get('proto')
1383             ext = medium.get('ext')
1384             src_ext = determine_ext(src)
1385             streamer = medium.get('streamer') or base
1386
1387             if proto == 'rtmp' or streamer.startswith('rtmp'):
1388                 rtmp_count += 1
1389                 formats.append({
1390                     'url': streamer,
1391                     'play_path': src,
1392                     'ext': 'flv',
1393                     'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
1394                     'tbr': bitrate,
1395                     'filesize': filesize,
1396                     'width': width,
1397                     'height': height,
1398                 })
1399                 if transform_rtmp_url:
1400                     streamer, src = transform_rtmp_url(streamer, src)
1401                     formats[-1].update({
1402                         'url': streamer,
1403                         'play_path': src,
1404                     })
1405                 continue
1406
1407             src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
1408             src_url = src_url.strip()
1409
1410             if proto == 'm3u8' or src_ext == 'm3u8':
1411                 m3u8_formats = self._extract_m3u8_formats(
1412                     src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
1413                 if len(m3u8_formats) == 1:
1414                     m3u8_count += 1
1415                     m3u8_formats[0].update({
1416                         'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
1417                         'tbr': bitrate,
1418                         'width': width,
1419                         'height': height,
1420                     })
1421                 formats.extend(m3u8_formats)
1422                 continue
1423
1424             if src_ext == 'f4m':
1425                 f4m_url = src_url
1426                 if not f4m_params:
1427                     f4m_params = {
1428                         'hdcore': '3.2.0',
1429                         'plugin': 'flowplayer-3.2.0.1',
1430                     }
1431                 f4m_url += '&' if '?' in f4m_url else '?'
1432                 f4m_url += compat_urllib_parse_urlencode(f4m_params)
1433                 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
1434                 continue
1435
1436             if src_url.startswith('http') and self._is_valid_url(src, video_id):
1437                 http_count += 1
1438                 formats.append({
1439                     'url': src_url,
1440                     'ext': ext or src_ext or 'flv',
1441                     'format_id': 'http-%d' % (bitrate or http_count),
1442                     'tbr': bitrate,
1443                     'filesize': filesize,
1444                     'width': width,
1445                     'height': height,
1446                 })
1447                 continue
1448
1449         return formats
1450
1451     def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
1452         urls = []
1453         subtitles = {}
1454         for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
1455             src = textstream.get('src')
1456             if not src or src in urls:
1457                 continue
1458             urls.append(src)
1459             ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
1460             lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
1461             subtitles.setdefault(lang, []).append({
1462                 'url': src,
1463                 'ext': ext,
1464             })
1465         return subtitles
1466
1467     def _extract_xspf_playlist(self, playlist_url, playlist_id, fatal=True):
1468         xspf = self._download_xml(
1469             playlist_url, playlist_id, 'Downloading xpsf playlist',
1470             'Unable to download xspf manifest', fatal=fatal)
1471         if xspf is False:
1472             return []
1473         return self._parse_xspf(xspf, playlist_id)
1474
1475     def _parse_xspf(self, playlist, playlist_id):
1476         NS_MAP = {
1477             'xspf': 'http://xspf.org/ns/0/',
1478             's1': 'http://static.streamone.nl/player/ns/0',
1479         }
1480
1481         entries = []
1482         for track in playlist.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
1483             title = xpath_text(
1484                 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
1485             description = xpath_text(
1486                 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
1487             thumbnail = xpath_text(
1488                 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
1489             duration = float_or_none(
1490                 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
1491
1492             formats = [{
1493                 'url': location.text,
1494                 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
1495                 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
1496                 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
1497             } for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP))]
1498             self._sort_formats(formats)
1499
1500             entries.append({
1501                 'id': playlist_id,
1502                 'title': title,
1503                 'description': description,
1504                 'thumbnail': thumbnail,
1505                 'duration': duration,
1506                 'formats': formats,
1507             })
1508         return entries
1509
1510     def _extract_mpd_formats(self, mpd_url, video_id, mpd_id=None, note=None, errnote=None, fatal=True, formats_dict={}):
1511         res = self._download_webpage_handle(
1512             mpd_url, video_id,
1513             note=note or 'Downloading MPD manifest',
1514             errnote=errnote or 'Failed to download MPD manifest',
1515             fatal=fatal)
1516         if res is False:
1517             return []
1518         mpd, urlh = res
1519         mpd_base_url = re.match(r'https?://.+/', urlh.geturl()).group()
1520
1521         return self._parse_mpd_formats(
1522             compat_etree_fromstring(mpd.encode('utf-8')), mpd_id, mpd_base_url, formats_dict=formats_dict)
1523
1524     def _parse_mpd_formats(self, mpd_doc, mpd_id=None, mpd_base_url='', formats_dict={}):
1525         """
1526         Parse formats from MPD manifest.
1527         References:
1528          1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
1529             http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
1530          2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
1531         """
1532         if mpd_doc.get('type') == 'dynamic':
1533             return []
1534
1535         namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
1536
1537         def _add_ns(path):
1538             return self._xpath_ns(path, namespace)
1539
1540         def is_drm_protected(element):
1541             return element.find(_add_ns('ContentProtection')) is not None
1542
1543         def extract_multisegment_info(element, ms_parent_info):
1544             ms_info = ms_parent_info.copy()
1545             segment_list = element.find(_add_ns('SegmentList'))
1546             if segment_list is not None:
1547                 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
1548                 if segment_urls_e:
1549                     ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
1550                 initialization = segment_list.find(_add_ns('Initialization'))
1551                 if initialization is not None:
1552                     ms_info['initialization_url'] = initialization.attrib['sourceURL']
1553             else:
1554                 segment_template = element.find(_add_ns('SegmentTemplate'))
1555                 if segment_template is not None:
1556                     start_number = segment_template.get('startNumber')
1557                     if start_number:
1558                         ms_info['start_number'] = int(start_number)
1559                     segment_timeline = segment_template.find(_add_ns('SegmentTimeline'))
1560                     if segment_timeline is not None:
1561                         s_e = segment_timeline.findall(_add_ns('S'))
1562                         if s_e:
1563                             ms_info['total_number'] = 0
1564                             ms_info['s'] = []
1565                             for s in s_e:
1566                                 r = int(s.get('r', 0))
1567                                 ms_info['total_number'] += 1 + r
1568                                 ms_info['s'].append({
1569                                     't': int(s.get('t', 0)),
1570                                     # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
1571                                     'd': int(s.attrib['d']),
1572                                     'r': r,
1573                                 })
1574                     else:
1575                         timescale = segment_template.get('timescale')
1576                         if timescale:
1577                             ms_info['timescale'] = int(timescale)
1578                         segment_duration = segment_template.get('duration')
1579                         if segment_duration:
1580                             ms_info['segment_duration'] = int(segment_duration)
1581                     media_template = segment_template.get('media')
1582                     if media_template:
1583                         ms_info['media_template'] = media_template
1584                     initialization = segment_template.get('initialization')
1585                     if initialization:
1586                         ms_info['initialization_url'] = initialization
1587                     else:
1588                         initialization = segment_template.find(_add_ns('Initialization'))
1589                         if initialization is not None:
1590                             ms_info['initialization_url'] = initialization.attrib['sourceURL']
1591             return ms_info
1592
1593         mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
1594         formats = []
1595         for period in mpd_doc.findall(_add_ns('Period')):
1596             period_duration = parse_duration(period.get('duration')) or mpd_duration
1597             period_ms_info = extract_multisegment_info(period, {
1598                 'start_number': 1,
1599                 'timescale': 1,
1600             })
1601             for adaptation_set in period.findall(_add_ns('AdaptationSet')):
1602                 if is_drm_protected(adaptation_set):
1603                     continue
1604                 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
1605                 for representation in adaptation_set.findall(_add_ns('Representation')):
1606                     if is_drm_protected(representation):
1607                         continue
1608                     representation_attrib = adaptation_set.attrib.copy()
1609                     representation_attrib.update(representation.attrib)
1610                     # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
1611                     mime_type = representation_attrib['mimeType']
1612                     content_type = mime_type.split('/')[0]
1613                     if content_type == 'text':
1614                         # TODO implement WebVTT downloading
1615                         pass
1616                     elif content_type == 'video' or content_type == 'audio':
1617                         base_url = ''
1618                         for element in (representation, adaptation_set, period, mpd_doc):
1619                             base_url_e = element.find(_add_ns('BaseURL'))
1620                             if base_url_e is not None:
1621                                 base_url = base_url_e.text + base_url
1622                                 if re.match(r'^https?://', base_url):
1623                                     break
1624                         if mpd_base_url and not re.match(r'^https?://', base_url):
1625                             if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
1626                                 mpd_base_url += '/'
1627                             base_url = mpd_base_url + base_url
1628                         representation_id = representation_attrib.get('id')
1629                         lang = representation_attrib.get('lang')
1630                         url_el = representation.find(_add_ns('BaseURL'))
1631                         filesize = int_or_none(url_el.attrib.get('{http://youtube.com/yt/2012/10/10}contentLength') if url_el is not None else None)
1632                         f = {
1633                             'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
1634                             'url': base_url,
1635                             'ext': mimetype2ext(mime_type),
1636                             'width': int_or_none(representation_attrib.get('width')),
1637                             'height': int_or_none(representation_attrib.get('height')),
1638                             'tbr': int_or_none(representation_attrib.get('bandwidth'), 1000),
1639                             'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
1640                             'fps': int_or_none(representation_attrib.get('frameRate')),
1641                             'vcodec': 'none' if content_type == 'audio' else representation_attrib.get('codecs'),
1642                             'acodec': 'none' if content_type == 'video' else representation_attrib.get('codecs'),
1643                             'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
1644                             'format_note': 'DASH %s' % content_type,
1645                             'filesize': filesize,
1646                         }
1647                         representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
1648                         if 'segment_urls' not in representation_ms_info and 'media_template' in representation_ms_info:
1649                             if 'total_number' not in representation_ms_info and 'segment_duration':
1650                                 segment_duration = float(representation_ms_info['segment_duration']) / float(representation_ms_info['timescale'])
1651                                 representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
1652                             media_template = representation_ms_info['media_template']
1653                             media_template = media_template.replace('$RepresentationID$', representation_id)
1654                             media_template = re.sub(r'\$(Number|Bandwidth|Time)\$', r'%(\1)d', media_template)
1655                             media_template = re.sub(r'\$(Number|Bandwidth|Time)%([^$]+)\$', r'%(\1)\2', media_template)
1656                             media_template.replace('$$', '$')
1657
1658                             # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
1659                             # can't be used at the same time
1660                             if '%(Number' in media_template:
1661                                 representation_ms_info['segment_urls'] = [
1662                                     media_template % {
1663                                         'Number': segment_number,
1664                                         'Bandwidth': representation_attrib.get('bandwidth'),
1665                                     }
1666                                     for segment_number in range(
1667                                         representation_ms_info['start_number'],
1668                                         representation_ms_info['total_number'] + representation_ms_info['start_number'])]
1669                             else:
1670                                 representation_ms_info['segment_urls'] = []
1671                                 segment_time = 0
1672
1673                                 def add_segment_url():
1674                                     representation_ms_info['segment_urls'].append(
1675                                         media_template % {
1676                                             'Time': segment_time,
1677                                             'Bandwidth': representation_attrib.get('bandwidth'),
1678                                         }
1679                                     )
1680
1681                                 for num, s in enumerate(representation_ms_info['s']):
1682                                     segment_time = s.get('t') or segment_time
1683                                     add_segment_url()
1684                                     for r in range(s.get('r', 0)):
1685                                         segment_time += s['d']
1686                                         add_segment_url()
1687                                     segment_time += s['d']
1688                         if 'segment_urls' in representation_ms_info:
1689                             f.update({
1690                                 'segment_urls': representation_ms_info['segment_urls'],
1691                                 'protocol': 'http_dash_segments',
1692                             })
1693                             if 'initialization_url' in representation_ms_info:
1694                                 initialization_url = representation_ms_info['initialization_url'].replace('$RepresentationID$', representation_id)
1695                                 f.update({
1696                                     'initialization_url': initialization_url,
1697                                 })
1698                                 if not f.get('url'):
1699                                     f['url'] = initialization_url
1700                         try:
1701                             existing_format = next(
1702                                 fo for fo in formats
1703                                 if fo['format_id'] == representation_id)
1704                         except StopIteration:
1705                             full_info = formats_dict.get(representation_id, {}).copy()
1706                             full_info.update(f)
1707                             formats.append(full_info)
1708                         else:
1709                             existing_format.update(f)
1710                     else:
1711                         self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
1712         return formats
1713
1714     def _parse_html5_media_entries(self, base_url, webpage, video_id, m3u8_id=None, m3u8_entry_protocol='m3u8'):
1715         def absolute_url(video_url):
1716             return compat_urlparse.urljoin(base_url, video_url)
1717
1718         def parse_content_type(content_type):
1719             if not content_type:
1720                 return {}
1721             ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
1722             if ctr:
1723                 mimetype, codecs = ctr.groups()
1724                 f = parse_codecs(codecs)
1725                 f['ext'] = mimetype2ext(mimetype)
1726                 return f
1727             return {}
1728
1729         def _media_formats(src, cur_media_type):
1730             full_url = absolute_url(src)
1731             if determine_ext(full_url) == 'm3u8':
1732                 is_plain_url = False
1733                 formats = self._extract_m3u8_formats(
1734                     full_url, video_id, ext='mp4',
1735                     entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id)
1736             else:
1737                 is_plain_url = True
1738                 formats = [{
1739                     'url': full_url,
1740                     'vcodec': 'none' if cur_media_type == 'audio' else None,
1741                 }]
1742             return is_plain_url, formats
1743
1744         entries = []
1745         for media_tag, media_type, media_content in re.findall(r'(?s)(<(?P<tag>video|audio)[^>]*>)(.*?)</(?P=tag)>', webpage):
1746             media_info = {
1747                 'formats': [],
1748                 'subtitles': {},
1749             }
1750             media_attributes = extract_attributes(media_tag)
1751             src = media_attributes.get('src')
1752             if src:
1753                 _, formats = _media_formats(src, media_type)
1754                 media_info['formats'].extend(formats)
1755             media_info['thumbnail'] = media_attributes.get('poster')
1756             if media_content:
1757                 for source_tag in re.findall(r'<source[^>]+>', media_content):
1758                     source_attributes = extract_attributes(source_tag)
1759                     src = source_attributes.get('src')
1760                     if not src:
1761                         continue
1762                     is_plain_url, formats = _media_formats(src, media_type)
1763                     if is_plain_url:
1764                         f = parse_content_type(source_attributes.get('type'))
1765                         f.update(formats[0])
1766                         media_info['formats'].append(f)
1767                     else:
1768                         media_info['formats'].extend(formats)
1769                 for track_tag in re.findall(r'<track[^>]+>', media_content):
1770                     track_attributes = extract_attributes(track_tag)
1771                     kind = track_attributes.get('kind')
1772                     if not kind or kind == 'subtitles':
1773                         src = track_attributes.get('src')
1774                         if not src:
1775                             continue
1776                         lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
1777                         media_info['subtitles'].setdefault(lang, []).append({
1778                             'url': absolute_url(src),
1779                         })
1780             if media_info['formats']:
1781                 entries.append(media_info)
1782         return entries
1783
1784     def _extract_akamai_formats(self, manifest_url, video_id):
1785         formats = []
1786         f4m_url = re.sub(r'(https?://.+?)/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
1787         formats.extend(self._extract_f4m_formats(
1788             update_url_query(f4m_url, {'hdcore': '3.7.0'}),
1789             video_id, f4m_id='hds', fatal=False))
1790         m3u8_url = re.sub(r'(https?://.+?)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
1791         formats.extend(self._extract_m3u8_formats(
1792             m3u8_url, video_id, 'mp4', 'm3u8_native',
1793             m3u8_id='hls', fatal=False))
1794         return formats
1795
1796     def _live_title(self, name):
1797         """ Generate the title for a live video """
1798         now = datetime.datetime.now()
1799         now_str = now.strftime('%Y-%m-%d %H:%M')
1800         return name + ' ' + now_str
1801
1802     def _int(self, v, name, fatal=False, **kwargs):
1803         res = int_or_none(v, **kwargs)
1804         if 'get_attr' in kwargs:
1805             print(getattr(v, kwargs['get_attr']))
1806         if res is None:
1807             msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
1808             if fatal:
1809                 raise ExtractorError(msg)
1810             else:
1811                 self._downloader.report_warning(msg)
1812         return res
1813
1814     def _float(self, v, name, fatal=False, **kwargs):
1815         res = float_or_none(v, **kwargs)
1816         if res is None:
1817             msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
1818             if fatal:
1819                 raise ExtractorError(msg)
1820             else:
1821                 self._downloader.report_warning(msg)
1822         return res
1823
1824     def _set_cookie(self, domain, name, value, expire_time=None):
1825         cookie = compat_cookiejar.Cookie(
1826             0, name, value, None, None, domain, None,
1827             None, '/', True, False, expire_time, '', None, None, None)
1828         self._downloader.cookiejar.set_cookie(cookie)
1829
1830     def _get_cookies(self, url):
1831         """ Return a compat_cookies.SimpleCookie with the cookies for the url """
1832         req = sanitized_Request(url)
1833         self._downloader.cookiejar.add_cookie_header(req)
1834         return compat_cookies.SimpleCookie(req.get_header('Cookie'))
1835
1836     def get_testcases(self, include_onlymatching=False):
1837         t = getattr(self, '_TEST', None)
1838         if t:
1839             assert not hasattr(self, '_TESTS'), \
1840                 '%s has _TEST and _TESTS' % type(self).__name__
1841             tests = [t]
1842         else:
1843             tests = getattr(self, '_TESTS', [])
1844         for t in tests:
1845             if not include_onlymatching and t.get('only_matching', False):
1846                 continue
1847             t['name'] = type(self).__name__[:-len('IE')]
1848             yield t
1849
1850     def is_suitable(self, age_limit):
1851         """ Test whether the extractor is generally suitable for the given
1852         age limit (i.e. pornographic sites are not, all others usually are) """
1853
1854         any_restricted = False
1855         for tc in self.get_testcases(include_onlymatching=False):
1856             if tc.get('playlist', []):
1857                 tc = tc['playlist'][0]
1858             is_restricted = age_restricted(
1859                 tc.get('info_dict', {}).get('age_limit'), age_limit)
1860             if not is_restricted:
1861                 return True
1862             any_restricted = any_restricted or is_restricted
1863         return not any_restricted
1864
1865     def extract_subtitles(self, *args, **kwargs):
1866         if (self._downloader.params.get('writesubtitles', False) or
1867                 self._downloader.params.get('listsubtitles')):
1868             return self._get_subtitles(*args, **kwargs)
1869         return {}
1870
1871     def _get_subtitles(self, *args, **kwargs):
1872         raise NotImplementedError('This method must be implemented by subclasses')
1873
1874     @staticmethod
1875     def _merge_subtitle_items(subtitle_list1, subtitle_list2):
1876         """ Merge subtitle items for one language. Items with duplicated URLs
1877         will be dropped. """
1878         list1_urls = set([item['url'] for item in subtitle_list1])
1879         ret = list(subtitle_list1)
1880         ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
1881         return ret
1882
1883     @classmethod
1884     def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2):
1885         """ Merge two subtitle dictionaries, language by language. """
1886         ret = dict(subtitle_dict1)
1887         for lang in subtitle_dict2:
1888             ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang])
1889         return ret
1890
1891     def extract_automatic_captions(self, *args, **kwargs):
1892         if (self._downloader.params.get('writeautomaticsub', False) or
1893                 self._downloader.params.get('listsubtitles')):
1894             return self._get_automatic_captions(*args, **kwargs)
1895         return {}
1896
1897     def _get_automatic_captions(self, *args, **kwargs):
1898         raise NotImplementedError('This method must be implemented by subclasses')
1899
1900     def mark_watched(self, *args, **kwargs):
1901         if (self._downloader.params.get('mark_watched', False) and
1902                 (self._get_login_info()[0] is not None or
1903                     self._downloader.params.get('cookiefile') is not None)):
1904             self._mark_watched(*args, **kwargs)
1905
1906     def _mark_watched(self, *args, **kwargs):
1907         raise NotImplementedError('This method must be implemented by subclasses')
1908
1909     def geo_verification_headers(self):
1910         headers = {}
1911         geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
1912         if geo_verification_proxy:
1913             headers['Ytdl-request-proxy'] = geo_verification_proxy
1914         return headers
1915
1916
1917 class SearchInfoExtractor(InfoExtractor):
1918     """
1919     Base class for paged search queries extractors.
1920     They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
1921     Instances should define _SEARCH_KEY and _MAX_RESULTS.
1922     """
1923
1924     @classmethod
1925     def _make_valid_url(cls):
1926         return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
1927
1928     @classmethod
1929     def suitable(cls, url):
1930         return re.match(cls._make_valid_url(), url) is not None
1931
1932     def _real_extract(self, query):
1933         mobj = re.match(self._make_valid_url(), query)
1934         if mobj is None:
1935             raise ExtractorError('Invalid search query "%s"' % query)
1936
1937         prefix = mobj.group('prefix')
1938         query = mobj.group('query')
1939         if prefix == '':
1940             return self._get_n_results(query, 1)
1941         elif prefix == 'all':
1942             return self._get_n_results(query, self._MAX_RESULTS)
1943         else:
1944             n = int(prefix)
1945             if n <= 0:
1946                 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
1947             elif n > self._MAX_RESULTS:
1948                 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
1949                 n = self._MAX_RESULTS
1950             return self._get_n_results(query, n)
1951
1952     def _get_n_results(self, query, n):
1953         """Get a specified number of results for a query"""
1954         raise NotImplementedError('This method must be implemented by subclasses')
1955
1956     @property
1957     def SEARCH_KEY(self):
1958         return self._SEARCH_KEY