[extractor/common] Add support for movies in _json_ld
[youtube-dl] / youtube_dl / extractor / common.py
1 # coding: utf-8
2 from __future__ import unicode_literals
3
4 import base64
5 import datetime
6 import hashlib
7 import json
8 import netrc
9 import os
10 import random
11 import re
12 import socket
13 import sys
14 import time
15 import math
16
17 from ..compat import (
18     compat_cookiejar,
19     compat_cookies,
20     compat_etree_fromstring,
21     compat_getpass,
22     compat_integer_types,
23     compat_http_client,
24     compat_os_name,
25     compat_str,
26     compat_urllib_error,
27     compat_urllib_parse_unquote,
28     compat_urllib_parse_urlencode,
29     compat_urllib_request,
30     compat_urlparse,
31     compat_xml_parse_error,
32 )
33 from ..downloader.f4m import (
34     get_base_url,
35     remove_encrypted_media,
36 )
37 from ..utils import (
38     NO_DEFAULT,
39     age_restricted,
40     base_url,
41     bug_reports_message,
42     clean_html,
43     compiled_regex_type,
44     determine_ext,
45     determine_protocol,
46     error_to_compat_str,
47     ExtractorError,
48     extract_attributes,
49     fix_xml_ampersands,
50     float_or_none,
51     GeoRestrictedError,
52     GeoUtils,
53     int_or_none,
54     js_to_json,
55     JSON_LD_RE,
56     mimetype2ext,
57     orderedSet,
58     parse_codecs,
59     parse_duration,
60     parse_iso8601,
61     parse_m3u8_attributes,
62     RegexNotFoundError,
63     sanitized_Request,
64     sanitize_filename,
65     unescapeHTML,
66     unified_strdate,
67     unified_timestamp,
68     update_Request,
69     update_url_query,
70     urljoin,
71     url_basename,
72     url_or_none,
73     xpath_element,
74     xpath_text,
75     xpath_with_ns,
76 )
77
78
79 class InfoExtractor(object):
80     """Information Extractor class.
81
82     Information extractors are the classes that, given a URL, extract
83     information about the video (or videos) the URL refers to. This
84     information includes the real video URL, the video title, author and
85     others. The information is stored in a dictionary which is then
86     passed to the YoutubeDL. The YoutubeDL processes this
87     information possibly downloading the video to the file system, among
88     other possible outcomes.
89
90     The type field determines the type of the result.
91     By far the most common value (and the default if _type is missing) is
92     "video", which indicates a single video.
93
94     For a video, the dictionaries must include the following fields:
95
96     id:             Video identifier.
97     title:          Video title, unescaped.
98
99     Additionally, it must contain either a formats entry or a url one:
100
101     formats:        A list of dictionaries for each format available, ordered
102                     from worst to best quality.
103
104                     Potential fields:
105                     * url        Mandatory. The URL of the video file
106                     * manifest_url
107                                  The URL of the manifest file in case of
108                                  fragmented media (DASH, hls, hds)
109                     * ext        Will be calculated from URL if missing
110                     * format     A human-readable description of the format
111                                  ("mp4 container with h264/opus").
112                                  Calculated from the format_id, width, height.
113                                  and format_note fields if missing.
114                     * format_id  A short description of the format
115                                  ("mp4_h264_opus" or "19").
116                                 Technically optional, but strongly recommended.
117                     * format_note Additional info about the format
118                                  ("3D" or "DASH video")
119                     * width      Width of the video, if known
120                     * height     Height of the video, if known
121                     * resolution Textual description of width and height
122                     * tbr        Average bitrate of audio and video in KBit/s
123                     * abr        Average audio bitrate in KBit/s
124                     * acodec     Name of the audio codec in use
125                     * asr        Audio sampling rate in Hertz
126                     * vbr        Average video bitrate in KBit/s
127                     * fps        Frame rate
128                     * vcodec     Name of the video codec in use
129                     * container  Name of the container format
130                     * filesize   The number of bytes, if known in advance
131                     * filesize_approx  An estimate for the number of bytes
132                     * player_url SWF Player URL (used for rtmpdump).
133                     * protocol   The protocol that will be used for the actual
134                                  download, lower-case.
135                                  "http", "https", "rtsp", "rtmp", "rtmpe",
136                                  "m3u8", "m3u8_native" or "http_dash_segments".
137                     * fragment_base_url
138                                  Base URL for fragments. Each fragment's path
139                                  value (if present) will be relative to
140                                  this URL.
141                     * fragments  A list of fragments of a fragmented media.
142                                  Each fragment entry must contain either an url
143                                  or a path. If an url is present it should be
144                                  considered by a client. Otherwise both path and
145                                  fragment_base_url must be present. Here is
146                                  the list of all potential fields:
147                                  * "url" - fragment's URL
148                                  * "path" - fragment's path relative to
149                                             fragment_base_url
150                                  * "duration" (optional, int or float)
151                                  * "filesize" (optional, int)
152                     * preference Order number of this format. If this field is
153                                  present and not None, the formats get sorted
154                                  by this field, regardless of all other values.
155                                  -1 for default (order by other properties),
156                                  -2 or smaller for less than default.
157                                  < -1000 to hide the format (if there is
158                                     another one which is strictly better)
159                     * language   Language code, e.g. "de" or "en-US".
160                     * language_preference  Is this in the language mentioned in
161                                  the URL?
162                                  10 if it's what the URL is about,
163                                  -1 for default (don't know),
164                                  -10 otherwise, other values reserved for now.
165                     * quality    Order number of the video quality of this
166                                  format, irrespective of the file format.
167                                  -1 for default (order by other properties),
168                                  -2 or smaller for less than default.
169                     * source_preference  Order number for this video source
170                                   (quality takes higher priority)
171                                  -1 for default (order by other properties),
172                                  -2 or smaller for less than default.
173                     * http_headers  A dictionary of additional HTTP headers
174                                  to add to the request.
175                     * stretched_ratio  If given and not 1, indicates that the
176                                  video's pixels are not square.
177                                  width : height ratio as float.
178                     * no_resume  The server does not support resuming the
179                                  (HTTP or RTMP) download. Boolean.
180                     * downloader_options  A dictionary of downloader options as
181                                  described in FileDownloader
182
183     url:            Final video URL.
184     ext:            Video filename extension.
185     format:         The video format, defaults to ext (used for --get-format)
186     player_url:     SWF Player URL (used for rtmpdump).
187
188     The following fields are optional:
189
190     alt_title:      A secondary title of the video.
191     display_id      An alternative identifier for the video, not necessarily
192                     unique, but available before title. Typically, id is
193                     something like "4234987", title "Dancing naked mole rats",
194                     and display_id "dancing-naked-mole-rats"
195     thumbnails:     A list of dictionaries, with the following entries:
196                         * "id" (optional, string) - Thumbnail format ID
197                         * "url"
198                         * "preference" (optional, int) - quality of the image
199                         * "width" (optional, int)
200                         * "height" (optional, int)
201                         * "resolution" (optional, string "{width}x{height"},
202                                         deprecated)
203                         * "filesize" (optional, int)
204     thumbnail:      Full URL to a video thumbnail image.
205     description:    Full video description.
206     uploader:       Full name of the video uploader.
207     license:        License name the video is licensed under.
208     creator:        The creator of the video.
209     release_date:   The date (YYYYMMDD) when the video was released.
210     timestamp:      UNIX timestamp of the moment the video became available.
211     upload_date:    Video upload date (YYYYMMDD).
212                     If not explicitly set, calculated from timestamp.
213     uploader_id:    Nickname or id of the video uploader.
214     uploader_url:   Full URL to a personal webpage of the video uploader.
215     channel:        Full name of the channel the video is uploaded on.
216                     Note that channel fields may or may not repeat uploader
217                     fields. This depends on a particular extractor.
218     channel_id:     Id of the channel.
219     channel_url:    Full URL to a channel webpage.
220     location:       Physical location where the video was filmed.
221     subtitles:      The available subtitles as a dictionary in the format
222                     {tag: subformats}. "tag" is usually a language code, and
223                     "subformats" is a list sorted from lower to higher
224                     preference, each element is a dictionary with the "ext"
225                     entry and one of:
226                         * "data": The subtitles file contents
227                         * "url": A URL pointing to the subtitles file
228                     "ext" will be calculated from URL if missing
229     automatic_captions: Like 'subtitles', used by the YoutubeIE for
230                     automatically generated captions
231     duration:       Length of the video in seconds, as an integer or float.
232     view_count:     How many users have watched the video on the platform.
233     like_count:     Number of positive ratings of the video
234     dislike_count:  Number of negative ratings of the video
235     repost_count:   Number of reposts of the video
236     average_rating: Average rating give by users, the scale used depends on the webpage
237     comment_count:  Number of comments on the video
238     comments:       A list of comments, each with one or more of the following
239                     properties (all but one of text or html optional):
240                         * "author" - human-readable name of the comment author
241                         * "author_id" - user ID of the comment author
242                         * "id" - Comment ID
243                         * "html" - Comment as HTML
244                         * "text" - Plain text of the comment
245                         * "timestamp" - UNIX timestamp of comment
246                         * "parent" - ID of the comment this one is replying to.
247                                      Set to "root" to indicate that this is a
248                                      comment to the original video.
249     age_limit:      Age restriction for the video, as an integer (years)
250     webpage_url:    The URL to the video webpage, if given to youtube-dl it
251                     should allow to get the same result again. (It will be set
252                     by YoutubeDL if it's missing)
253     categories:     A list of categories that the video falls in, for example
254                     ["Sports", "Berlin"]
255     tags:           A list of tags assigned to the video, e.g. ["sweden", "pop music"]
256     is_live:        True, False, or None (=unknown). Whether this video is a
257                     live stream that goes on instead of a fixed-length video.
258     start_time:     Time in seconds where the reproduction should start, as
259                     specified in the URL.
260     end_time:       Time in seconds where the reproduction should end, as
261                     specified in the URL.
262     chapters:       A list of dictionaries, with the following entries:
263                         * "start_time" - The start time of the chapter in seconds
264                         * "end_time" - The end time of the chapter in seconds
265                         * "title" (optional, string)
266
267     The following fields should only be used when the video belongs to some logical
268     chapter or section:
269
270     chapter:        Name or title of the chapter the video belongs to.
271     chapter_number: Number of the chapter the video belongs to, as an integer.
272     chapter_id:     Id of the chapter the video belongs to, as a unicode string.
273
274     The following fields should only be used when the video is an episode of some
275     series, programme or podcast:
276
277     series:         Title of the series or programme the video episode belongs to.
278     season:         Title of the season the video episode belongs to.
279     season_number:  Number of the season the video episode belongs to, as an integer.
280     season_id:      Id of the season the video episode belongs to, as a unicode string.
281     episode:        Title of the video episode. Unlike mandatory video title field,
282                     this field should denote the exact title of the video episode
283                     without any kind of decoration.
284     episode_number: Number of the video episode within a season, as an integer.
285     episode_id:     Id of the video episode, as a unicode string.
286
287     The following fields should only be used when the media is a track or a part of
288     a music album:
289
290     track:          Title of the track.
291     track_number:   Number of the track within an album or a disc, as an integer.
292     track_id:       Id of the track (useful in case of custom indexing, e.g. 6.iii),
293                     as a unicode string.
294     artist:         Artist(s) of the track.
295     genre:          Genre(s) of the track.
296     album:          Title of the album the track belongs to.
297     album_type:     Type of the album (e.g. "Demo", "Full-length", "Split", "Compilation", etc).
298     album_artist:   List of all artists appeared on the album (e.g.
299                     "Ash Borer / Fell Voices" or "Various Artists", useful for splits
300                     and compilations).
301     disc_number:    Number of the disc or other physical medium the track belongs to,
302                     as an integer.
303     release_year:   Year (YYYY) when the album was released.
304
305     Unless mentioned otherwise, the fields should be Unicode strings.
306
307     Unless mentioned otherwise, None is equivalent to absence of information.
308
309
310     _type "playlist" indicates multiple videos.
311     There must be a key "entries", which is a list, an iterable, or a PagedList
312     object, each element of which is a valid dictionary by this specification.
313
314     Additionally, playlists can have "id", "title", "description", "uploader",
315     "uploader_id", "uploader_url" attributes with the same semantics as videos
316     (see above).
317
318
319     _type "multi_video" indicates that there are multiple videos that
320     form a single show, for examples multiple acts of an opera or TV episode.
321     It must have an entries key like a playlist and contain all the keys
322     required for a video at the same time.
323
324
325     _type "url" indicates that the video must be extracted from another
326     location, possibly by a different extractor. Its only required key is:
327     "url" - the next URL to extract.
328     The key "ie_key" can be set to the class name (minus the trailing "IE",
329     e.g. "Youtube") if the extractor class is known in advance.
330     Additionally, the dictionary may have any properties of the resolved entity
331     known in advance, for example "title" if the title of the referred video is
332     known ahead of time.
333
334
335     _type "url_transparent" entities have the same specification as "url", but
336     indicate that the given additional information is more precise than the one
337     associated with the resolved URL.
338     This is useful when a site employs a video service that hosts the video and
339     its technical metadata, but that video service does not embed a useful
340     title, description etc.
341
342
343     Subclasses of this one should re-define the _real_initialize() and
344     _real_extract() methods and define a _VALID_URL regexp.
345     Probably, they should also be added to the list of extractors.
346
347     _GEO_BYPASS attribute may be set to False in order to disable
348     geo restriction bypass mechanisms for a particular extractor.
349     Though it won't disable explicit geo restriction bypass based on
350     country code provided with geo_bypass_country.
351
352     _GEO_COUNTRIES attribute may contain a list of presumably geo unrestricted
353     countries for this extractor. One of these countries will be used by
354     geo restriction bypass mechanism right away in order to bypass
355     geo restriction, of course, if the mechanism is not disabled.
356
357     _GEO_IP_BLOCKS attribute may contain a list of presumably geo unrestricted
358     IP blocks in CIDR notation for this extractor. One of these IP blocks
359     will be used by geo restriction bypass mechanism similarly
360     to _GEO_COUNTRIES.
361
362     Finally, the _WORKING attribute should be set to False for broken IEs
363     in order to warn the users and skip the tests.
364     """
365
366     _ready = False
367     _downloader = None
368     _x_forwarded_for_ip = None
369     _GEO_BYPASS = True
370     _GEO_COUNTRIES = None
371     _GEO_IP_BLOCKS = None
372     _WORKING = True
373
374     def __init__(self, downloader=None):
375         """Constructor. Receives an optional downloader."""
376         self._ready = False
377         self._x_forwarded_for_ip = None
378         self.set_downloader(downloader)
379
380     @classmethod
381     def suitable(cls, url):
382         """Receives a URL and returns True if suitable for this IE."""
383
384         # This does not use has/getattr intentionally - we want to know whether
385         # we have cached the regexp for *this* class, whereas getattr would also
386         # match the superclass
387         if '_VALID_URL_RE' not in cls.__dict__:
388             cls._VALID_URL_RE = re.compile(cls._VALID_URL)
389         return cls._VALID_URL_RE.match(url) is not None
390
391     @classmethod
392     def _match_id(cls, url):
393         if '_VALID_URL_RE' not in cls.__dict__:
394             cls._VALID_URL_RE = re.compile(cls._VALID_URL)
395         m = cls._VALID_URL_RE.match(url)
396         assert m
397         return compat_str(m.group('id'))
398
399     @classmethod
400     def working(cls):
401         """Getter method for _WORKING."""
402         return cls._WORKING
403
404     def initialize(self):
405         """Initializes an instance (authentication, etc)."""
406         self._initialize_geo_bypass({
407             'countries': self._GEO_COUNTRIES,
408             'ip_blocks': self._GEO_IP_BLOCKS,
409         })
410         if not self._ready:
411             self._real_initialize()
412             self._ready = True
413
414     def _initialize_geo_bypass(self, geo_bypass_context):
415         """
416         Initialize geo restriction bypass mechanism.
417
418         This method is used to initialize geo bypass mechanism based on faking
419         X-Forwarded-For HTTP header. A random country from provided country list
420         is selected and a random IP belonging to this country is generated. This
421         IP will be passed as X-Forwarded-For HTTP header in all subsequent
422         HTTP requests.
423
424         This method will be used for initial geo bypass mechanism initialization
425         during the instance initialization with _GEO_COUNTRIES and
426         _GEO_IP_BLOCKS.
427
428         You may also manually call it from extractor's code if geo bypass
429         information is not available beforehand (e.g. obtained during
430         extraction) or due to some other reason. In this case you should pass
431         this information in geo bypass context passed as first argument. It may
432         contain following fields:
433
434         countries:  List of geo unrestricted countries (similar
435                     to _GEO_COUNTRIES)
436         ip_blocks:  List of geo unrestricted IP blocks in CIDR notation
437                     (similar to _GEO_IP_BLOCKS)
438
439         """
440         if not self._x_forwarded_for_ip:
441
442             # Geo bypass mechanism is explicitly disabled by user
443             if not self._downloader.params.get('geo_bypass', True):
444                 return
445
446             if not geo_bypass_context:
447                 geo_bypass_context = {}
448
449             # Backward compatibility: previously _initialize_geo_bypass
450             # expected a list of countries, some 3rd party code may still use
451             # it this way
452             if isinstance(geo_bypass_context, (list, tuple)):
453                 geo_bypass_context = {
454                     'countries': geo_bypass_context,
455                 }
456
457             # The whole point of geo bypass mechanism is to fake IP
458             # as X-Forwarded-For HTTP header based on some IP block or
459             # country code.
460
461             # Path 1: bypassing based on IP block in CIDR notation
462
463             # Explicit IP block specified by user, use it right away
464             # regardless of whether extractor is geo bypassable or not
465             ip_block = self._downloader.params.get('geo_bypass_ip_block', None)
466
467             # Otherwise use random IP block from geo bypass context but only
468             # if extractor is known as geo bypassable
469             if not ip_block:
470                 ip_blocks = geo_bypass_context.get('ip_blocks')
471                 if self._GEO_BYPASS and ip_blocks:
472                     ip_block = random.choice(ip_blocks)
473
474             if ip_block:
475                 self._x_forwarded_for_ip = GeoUtils.random_ipv4(ip_block)
476                 if self._downloader.params.get('verbose', False):
477                     self._downloader.to_screen(
478                         '[debug] Using fake IP %s as X-Forwarded-For.'
479                         % self._x_forwarded_for_ip)
480                 return
481
482             # Path 2: bypassing based on country code
483
484             # Explicit country code specified by user, use it right away
485             # regardless of whether extractor is geo bypassable or not
486             country = self._downloader.params.get('geo_bypass_country', None)
487
488             # Otherwise use random country code from geo bypass context but
489             # only if extractor is known as geo bypassable
490             if not country:
491                 countries = geo_bypass_context.get('countries')
492                 if self._GEO_BYPASS and countries:
493                     country = random.choice(countries)
494
495             if country:
496                 self._x_forwarded_for_ip = GeoUtils.random_ipv4(country)
497                 if self._downloader.params.get('verbose', False):
498                     self._downloader.to_screen(
499                         '[debug] Using fake IP %s (%s) as X-Forwarded-For.'
500                         % (self._x_forwarded_for_ip, country.upper()))
501
502     def extract(self, url):
503         """Extracts URL information and returns it in list of dicts."""
504         try:
505             for _ in range(2):
506                 try:
507                     self.initialize()
508                     ie_result = self._real_extract(url)
509                     if self._x_forwarded_for_ip:
510                         ie_result['__x_forwarded_for_ip'] = self._x_forwarded_for_ip
511                     return ie_result
512                 except GeoRestrictedError as e:
513                     if self.__maybe_fake_ip_and_retry(e.countries):
514                         continue
515                     raise
516         except ExtractorError:
517             raise
518         except compat_http_client.IncompleteRead as e:
519             raise ExtractorError('A network error has occurred.', cause=e, expected=True)
520         except (KeyError, StopIteration) as e:
521             raise ExtractorError('An extractor error has occurred.', cause=e)
522
523     def __maybe_fake_ip_and_retry(self, countries):
524         if (not self._downloader.params.get('geo_bypass_country', None) and
525                 self._GEO_BYPASS and
526                 self._downloader.params.get('geo_bypass', True) and
527                 not self._x_forwarded_for_ip and
528                 countries):
529             country_code = random.choice(countries)
530             self._x_forwarded_for_ip = GeoUtils.random_ipv4(country_code)
531             if self._x_forwarded_for_ip:
532                 self.report_warning(
533                     'Video is geo restricted. Retrying extraction with fake IP %s (%s) as X-Forwarded-For.'
534                     % (self._x_forwarded_for_ip, country_code.upper()))
535                 return True
536         return False
537
538     def set_downloader(self, downloader):
539         """Sets the downloader for this IE."""
540         self._downloader = downloader
541
542     def _real_initialize(self):
543         """Real initialization process. Redefine in subclasses."""
544         pass
545
546     def _real_extract(self, url):
547         """Real extraction process. Redefine in subclasses."""
548         pass
549
550     @classmethod
551     def ie_key(cls):
552         """A string for getting the InfoExtractor with get_info_extractor"""
553         return compat_str(cls.__name__[:-2])
554
555     @property
556     def IE_NAME(self):
557         return compat_str(type(self).__name__[:-2])
558
559     @staticmethod
560     def __can_accept_status_code(err, expected_status):
561         assert isinstance(err, compat_urllib_error.HTTPError)
562         if expected_status is None:
563             return False
564         if isinstance(expected_status, compat_integer_types):
565             return err.code == expected_status
566         elif isinstance(expected_status, (list, tuple)):
567             return err.code in expected_status
568         elif callable(expected_status):
569             return expected_status(err.code) is True
570         else:
571             assert False
572
573     def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, data=None, headers={}, query={}, expected_status=None):
574         """
575         Return the response handle.
576
577         See _download_webpage docstring for arguments specification.
578         """
579         if note is None:
580             self.report_download_webpage(video_id)
581         elif note is not False:
582             if video_id is None:
583                 self.to_screen('%s' % (note,))
584             else:
585                 self.to_screen('%s: %s' % (video_id, note))
586
587         # Some sites check X-Forwarded-For HTTP header in order to figure out
588         # the origin of the client behind proxy. This allows bypassing geo
589         # restriction by faking this header's value to IP that belongs to some
590         # geo unrestricted country. We will do so once we encounter any
591         # geo restriction error.
592         if self._x_forwarded_for_ip:
593             if 'X-Forwarded-For' not in headers:
594                 headers['X-Forwarded-For'] = self._x_forwarded_for_ip
595
596         if isinstance(url_or_request, compat_urllib_request.Request):
597             url_or_request = update_Request(
598                 url_or_request, data=data, headers=headers, query=query)
599         else:
600             if query:
601                 url_or_request = update_url_query(url_or_request, query)
602             if data is not None or headers:
603                 url_or_request = sanitized_Request(url_or_request, data, headers)
604         try:
605             return self._downloader.urlopen(url_or_request)
606         except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
607             if isinstance(err, compat_urllib_error.HTTPError):
608                 if self.__can_accept_status_code(err, expected_status):
609                     # Retain reference to error to prevent file object from
610                     # being closed before it can be read. Works around the
611                     # effects of <https://bugs.python.org/issue15002>
612                     # introduced in Python 3.4.1.
613                     err.fp._error = err
614                     return err.fp
615
616             if errnote is False:
617                 return False
618             if errnote is None:
619                 errnote = 'Unable to download webpage'
620
621             errmsg = '%s: %s' % (errnote, error_to_compat_str(err))
622             if fatal:
623                 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
624             else:
625                 self._downloader.report_warning(errmsg)
626                 return False
627
628     def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True, encoding=None, data=None, headers={}, query={}, expected_status=None):
629         """
630         Return a tuple (page content as string, URL handle).
631
632         See _download_webpage docstring for arguments specification.
633         """
634         # Strip hashes from the URL (#1038)
635         if isinstance(url_or_request, (compat_str, str)):
636             url_or_request = url_or_request.partition('#')[0]
637
638         urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal, data=data, headers=headers, query=query, expected_status=expected_status)
639         if urlh is False:
640             assert not fatal
641             return False
642         content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding)
643         return (content, urlh)
644
645     @staticmethod
646     def _guess_encoding_from_content(content_type, webpage_bytes):
647         m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
648         if m:
649             encoding = m.group(1)
650         else:
651             m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
652                           webpage_bytes[:1024])
653             if m:
654                 encoding = m.group(1).decode('ascii')
655             elif webpage_bytes.startswith(b'\xff\xfe'):
656                 encoding = 'utf-16'
657             else:
658                 encoding = 'utf-8'
659
660         return encoding
661
662     def __check_blocked(self, content):
663         first_block = content[:512]
664         if ('<title>Access to this site is blocked</title>' in content and
665                 'Websense' in first_block):
666             msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
667             blocked_iframe = self._html_search_regex(
668                 r'<iframe src="([^"]+)"', content,
669                 'Websense information URL', default=None)
670             if blocked_iframe:
671                 msg += ' Visit %s for more details' % blocked_iframe
672             raise ExtractorError(msg, expected=True)
673         if '<title>The URL you requested has been blocked</title>' in first_block:
674             msg = (
675                 'Access to this webpage has been blocked by Indian censorship. '
676                 'Use a VPN or proxy server (with --proxy) to route around it.')
677             block_msg = self._html_search_regex(
678                 r'</h1><p>(.*?)</p>',
679                 content, 'block message', default=None)
680             if block_msg:
681                 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
682             raise ExtractorError(msg, expected=True)
683         if ('<title>TTK :: Доступ к ресурсу ограничен</title>' in content and
684                 'blocklist.rkn.gov.ru' in content):
685             raise ExtractorError(
686                 'Access to this webpage has been blocked by decision of the Russian government. '
687                 'Visit http://blocklist.rkn.gov.ru/ for a block reason.',
688                 expected=True)
689
690     def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None):
691         content_type = urlh.headers.get('Content-Type', '')
692         webpage_bytes = urlh.read()
693         if prefix is not None:
694             webpage_bytes = prefix + webpage_bytes
695         if not encoding:
696             encoding = self._guess_encoding_from_content(content_type, webpage_bytes)
697         if self._downloader.params.get('dump_intermediate_pages', False):
698             self.to_screen('Dumping request to ' + urlh.geturl())
699             dump = base64.b64encode(webpage_bytes).decode('ascii')
700             self._downloader.to_screen(dump)
701         if self._downloader.params.get('write_pages', False):
702             basen = '%s_%s' % (video_id, urlh.geturl())
703             if len(basen) > 240:
704                 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
705                 basen = basen[:240 - len(h)] + h
706             raw_filename = basen + '.dump'
707             filename = sanitize_filename(raw_filename, restricted=True)
708             self.to_screen('Saving request to ' + filename)
709             # Working around MAX_PATH limitation on Windows (see
710             # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
711             if compat_os_name == 'nt':
712                 absfilepath = os.path.abspath(filename)
713                 if len(absfilepath) > 259:
714                     filename = '\\\\?\\' + absfilepath
715             with open(filename, 'wb') as outf:
716                 outf.write(webpage_bytes)
717
718         try:
719             content = webpage_bytes.decode(encoding, 'replace')
720         except LookupError:
721             content = webpage_bytes.decode('utf-8', 'replace')
722
723         self.__check_blocked(content)
724
725         return content
726
727     def _download_webpage(
728             self, url_or_request, video_id, note=None, errnote=None,
729             fatal=True, tries=1, timeout=5, encoding=None, data=None,
730             headers={}, query={}, expected_status=None):
731         """
732         Return the data of the page as a string.
733
734         Arguments:
735         url_or_request -- plain text URL as a string or
736             a compat_urllib_request.Requestobject
737         video_id -- Video/playlist/item identifier (string)
738
739         Keyword arguments:
740         note -- note printed before downloading (string)
741         errnote -- note printed in case of an error (string)
742         fatal -- flag denoting whether error should be considered fatal,
743             i.e. whether it should cause ExtractionError to be raised,
744             otherwise a warning will be reported and extraction continued
745         tries -- number of tries
746         timeout -- sleep interval between tries
747         encoding -- encoding for a page content decoding, guessed automatically
748             when not explicitly specified
749         data -- POST data (bytes)
750         headers -- HTTP headers (dict)
751         query -- URL query (dict)
752         expected_status -- allows to accept failed HTTP requests (non 2xx
753             status code) by explicitly specifying a set of accepted status
754             codes. Can be any of the following entities:
755                 - an integer type specifying an exact failed status code to
756                   accept
757                 - a list or a tuple of integer types specifying a list of
758                   failed status codes to accept
759                 - a callable accepting an actual failed status code and
760                   returning True if it should be accepted
761             Note that this argument does not affect success status codes (2xx)
762             which are always accepted.
763         """
764
765         success = False
766         try_count = 0
767         while success is False:
768             try:
769                 res = self._download_webpage_handle(
770                     url_or_request, video_id, note, errnote, fatal,
771                     encoding=encoding, data=data, headers=headers, query=query,
772                     expected_status=expected_status)
773                 success = True
774             except compat_http_client.IncompleteRead as e:
775                 try_count += 1
776                 if try_count >= tries:
777                     raise e
778                 self._sleep(timeout, video_id)
779         if res is False:
780             return res
781         else:
782             content, _ = res
783             return content
784
785     def _download_xml_handle(
786             self, url_or_request, video_id, note='Downloading XML',
787             errnote='Unable to download XML', transform_source=None,
788             fatal=True, encoding=None, data=None, headers={}, query={},
789             expected_status=None):
790         """
791         Return a tuple (xml as an xml.etree.ElementTree.Element, URL handle).
792
793         See _download_webpage docstring for arguments specification.
794         """
795         res = self._download_webpage_handle(
796             url_or_request, video_id, note, errnote, fatal=fatal,
797             encoding=encoding, data=data, headers=headers, query=query,
798             expected_status=expected_status)
799         if res is False:
800             return res
801         xml_string, urlh = res
802         return self._parse_xml(
803             xml_string, video_id, transform_source=transform_source,
804             fatal=fatal), urlh
805
806     def _download_xml(
807             self, url_or_request, video_id,
808             note='Downloading XML', errnote='Unable to download XML',
809             transform_source=None, fatal=True, encoding=None,
810             data=None, headers={}, query={}, expected_status=None):
811         """
812         Return the xml as an xml.etree.ElementTree.Element.
813
814         See _download_webpage docstring for arguments specification.
815         """
816         res = self._download_xml_handle(
817             url_or_request, video_id, note=note, errnote=errnote,
818             transform_source=transform_source, fatal=fatal, encoding=encoding,
819             data=data, headers=headers, query=query,
820             expected_status=expected_status)
821         return res if res is False else res[0]
822
823     def _parse_xml(self, xml_string, video_id, transform_source=None, fatal=True):
824         if transform_source:
825             xml_string = transform_source(xml_string)
826         try:
827             return compat_etree_fromstring(xml_string.encode('utf-8'))
828         except compat_xml_parse_error as ve:
829             errmsg = '%s: Failed to parse XML ' % video_id
830             if fatal:
831                 raise ExtractorError(errmsg, cause=ve)
832             else:
833                 self.report_warning(errmsg + str(ve))
834
835     def _download_json_handle(
836             self, url_or_request, video_id, note='Downloading JSON metadata',
837             errnote='Unable to download JSON metadata', transform_source=None,
838             fatal=True, encoding=None, data=None, headers={}, query={},
839             expected_status=None):
840         """
841         Return a tuple (JSON object, URL handle).
842
843         See _download_webpage docstring for arguments specification.
844         """
845         res = self._download_webpage_handle(
846             url_or_request, video_id, note, errnote, fatal=fatal,
847             encoding=encoding, data=data, headers=headers, query=query,
848             expected_status=expected_status)
849         if res is False:
850             return res
851         json_string, urlh = res
852         return self._parse_json(
853             json_string, video_id, transform_source=transform_source,
854             fatal=fatal), urlh
855
856     def _download_json(
857             self, url_or_request, video_id, note='Downloading JSON metadata',
858             errnote='Unable to download JSON metadata', transform_source=None,
859             fatal=True, encoding=None, data=None, headers={}, query={},
860             expected_status=None):
861         """
862         Return the JSON object as a dict.
863
864         See _download_webpage docstring for arguments specification.
865         """
866         res = self._download_json_handle(
867             url_or_request, video_id, note=note, errnote=errnote,
868             transform_source=transform_source, fatal=fatal, encoding=encoding,
869             data=data, headers=headers, query=query,
870             expected_status=expected_status)
871         return res if res is False else res[0]
872
873     def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
874         if transform_source:
875             json_string = transform_source(json_string)
876         try:
877             return json.loads(json_string)
878         except ValueError as ve:
879             errmsg = '%s: Failed to parse JSON ' % video_id
880             if fatal:
881                 raise ExtractorError(errmsg, cause=ve)
882             else:
883                 self.report_warning(errmsg + str(ve))
884
885     def report_warning(self, msg, video_id=None):
886         idstr = '' if video_id is None else '%s: ' % video_id
887         self._downloader.report_warning(
888             '[%s] %s%s' % (self.IE_NAME, idstr, msg))
889
890     def to_screen(self, msg):
891         """Print msg to screen, prefixing it with '[ie_name]'"""
892         self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
893
894     def report_extraction(self, id_or_name):
895         """Report information extraction."""
896         self.to_screen('%s: Extracting information' % id_or_name)
897
898     def report_download_webpage(self, video_id):
899         """Report webpage download."""
900         self.to_screen('%s: Downloading webpage' % video_id)
901
902     def report_age_confirmation(self):
903         """Report attempt to confirm age."""
904         self.to_screen('Confirming age')
905
906     def report_login(self):
907         """Report attempt to log in."""
908         self.to_screen('Logging in')
909
910     @staticmethod
911     def raise_login_required(msg='This video is only available for registered users'):
912         raise ExtractorError(
913             '%s. Use --username and --password or --netrc to provide account credentials.' % msg,
914             expected=True)
915
916     @staticmethod
917     def raise_geo_restricted(msg='This video is not available from your location due to geo restriction', countries=None):
918         raise GeoRestrictedError(msg, countries=countries)
919
920     # Methods for following #608
921     @staticmethod
922     def url_result(url, ie=None, video_id=None, video_title=None):
923         """Returns a URL that points to a page that should be processed"""
924         # TODO: ie should be the class used for getting the info
925         video_info = {'_type': 'url',
926                       'url': url,
927                       'ie_key': ie}
928         if video_id is not None:
929             video_info['id'] = video_id
930         if video_title is not None:
931             video_info['title'] = video_title
932         return video_info
933
934     def playlist_from_matches(self, matches, playlist_id=None, playlist_title=None, getter=None, ie=None):
935         urls = orderedSet(
936             self.url_result(self._proto_relative_url(getter(m) if getter else m), ie)
937             for m in matches)
938         return self.playlist_result(
939             urls, playlist_id=playlist_id, playlist_title=playlist_title)
940
941     @staticmethod
942     def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None):
943         """Returns a playlist"""
944         video_info = {'_type': 'playlist',
945                       'entries': entries}
946         if playlist_id:
947             video_info['id'] = playlist_id
948         if playlist_title:
949             video_info['title'] = playlist_title
950         if playlist_description:
951             video_info['description'] = playlist_description
952         return video_info
953
954     def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
955         """
956         Perform a regex search on the given string, using a single or a list of
957         patterns returning the first matching group.
958         In case of failure return a default value or raise a WARNING or a
959         RegexNotFoundError, depending on fatal, specifying the field name.
960         """
961         if isinstance(pattern, (str, compat_str, compiled_regex_type)):
962             mobj = re.search(pattern, string, flags)
963         else:
964             for p in pattern:
965                 mobj = re.search(p, string, flags)
966                 if mobj:
967                     break
968
969         if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
970             _name = '\033[0;34m%s\033[0m' % name
971         else:
972             _name = name
973
974         if mobj:
975             if group is None:
976                 # return the first matching group
977                 return next(g for g in mobj.groups() if g is not None)
978             else:
979                 return mobj.group(group)
980         elif default is not NO_DEFAULT:
981             return default
982         elif fatal:
983             raise RegexNotFoundError('Unable to extract %s' % _name)
984         else:
985             self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message())
986             return None
987
988     def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
989         """
990         Like _search_regex, but strips HTML tags and unescapes entities.
991         """
992         res = self._search_regex(pattern, string, name, default, fatal, flags, group)
993         if res:
994             return clean_html(res).strip()
995         else:
996             return res
997
998     def _get_netrc_login_info(self, netrc_machine=None):
999         username = None
1000         password = None
1001         netrc_machine = netrc_machine or self._NETRC_MACHINE
1002
1003         if self._downloader.params.get('usenetrc', False):
1004             try:
1005                 info = netrc.netrc().authenticators(netrc_machine)
1006                 if info is not None:
1007                     username = info[0]
1008                     password = info[2]
1009                 else:
1010                     raise netrc.NetrcParseError(
1011                         'No authenticators for %s' % netrc_machine)
1012             except (IOError, netrc.NetrcParseError) as err:
1013                 self._downloader.report_warning(
1014                     'parsing .netrc: %s' % error_to_compat_str(err))
1015
1016         return username, password
1017
1018     def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
1019         """
1020         Get the login info as (username, password)
1021         First look for the manually specified credentials using username_option
1022         and password_option as keys in params dictionary. If no such credentials
1023         available look in the netrc file using the netrc_machine or _NETRC_MACHINE
1024         value.
1025         If there's no info available, return (None, None)
1026         """
1027         if self._downloader is None:
1028             return (None, None)
1029
1030         downloader_params = self._downloader.params
1031
1032         # Attempt to use provided username and password or .netrc data
1033         if downloader_params.get(username_option) is not None:
1034             username = downloader_params[username_option]
1035             password = downloader_params[password_option]
1036         else:
1037             username, password = self._get_netrc_login_info(netrc_machine)
1038
1039         return username, password
1040
1041     def _get_tfa_info(self, note='two-factor verification code'):
1042         """
1043         Get the two-factor authentication info
1044         TODO - asking the user will be required for sms/phone verify
1045         currently just uses the command line option
1046         If there's no info available, return None
1047         """
1048         if self._downloader is None:
1049             return None
1050         downloader_params = self._downloader.params
1051
1052         if downloader_params.get('twofactor') is not None:
1053             return downloader_params['twofactor']
1054
1055         return compat_getpass('Type %s and press [Return]: ' % note)
1056
1057     # Helper functions for extracting OpenGraph info
1058     @staticmethod
1059     def _og_regexes(prop):
1060         content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
1061         property_re = (r'(?:name|property)=(?:\'og:%(prop)s\'|"og:%(prop)s"|\s*og:%(prop)s\b)'
1062                        % {'prop': re.escape(prop)})
1063         template = r'<meta[^>]+?%s[^>]+?%s'
1064         return [
1065             template % (property_re, content_re),
1066             template % (content_re, property_re),
1067         ]
1068
1069     @staticmethod
1070     def _meta_regex(prop):
1071         return r'''(?isx)<meta
1072                     (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
1073                     [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
1074
1075     def _og_search_property(self, prop, html, name=None, **kargs):
1076         if not isinstance(prop, (list, tuple)):
1077             prop = [prop]
1078         if name is None:
1079             name = 'OpenGraph %s' % prop[0]
1080         og_regexes = []
1081         for p in prop:
1082             og_regexes.extend(self._og_regexes(p))
1083         escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
1084         if escaped is None:
1085             return None
1086         return unescapeHTML(escaped)
1087
1088     def _og_search_thumbnail(self, html, **kargs):
1089         return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
1090
1091     def _og_search_description(self, html, **kargs):
1092         return self._og_search_property('description', html, fatal=False, **kargs)
1093
1094     def _og_search_title(self, html, **kargs):
1095         return self._og_search_property('title', html, **kargs)
1096
1097     def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
1098         regexes = self._og_regexes('video') + self._og_regexes('video:url')
1099         if secure:
1100             regexes = self._og_regexes('video:secure_url') + regexes
1101         return self._html_search_regex(regexes, html, name, **kargs)
1102
1103     def _og_search_url(self, html, **kargs):
1104         return self._og_search_property('url', html, **kargs)
1105
1106     def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
1107         if not isinstance(name, (list, tuple)):
1108             name = [name]
1109         if display_name is None:
1110             display_name = name[0]
1111         return self._html_search_regex(
1112             [self._meta_regex(n) for n in name],
1113             html, display_name, fatal=fatal, group='content', **kwargs)
1114
1115     def _dc_search_uploader(self, html):
1116         return self._html_search_meta('dc.creator', html, 'uploader')
1117
1118     def _rta_search(self, html):
1119         # See http://www.rtalabel.org/index.php?content=howtofaq#single
1120         if re.search(r'(?ix)<meta\s+name="rating"\s+'
1121                      r'     content="RTA-5042-1996-1400-1577-RTA"',
1122                      html):
1123             return 18
1124         return 0
1125
1126     def _media_rating_search(self, html):
1127         # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
1128         rating = self._html_search_meta('rating', html)
1129
1130         if not rating:
1131             return None
1132
1133         RATING_TABLE = {
1134             'safe for kids': 0,
1135             'general': 8,
1136             '14 years': 14,
1137             'mature': 17,
1138             'restricted': 19,
1139         }
1140         return RATING_TABLE.get(rating.lower())
1141
1142     def _family_friendly_search(self, html):
1143         # See http://schema.org/VideoObject
1144         family_friendly = self._html_search_meta(
1145             'isFamilyFriendly', html, default=None)
1146
1147         if not family_friendly:
1148             return None
1149
1150         RATING_TABLE = {
1151             '1': 0,
1152             'true': 0,
1153             '0': 18,
1154             'false': 18,
1155         }
1156         return RATING_TABLE.get(family_friendly.lower())
1157
1158     def _twitter_search_player(self, html):
1159         return self._html_search_meta('twitter:player', html,
1160                                       'twitter card player')
1161
1162     def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
1163         json_ld = self._search_regex(
1164             JSON_LD_RE, html, 'JSON-LD', group='json_ld', **kwargs)
1165         default = kwargs.get('default', NO_DEFAULT)
1166         if not json_ld:
1167             return default if default is not NO_DEFAULT else {}
1168         # JSON-LD may be malformed and thus `fatal` should be respected.
1169         # At the same time `default` may be passed that assumes `fatal=False`
1170         # for _search_regex. Let's simulate the same behavior here as well.
1171         fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
1172         return self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
1173
1174     def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
1175         if isinstance(json_ld, compat_str):
1176             json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
1177         if not json_ld:
1178             return {}
1179         info = {}
1180         if not isinstance(json_ld, (list, tuple, dict)):
1181             return info
1182         if isinstance(json_ld, dict):
1183             json_ld = [json_ld]
1184
1185         INTERACTION_TYPE_MAP = {
1186             'CommentAction': 'comment',
1187             'AgreeAction': 'like',
1188             'DisagreeAction': 'dislike',
1189             'LikeAction': 'like',
1190             'DislikeAction': 'dislike',
1191             'ListenAction': 'view',
1192             'WatchAction': 'view',
1193             'ViewAction': 'view',
1194         }
1195
1196         def extract_interaction_statistic(e):
1197             interaction_statistic = e.get('interactionStatistic')
1198             if not isinstance(interaction_statistic, list):
1199                 return
1200             for is_e in interaction_statistic:
1201                 if not isinstance(is_e, dict):
1202                     continue
1203                 if is_e.get('@type') != 'InteractionCounter':
1204                     continue
1205                 interaction_type = is_e.get('interactionType')
1206                 if not isinstance(interaction_type, compat_str):
1207                     continue
1208                 interaction_count = int_or_none(is_e.get('userInteractionCount'))
1209                 if interaction_count is None:
1210                     continue
1211                 count_kind = INTERACTION_TYPE_MAP.get(interaction_type.split('/')[-1])
1212                 if not count_kind:
1213                     continue
1214                 count_key = '%s_count' % count_kind
1215                 if info.get(count_key) is not None:
1216                     continue
1217                 info[count_key] = interaction_count
1218
1219         def extract_video_object(e):
1220             assert e['@type'] == 'VideoObject'
1221             info.update({
1222                 'url': url_or_none(e.get('contentUrl')),
1223                 'title': unescapeHTML(e.get('name')),
1224                 'description': unescapeHTML(e.get('description')),
1225                 'thumbnail': url_or_none(e.get('thumbnailUrl') or e.get('thumbnailURL')),
1226                 'duration': parse_duration(e.get('duration')),
1227                 'timestamp': unified_timestamp(e.get('uploadDate')),
1228                 'filesize': float_or_none(e.get('contentSize')),
1229                 'tbr': int_or_none(e.get('bitrate')),
1230                 'width': int_or_none(e.get('width')),
1231                 'height': int_or_none(e.get('height')),
1232                 'view_count': int_or_none(e.get('interactionCount')),
1233             })
1234             extract_interaction_statistic(e)
1235
1236         for e in json_ld:
1237             if isinstance(e.get('@context'), compat_str) and re.match(r'^https?://schema.org/?$', e.get('@context')):
1238                 item_type = e.get('@type')
1239                 if expected_type is not None and expected_type != item_type:
1240                     return info
1241                 if item_type in ('TVEpisode', 'Episode'):
1242                     info.update({
1243                         'episode': unescapeHTML(e.get('name')),
1244                         'episode_number': int_or_none(e.get('episodeNumber')),
1245                         'description': unescapeHTML(e.get('description')),
1246                     })
1247                     part_of_season = e.get('partOfSeason')
1248                     if isinstance(part_of_season, dict) and part_of_season.get('@type') in ('TVSeason', 'Season', 'CreativeWorkSeason'):
1249                         info['season_number'] = int_or_none(part_of_season.get('seasonNumber'))
1250                     part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
1251                     if isinstance(part_of_series, dict) and part_of_series.get('@type') in ('TVSeries', 'Series', 'CreativeWorkSeries'):
1252                         info['series'] = unescapeHTML(part_of_series.get('name'))
1253                 elif item_type == 'Movie':
1254                     info.update({
1255                         'title': unescapeHTML(e.get('name')),
1256                         'description': unescapeHTML(e.get('description')),
1257                         'duration': parse_duration(e.get('duration')),
1258                         'timestamp': unified_timestamp(e.get('dateCreated')),
1259                     })
1260                 elif item_type in ('Article', 'NewsArticle'):
1261                     info.update({
1262                         'timestamp': parse_iso8601(e.get('datePublished')),
1263                         'title': unescapeHTML(e.get('headline')),
1264                         'description': unescapeHTML(e.get('articleBody')),
1265                     })
1266                 elif item_type == 'VideoObject':
1267                     extract_video_object(e)
1268                     continue
1269                 video = e.get('video')
1270                 if isinstance(video, dict) and video.get('@type') == 'VideoObject':
1271                     extract_video_object(video)
1272                 break
1273         return dict((k, v) for k, v in info.items() if v is not None)
1274
1275     @staticmethod
1276     def _hidden_inputs(html):
1277         html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
1278         hidden_inputs = {}
1279         for input in re.findall(r'(?i)(<input[^>]+>)', html):
1280             attrs = extract_attributes(input)
1281             if not input:
1282                 continue
1283             if attrs.get('type') not in ('hidden', 'submit'):
1284                 continue
1285             name = attrs.get('name') or attrs.get('id')
1286             value = attrs.get('value')
1287             if name and value is not None:
1288                 hidden_inputs[name] = value
1289         return hidden_inputs
1290
1291     def _form_hidden_inputs(self, form_id, html):
1292         form = self._search_regex(
1293             r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
1294             html, '%s form' % form_id, group='form')
1295         return self._hidden_inputs(form)
1296
1297     def _sort_formats(self, formats, field_preference=None):
1298         if not formats:
1299             raise ExtractorError('No video formats found')
1300
1301         for f in formats:
1302             # Automatically determine tbr when missing based on abr and vbr (improves
1303             # formats sorting in some cases)
1304             if 'tbr' not in f and f.get('abr') is not None and f.get('vbr') is not None:
1305                 f['tbr'] = f['abr'] + f['vbr']
1306
1307         def _formats_key(f):
1308             # TODO remove the following workaround
1309             from ..utils import determine_ext
1310             if not f.get('ext') and 'url' in f:
1311                 f['ext'] = determine_ext(f['url'])
1312
1313             if isinstance(field_preference, (list, tuple)):
1314                 return tuple(
1315                     f.get(field)
1316                     if f.get(field) is not None
1317                     else ('' if field == 'format_id' else -1)
1318                     for field in field_preference)
1319
1320             preference = f.get('preference')
1321             if preference is None:
1322                 preference = 0
1323                 if f.get('ext') in ['f4f', 'f4m']:  # Not yet supported
1324                     preference -= 0.5
1325
1326             protocol = f.get('protocol') or determine_protocol(f)
1327             proto_preference = 0 if protocol in ['http', 'https'] else (-0.5 if protocol == 'rtsp' else -0.1)
1328
1329             if f.get('vcodec') == 'none':  # audio only
1330                 preference -= 50
1331                 if self._downloader.params.get('prefer_free_formats'):
1332                     ORDER = ['aac', 'mp3', 'm4a', 'webm', 'ogg', 'opus']
1333                 else:
1334                     ORDER = ['webm', 'opus', 'ogg', 'mp3', 'aac', 'm4a']
1335                 ext_preference = 0
1336                 try:
1337                     audio_ext_preference = ORDER.index(f['ext'])
1338                 except ValueError:
1339                     audio_ext_preference = -1
1340             else:
1341                 if f.get('acodec') == 'none':  # video only
1342                     preference -= 40
1343                 if self._downloader.params.get('prefer_free_formats'):
1344                     ORDER = ['flv', 'mp4', 'webm']
1345                 else:
1346                     ORDER = ['webm', 'flv', 'mp4']
1347                 try:
1348                     ext_preference = ORDER.index(f['ext'])
1349                 except ValueError:
1350                     ext_preference = -1
1351                 audio_ext_preference = 0
1352
1353             return (
1354                 preference,
1355                 f.get('language_preference') if f.get('language_preference') is not None else -1,
1356                 f.get('quality') if f.get('quality') is not None else -1,
1357                 f.get('tbr') if f.get('tbr') is not None else -1,
1358                 f.get('filesize') if f.get('filesize') is not None else -1,
1359                 f.get('vbr') if f.get('vbr') is not None else -1,
1360                 f.get('height') if f.get('height') is not None else -1,
1361                 f.get('width') if f.get('width') is not None else -1,
1362                 proto_preference,
1363                 ext_preference,
1364                 f.get('abr') if f.get('abr') is not None else -1,
1365                 audio_ext_preference,
1366                 f.get('fps') if f.get('fps') is not None else -1,
1367                 f.get('filesize_approx') if f.get('filesize_approx') is not None else -1,
1368                 f.get('source_preference') if f.get('source_preference') is not None else -1,
1369                 f.get('format_id') if f.get('format_id') is not None else '',
1370             )
1371         formats.sort(key=_formats_key)
1372
1373     def _check_formats(self, formats, video_id):
1374         if formats:
1375             formats[:] = filter(
1376                 lambda f: self._is_valid_url(
1377                     f['url'], video_id,
1378                     item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
1379                 formats)
1380
1381     @staticmethod
1382     def _remove_duplicate_formats(formats):
1383         format_urls = set()
1384         unique_formats = []
1385         for f in formats:
1386             if f['url'] not in format_urls:
1387                 format_urls.add(f['url'])
1388                 unique_formats.append(f)
1389         formats[:] = unique_formats
1390
1391     def _is_valid_url(self, url, video_id, item='video', headers={}):
1392         url = self._proto_relative_url(url, scheme='http:')
1393         # For now assume non HTTP(S) URLs always valid
1394         if not (url.startswith('http://') or url.startswith('https://')):
1395             return True
1396         try:
1397             self._request_webpage(url, video_id, 'Checking %s URL' % item, headers=headers)
1398             return True
1399         except ExtractorError as e:
1400             if isinstance(e.cause, compat_urllib_error.URLError):
1401                 self.to_screen(
1402                     '%s: %s URL is invalid, skipping' % (video_id, item))
1403                 return False
1404             raise
1405
1406     def http_scheme(self):
1407         """ Either "http:" or "https:", depending on the user's preferences """
1408         return (
1409             'http:'
1410             if self._downloader.params.get('prefer_insecure', False)
1411             else 'https:')
1412
1413     def _proto_relative_url(self, url, scheme=None):
1414         if url is None:
1415             return url
1416         if url.startswith('//'):
1417             if scheme is None:
1418                 scheme = self.http_scheme()
1419             return scheme + url
1420         else:
1421             return url
1422
1423     def _sleep(self, timeout, video_id, msg_template=None):
1424         if msg_template is None:
1425             msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
1426         msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1427         self.to_screen(msg)
1428         time.sleep(timeout)
1429
1430     def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None,
1431                              transform_source=lambda s: fix_xml_ampersands(s).strip(),
1432                              fatal=True, m3u8_id=None):
1433         manifest = self._download_xml(
1434             manifest_url, video_id, 'Downloading f4m manifest',
1435             'Unable to download f4m manifest',
1436             # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
1437             # (see https://github.com/rg3/youtube-dl/issues/6215#issuecomment-121704244)
1438             transform_source=transform_source,
1439             fatal=fatal)
1440
1441         if manifest is False:
1442             return []
1443
1444         return self._parse_f4m_formats(
1445             manifest, manifest_url, video_id, preference=preference, f4m_id=f4m_id,
1446             transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
1447
1448     def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, f4m_id=None,
1449                            transform_source=lambda s: fix_xml_ampersands(s).strip(),
1450                            fatal=True, m3u8_id=None):
1451         # currently youtube-dl cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
1452         akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1453         if akamai_pv is not None and ';' in akamai_pv.text:
1454             playerVerificationChallenge = akamai_pv.text.split(';')[0]
1455             if playerVerificationChallenge.strip() != '':
1456                 return []
1457
1458         formats = []
1459         manifest_version = '1.0'
1460         media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
1461         if not media_nodes:
1462             manifest_version = '2.0'
1463             media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
1464         # Remove unsupported DRM protected media from final formats
1465         # rendition (see https://github.com/rg3/youtube-dl/issues/8573).
1466         media_nodes = remove_encrypted_media(media_nodes)
1467         if not media_nodes:
1468             return formats
1469
1470         manifest_base_url = get_base_url(manifest)
1471
1472         bootstrap_info = xpath_element(
1473             manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1474             'bootstrap info', default=None)
1475
1476         vcodec = None
1477         mime_type = xpath_text(
1478             manifest, ['{http://ns.adobe.com/f4m/1.0}mimeType', '{http://ns.adobe.com/f4m/2.0}mimeType'],
1479             'base URL', default=None)
1480         if mime_type and mime_type.startswith('audio/'):
1481             vcodec = 'none'
1482
1483         for i, media_el in enumerate(media_nodes):
1484             tbr = int_or_none(media_el.attrib.get('bitrate'))
1485             width = int_or_none(media_el.attrib.get('width'))
1486             height = int_or_none(media_el.attrib.get('height'))
1487             format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
1488             # If <bootstrapInfo> is present, the specified f4m is a
1489             # stream-level manifest, and only set-level manifests may refer to
1490             # external resources.  See section 11.4 and section 4 of F4M spec
1491             if bootstrap_info is None:
1492                 media_url = None
1493                 # @href is introduced in 2.0, see section 11.6 of F4M spec
1494                 if manifest_version == '2.0':
1495                     media_url = media_el.attrib.get('href')
1496                 if media_url is None:
1497                     media_url = media_el.attrib.get('url')
1498                 if not media_url:
1499                     continue
1500                 manifest_url = (
1501                     media_url if media_url.startswith('http://') or media_url.startswith('https://')
1502                     else ((manifest_base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
1503                 # If media_url is itself a f4m manifest do the recursive extraction
1504                 # since bitrates in parent manifest (this one) and media_url manifest
1505                 # may differ leading to inability to resolve the format by requested
1506                 # bitrate in f4m downloader
1507                 ext = determine_ext(manifest_url)
1508                 if ext == 'f4m':
1509                     f4m_formats = self._extract_f4m_formats(
1510                         manifest_url, video_id, preference=preference, f4m_id=f4m_id,
1511                         transform_source=transform_source, fatal=fatal)
1512                     # Sometimes stream-level manifest contains single media entry that
1513                     # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1514                     # At the same time parent's media entry in set-level manifest may
1515                     # contain it. We will copy it from parent in such cases.
1516                     if len(f4m_formats) == 1:
1517                         f = f4m_formats[0]
1518                         f.update({
1519                             'tbr': f.get('tbr') or tbr,
1520                             'width': f.get('width') or width,
1521                             'height': f.get('height') or height,
1522                             'format_id': f.get('format_id') if not tbr else format_id,
1523                             'vcodec': vcodec,
1524                         })
1525                     formats.extend(f4m_formats)
1526                     continue
1527                 elif ext == 'm3u8':
1528                     formats.extend(self._extract_m3u8_formats(
1529                         manifest_url, video_id, 'mp4', preference=preference,
1530                         m3u8_id=m3u8_id, fatal=fatal))
1531                     continue
1532             formats.append({
1533                 'format_id': format_id,
1534                 'url': manifest_url,
1535                 'manifest_url': manifest_url,
1536                 'ext': 'flv' if bootstrap_info is not None else None,
1537                 'protocol': 'f4m',
1538                 'tbr': tbr,
1539                 'width': width,
1540                 'height': height,
1541                 'vcodec': vcodec,
1542                 'preference': preference,
1543             })
1544         return formats
1545
1546     def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, m3u8_id=None):
1547         return {
1548             'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
1549             'url': m3u8_url,
1550             'ext': ext,
1551             'protocol': 'm3u8',
1552             'preference': preference - 100 if preference else -100,
1553             'resolution': 'multiple',
1554             'format_note': 'Quality selection URL',
1555         }
1556
1557     def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
1558                               entry_protocol='m3u8', preference=None,
1559                               m3u8_id=None, note=None, errnote=None,
1560                               fatal=True, live=False):
1561         res = self._download_webpage_handle(
1562             m3u8_url, video_id,
1563             note=note or 'Downloading m3u8 information',
1564             errnote=errnote or 'Failed to download m3u8 information',
1565             fatal=fatal)
1566
1567         if res is False:
1568             return []
1569
1570         m3u8_doc, urlh = res
1571         m3u8_url = urlh.geturl()
1572
1573         return self._parse_m3u8_formats(
1574             m3u8_doc, m3u8_url, ext=ext, entry_protocol=entry_protocol,
1575             preference=preference, m3u8_id=m3u8_id, live=live)
1576
1577     def _parse_m3u8_formats(self, m3u8_doc, m3u8_url, ext=None,
1578                             entry_protocol='m3u8', preference=None,
1579                             m3u8_id=None, live=False):
1580         if '#EXT-X-FAXS-CM:' in m3u8_doc:  # Adobe Flash Access
1581             return []
1582
1583         if re.search(r'#EXT-X-SESSION-KEY:.*?URI="skd://', m3u8_doc):  # Apple FairPlay
1584             return []
1585
1586         formats = []
1587
1588         format_url = lambda u: (
1589             u
1590             if re.match(r'^https?://', u)
1591             else compat_urlparse.urljoin(m3u8_url, u))
1592
1593         # References:
1594         # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-21
1595         # 2. https://github.com/rg3/youtube-dl/issues/12211
1596
1597         # We should try extracting formats only from master playlists [1, 4.3.4],
1598         # i.e. playlists that describe available qualities. On the other hand
1599         # media playlists [1, 4.3.3] should be returned as is since they contain
1600         # just the media without qualities renditions.
1601         # Fortunately, master playlist can be easily distinguished from media
1602         # playlist based on particular tags availability. As of [1, 4.3.3, 4.3.4]
1603         # master playlist tags MUST NOT appear in a media playist and vice versa.
1604         # As of [1, 4.3.3.1] #EXT-X-TARGETDURATION tag is REQUIRED for every
1605         # media playlist and MUST NOT appear in master playlist thus we can
1606         # clearly detect media playlist with this criterion.
1607
1608         if '#EXT-X-TARGETDURATION' in m3u8_doc:  # media playlist, return as is
1609             return [{
1610                 'url': m3u8_url,
1611                 'format_id': m3u8_id,
1612                 'ext': ext,
1613                 'protocol': entry_protocol,
1614                 'preference': preference,
1615             }]
1616
1617         groups = {}
1618         last_stream_inf = {}
1619
1620         def extract_media(x_media_line):
1621             media = parse_m3u8_attributes(x_media_line)
1622             # As per [1, 4.3.4.1] TYPE, GROUP-ID and NAME are REQUIRED
1623             media_type, group_id, name = media.get('TYPE'), media.get('GROUP-ID'), media.get('NAME')
1624             if not (media_type and group_id and name):
1625                 return
1626             groups.setdefault(group_id, []).append(media)
1627             if media_type not in ('VIDEO', 'AUDIO'):
1628                 return
1629             media_url = media.get('URI')
1630             if media_url:
1631                 format_id = []
1632                 for v in (m3u8_id, group_id, name):
1633                     if v:
1634                         format_id.append(v)
1635                 f = {
1636                     'format_id': '-'.join(format_id),
1637                     'url': format_url(media_url),
1638                     'manifest_url': m3u8_url,
1639                     'language': media.get('LANGUAGE'),
1640                     'ext': ext,
1641                     'protocol': entry_protocol,
1642                     'preference': preference,
1643                 }
1644                 if media_type == 'AUDIO':
1645                     f['vcodec'] = 'none'
1646                 formats.append(f)
1647
1648         def build_stream_name():
1649             # Despite specification does not mention NAME attribute for
1650             # EXT-X-STREAM-INF tag it still sometimes may be present (see [1]
1651             # or vidio test in TestInfoExtractor.test_parse_m3u8_formats)
1652             # 1. http://www.vidio.com/watch/165683-dj_ambred-booyah-live-2015
1653             stream_name = last_stream_inf.get('NAME')
1654             if stream_name:
1655                 return stream_name
1656             # If there is no NAME in EXT-X-STREAM-INF it will be obtained
1657             # from corresponding rendition group
1658             stream_group_id = last_stream_inf.get('VIDEO')
1659             if not stream_group_id:
1660                 return
1661             stream_group = groups.get(stream_group_id)
1662             if not stream_group:
1663                 return stream_group_id
1664             rendition = stream_group[0]
1665             return rendition.get('NAME') or stream_group_id
1666
1667         for line in m3u8_doc.splitlines():
1668             if line.startswith('#EXT-X-STREAM-INF:'):
1669                 last_stream_inf = parse_m3u8_attributes(line)
1670             elif line.startswith('#EXT-X-MEDIA:'):
1671                 extract_media(line)
1672             elif line.startswith('#') or not line.strip():
1673                 continue
1674             else:
1675                 tbr = float_or_none(
1676                     last_stream_inf.get('AVERAGE-BANDWIDTH') or
1677                     last_stream_inf.get('BANDWIDTH'), scale=1000)
1678                 format_id = []
1679                 if m3u8_id:
1680                     format_id.append(m3u8_id)
1681                 stream_name = build_stream_name()
1682                 # Bandwidth of live streams may differ over time thus making
1683                 # format_id unpredictable. So it's better to keep provided
1684                 # format_id intact.
1685                 if not live:
1686                     format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
1687                 manifest_url = format_url(line.strip())
1688                 f = {
1689                     'format_id': '-'.join(format_id),
1690                     'url': manifest_url,
1691                     'manifest_url': m3u8_url,
1692                     'tbr': tbr,
1693                     'ext': ext,
1694                     'fps': float_or_none(last_stream_inf.get('FRAME-RATE')),
1695                     'protocol': entry_protocol,
1696                     'preference': preference,
1697                 }
1698                 resolution = last_stream_inf.get('RESOLUTION')
1699                 if resolution:
1700                     mobj = re.search(r'(?P<width>\d+)[xX](?P<height>\d+)', resolution)
1701                     if mobj:
1702                         f['width'] = int(mobj.group('width'))
1703                         f['height'] = int(mobj.group('height'))
1704                 # Unified Streaming Platform
1705                 mobj = re.search(
1706                     r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
1707                 if mobj:
1708                     abr, vbr = mobj.groups()
1709                     abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
1710                     f.update({
1711                         'vbr': vbr,
1712                         'abr': abr,
1713                     })
1714                 codecs = parse_codecs(last_stream_inf.get('CODECS'))
1715                 f.update(codecs)
1716                 audio_group_id = last_stream_inf.get('AUDIO')
1717                 # As per [1, 4.3.4.1.1] any EXT-X-STREAM-INF tag which
1718                 # references a rendition group MUST have a CODECS attribute.
1719                 # However, this is not always respected, for example, [2]
1720                 # contains EXT-X-STREAM-INF tag which references AUDIO
1721                 # rendition group but does not have CODECS and despite
1722                 # referencing an audio group it represents a complete
1723                 # (with audio and video) format. So, for such cases we will
1724                 # ignore references to rendition groups and treat them
1725                 # as complete formats.
1726                 if audio_group_id and codecs and f.get('vcodec') != 'none':
1727                     audio_group = groups.get(audio_group_id)
1728                     if audio_group and audio_group[0].get('URI'):
1729                         # TODO: update acodec for audio only formats with
1730                         # the same GROUP-ID
1731                         f['acodec'] = 'none'
1732                 formats.append(f)
1733                 last_stream_inf = {}
1734         return formats
1735
1736     @staticmethod
1737     def _xpath_ns(path, namespace=None):
1738         if not namespace:
1739             return path
1740         out = []
1741         for c in path.split('/'):
1742             if not c or c == '.':
1743                 out.append(c)
1744             else:
1745                 out.append('{%s}%s' % (namespace, c))
1746         return '/'.join(out)
1747
1748     def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
1749         smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
1750
1751         if smil is False:
1752             assert not fatal
1753             return []
1754
1755         namespace = self._parse_smil_namespace(smil)
1756
1757         return self._parse_smil_formats(
1758             smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1759
1760     def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
1761         smil = self._download_smil(smil_url, video_id, fatal=fatal)
1762         if smil is False:
1763             return {}
1764         return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
1765
1766     def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
1767         return self._download_xml(
1768             smil_url, video_id, 'Downloading SMIL file',
1769             'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
1770
1771     def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
1772         namespace = self._parse_smil_namespace(smil)
1773
1774         formats = self._parse_smil_formats(
1775             smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1776         subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
1777
1778         video_id = os.path.splitext(url_basename(smil_url))[0]
1779         title = None
1780         description = None
1781         upload_date = None
1782         for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1783             name = meta.attrib.get('name')
1784             content = meta.attrib.get('content')
1785             if not name or not content:
1786                 continue
1787             if not title and name == 'title':
1788                 title = content
1789             elif not description and name in ('description', 'abstract'):
1790                 description = content
1791             elif not upload_date and name == 'date':
1792                 upload_date = unified_strdate(content)
1793
1794         thumbnails = [{
1795             'id': image.get('type'),
1796             'url': image.get('src'),
1797             'width': int_or_none(image.get('width')),
1798             'height': int_or_none(image.get('height')),
1799         } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
1800
1801         return {
1802             'id': video_id,
1803             'title': title or video_id,
1804             'description': description,
1805             'upload_date': upload_date,
1806             'thumbnails': thumbnails,
1807             'formats': formats,
1808             'subtitles': subtitles,
1809         }
1810
1811     def _parse_smil_namespace(self, smil):
1812         return self._search_regex(
1813             r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
1814
1815     def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
1816         base = smil_url
1817         for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1818             b = meta.get('base') or meta.get('httpBase')
1819             if b:
1820                 base = b
1821                 break
1822
1823         formats = []
1824         rtmp_count = 0
1825         http_count = 0
1826         m3u8_count = 0
1827
1828         srcs = []
1829         media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
1830         for medium in media:
1831             src = medium.get('src')
1832             if not src or src in srcs:
1833                 continue
1834             srcs.append(src)
1835
1836             bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
1837             filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
1838             width = int_or_none(medium.get('width'))
1839             height = int_or_none(medium.get('height'))
1840             proto = medium.get('proto')
1841             ext = medium.get('ext')
1842             src_ext = determine_ext(src)
1843             streamer = medium.get('streamer') or base
1844
1845             if proto == 'rtmp' or streamer.startswith('rtmp'):
1846                 rtmp_count += 1
1847                 formats.append({
1848                     'url': streamer,
1849                     'play_path': src,
1850                     'ext': 'flv',
1851                     'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
1852                     'tbr': bitrate,
1853                     'filesize': filesize,
1854                     'width': width,
1855                     'height': height,
1856                 })
1857                 if transform_rtmp_url:
1858                     streamer, src = transform_rtmp_url(streamer, src)
1859                     formats[-1].update({
1860                         'url': streamer,
1861                         'play_path': src,
1862                     })
1863                 continue
1864
1865             src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
1866             src_url = src_url.strip()
1867
1868             if proto == 'm3u8' or src_ext == 'm3u8':
1869                 m3u8_formats = self._extract_m3u8_formats(
1870                     src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
1871                 if len(m3u8_formats) == 1:
1872                     m3u8_count += 1
1873                     m3u8_formats[0].update({
1874                         'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
1875                         'tbr': bitrate,
1876                         'width': width,
1877                         'height': height,
1878                     })
1879                 formats.extend(m3u8_formats)
1880             elif src_ext == 'f4m':
1881                 f4m_url = src_url
1882                 if not f4m_params:
1883                     f4m_params = {
1884                         'hdcore': '3.2.0',
1885                         'plugin': 'flowplayer-3.2.0.1',
1886                     }
1887                 f4m_url += '&' if '?' in f4m_url else '?'
1888                 f4m_url += compat_urllib_parse_urlencode(f4m_params)
1889                 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
1890             elif src_ext == 'mpd':
1891                 formats.extend(self._extract_mpd_formats(
1892                     src_url, video_id, mpd_id='dash', fatal=False))
1893             elif re.search(r'\.ism/[Mm]anifest', src_url):
1894                 formats.extend(self._extract_ism_formats(
1895                     src_url, video_id, ism_id='mss', fatal=False))
1896             elif src_url.startswith('http') and self._is_valid_url(src, video_id):
1897                 http_count += 1
1898                 formats.append({
1899                     'url': src_url,
1900                     'ext': ext or src_ext or 'flv',
1901                     'format_id': 'http-%d' % (bitrate or http_count),
1902                     'tbr': bitrate,
1903                     'filesize': filesize,
1904                     'width': width,
1905                     'height': height,
1906                 })
1907
1908         return formats
1909
1910     def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
1911         urls = []
1912         subtitles = {}
1913         for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
1914             src = textstream.get('src')
1915             if not src or src in urls:
1916                 continue
1917             urls.append(src)
1918             ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
1919             lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
1920             subtitles.setdefault(lang, []).append({
1921                 'url': src,
1922                 'ext': ext,
1923             })
1924         return subtitles
1925
1926     def _extract_xspf_playlist(self, xspf_url, playlist_id, fatal=True):
1927         xspf = self._download_xml(
1928             xspf_url, playlist_id, 'Downloading xpsf playlist',
1929             'Unable to download xspf manifest', fatal=fatal)
1930         if xspf is False:
1931             return []
1932         return self._parse_xspf(
1933             xspf, playlist_id, xspf_url=xspf_url,
1934             xspf_base_url=base_url(xspf_url))
1935
1936     def _parse_xspf(self, xspf_doc, playlist_id, xspf_url=None, xspf_base_url=None):
1937         NS_MAP = {
1938             'xspf': 'http://xspf.org/ns/0/',
1939             's1': 'http://static.streamone.nl/player/ns/0',
1940         }
1941
1942         entries = []
1943         for track in xspf_doc.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
1944             title = xpath_text(
1945                 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
1946             description = xpath_text(
1947                 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
1948             thumbnail = xpath_text(
1949                 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
1950             duration = float_or_none(
1951                 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
1952
1953             formats = []
1954             for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP)):
1955                 format_url = urljoin(xspf_base_url, location.text)
1956                 if not format_url:
1957                     continue
1958                 formats.append({
1959                     'url': format_url,
1960                     'manifest_url': xspf_url,
1961                     'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
1962                     'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
1963                     'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
1964                 })
1965             self._sort_formats(formats)
1966
1967             entries.append({
1968                 'id': playlist_id,
1969                 'title': title,
1970                 'description': description,
1971                 'thumbnail': thumbnail,
1972                 'duration': duration,
1973                 'formats': formats,
1974             })
1975         return entries
1976
1977     def _extract_mpd_formats(self, mpd_url, video_id, mpd_id=None, note=None, errnote=None, fatal=True, formats_dict={}):
1978         res = self._download_xml_handle(
1979             mpd_url, video_id,
1980             note=note or 'Downloading MPD manifest',
1981             errnote=errnote or 'Failed to download MPD manifest',
1982             fatal=fatal)
1983         if res is False:
1984             return []
1985         mpd_doc, urlh = res
1986         mpd_base_url = base_url(urlh.geturl())
1987
1988         return self._parse_mpd_formats(
1989             mpd_doc, mpd_id=mpd_id, mpd_base_url=mpd_base_url,
1990             formats_dict=formats_dict, mpd_url=mpd_url)
1991
1992     def _parse_mpd_formats(self, mpd_doc, mpd_id=None, mpd_base_url='', formats_dict={}, mpd_url=None):
1993         """
1994         Parse formats from MPD manifest.
1995         References:
1996          1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
1997             http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
1998          2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
1999         """
2000         if mpd_doc.get('type') == 'dynamic':
2001             return []
2002
2003         namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
2004
2005         def _add_ns(path):
2006             return self._xpath_ns(path, namespace)
2007
2008         def is_drm_protected(element):
2009             return element.find(_add_ns('ContentProtection')) is not None
2010
2011         def extract_multisegment_info(element, ms_parent_info):
2012             ms_info = ms_parent_info.copy()
2013
2014             # As per [1, 5.3.9.2.2] SegmentList and SegmentTemplate share some
2015             # common attributes and elements.  We will only extract relevant
2016             # for us.
2017             def extract_common(source):
2018                 segment_timeline = source.find(_add_ns('SegmentTimeline'))
2019                 if segment_timeline is not None:
2020                     s_e = segment_timeline.findall(_add_ns('S'))
2021                     if s_e:
2022                         ms_info['total_number'] = 0
2023                         ms_info['s'] = []
2024                         for s in s_e:
2025                             r = int(s.get('r', 0))
2026                             ms_info['total_number'] += 1 + r
2027                             ms_info['s'].append({
2028                                 't': int(s.get('t', 0)),
2029                                 # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
2030                                 'd': int(s.attrib['d']),
2031                                 'r': r,
2032                             })
2033                 start_number = source.get('startNumber')
2034                 if start_number:
2035                     ms_info['start_number'] = int(start_number)
2036                 timescale = source.get('timescale')
2037                 if timescale:
2038                     ms_info['timescale'] = int(timescale)
2039                 segment_duration = source.get('duration')
2040                 if segment_duration:
2041                     ms_info['segment_duration'] = float(segment_duration)
2042
2043             def extract_Initialization(source):
2044                 initialization = source.find(_add_ns('Initialization'))
2045                 if initialization is not None:
2046                     ms_info['initialization_url'] = initialization.attrib['sourceURL']
2047
2048             segment_list = element.find(_add_ns('SegmentList'))
2049             if segment_list is not None:
2050                 extract_common(segment_list)
2051                 extract_Initialization(segment_list)
2052                 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
2053                 if segment_urls_e:
2054                     ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
2055             else:
2056                 segment_template = element.find(_add_ns('SegmentTemplate'))
2057                 if segment_template is not None:
2058                     extract_common(segment_template)
2059                     media = segment_template.get('media')
2060                     if media:
2061                         ms_info['media'] = media
2062                     initialization = segment_template.get('initialization')
2063                     if initialization:
2064                         ms_info['initialization'] = initialization
2065                     else:
2066                         extract_Initialization(segment_template)
2067             return ms_info
2068
2069         mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
2070         formats = []
2071         for period in mpd_doc.findall(_add_ns('Period')):
2072             period_duration = parse_duration(period.get('duration')) or mpd_duration
2073             period_ms_info = extract_multisegment_info(period, {
2074                 'start_number': 1,
2075                 'timescale': 1,
2076             })
2077             for adaptation_set in period.findall(_add_ns('AdaptationSet')):
2078                 if is_drm_protected(adaptation_set):
2079                     continue
2080                 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
2081                 for representation in adaptation_set.findall(_add_ns('Representation')):
2082                     if is_drm_protected(representation):
2083                         continue
2084                     representation_attrib = adaptation_set.attrib.copy()
2085                     representation_attrib.update(representation.attrib)
2086                     # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
2087                     mime_type = representation_attrib['mimeType']
2088                     content_type = mime_type.split('/')[0]
2089                     if content_type == 'text':
2090                         # TODO implement WebVTT downloading
2091                         pass
2092                     elif content_type in ('video', 'audio'):
2093                         base_url = ''
2094                         for element in (representation, adaptation_set, period, mpd_doc):
2095                             base_url_e = element.find(_add_ns('BaseURL'))
2096                             if base_url_e is not None:
2097                                 base_url = base_url_e.text + base_url
2098                                 if re.match(r'^https?://', base_url):
2099                                     break
2100                         if mpd_base_url and not re.match(r'^https?://', base_url):
2101                             if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
2102                                 mpd_base_url += '/'
2103                             base_url = mpd_base_url + base_url
2104                         representation_id = representation_attrib.get('id')
2105                         lang = representation_attrib.get('lang')
2106                         url_el = representation.find(_add_ns('BaseURL'))
2107                         filesize = int_or_none(url_el.attrib.get('{http://youtube.com/yt/2012/10/10}contentLength') if url_el is not None else None)
2108                         bandwidth = int_or_none(representation_attrib.get('bandwidth'))
2109                         f = {
2110                             'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
2111                             'url': base_url,
2112                             'manifest_url': mpd_url,
2113                             'ext': mimetype2ext(mime_type),
2114                             'width': int_or_none(representation_attrib.get('width')),
2115                             'height': int_or_none(representation_attrib.get('height')),
2116                             'tbr': float_or_none(bandwidth, 1000),
2117                             'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
2118                             'fps': int_or_none(representation_attrib.get('frameRate')),
2119                             'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
2120                             'format_note': 'DASH %s' % content_type,
2121                             'filesize': filesize,
2122                             'container': mimetype2ext(mime_type) + '_dash',
2123                         }
2124                         f.update(parse_codecs(representation_attrib.get('codecs')))
2125                         representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
2126
2127                         def prepare_template(template_name, identifiers):
2128                             tmpl = representation_ms_info[template_name]
2129                             # First of, % characters outside $...$ templates
2130                             # must be escaped by doubling for proper processing
2131                             # by % operator string formatting used further (see
2132                             # https://github.com/rg3/youtube-dl/issues/16867).
2133                             t = ''
2134                             in_template = False
2135                             for c in tmpl:
2136                                 t += c
2137                                 if c == '$':
2138                                     in_template = not in_template
2139                                 elif c == '%' and not in_template:
2140                                     t += c
2141                             # Next, $...$ templates are translated to their
2142                             # %(...) counterparts to be used with % operator
2143                             t = t.replace('$RepresentationID$', representation_id)
2144                             t = re.sub(r'\$(%s)\$' % '|'.join(identifiers), r'%(\1)d', t)
2145                             t = re.sub(r'\$(%s)%%([^$]+)\$' % '|'.join(identifiers), r'%(\1)\2', t)
2146                             t.replace('$$', '$')
2147                             return t
2148
2149                         # @initialization is a regular template like @media one
2150                         # so it should be handled just the same way (see
2151                         # https://github.com/rg3/youtube-dl/issues/11605)
2152                         if 'initialization' in representation_ms_info:
2153                             initialization_template = prepare_template(
2154                                 'initialization',
2155                                 # As per [1, 5.3.9.4.2, Table 15, page 54] $Number$ and
2156                                 # $Time$ shall not be included for @initialization thus
2157                                 # only $Bandwidth$ remains
2158                                 ('Bandwidth', ))
2159                             representation_ms_info['initialization_url'] = initialization_template % {
2160                                 'Bandwidth': bandwidth,
2161                             }
2162
2163                         def location_key(location):
2164                             return 'url' if re.match(r'^https?://', location) else 'path'
2165
2166                         if 'segment_urls' not in representation_ms_info and 'media' in representation_ms_info:
2167
2168                             media_template = prepare_template('media', ('Number', 'Bandwidth', 'Time'))
2169                             media_location_key = location_key(media_template)
2170
2171                             # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
2172                             # can't be used at the same time
2173                             if '%(Number' in media_template and 's' not in representation_ms_info:
2174                                 segment_duration = None
2175                                 if 'total_number' not in representation_ms_info and 'segment_duration' in representation_ms_info:
2176                                     segment_duration = float_or_none(representation_ms_info['segment_duration'], representation_ms_info['timescale'])
2177                                     representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
2178                                 representation_ms_info['fragments'] = [{
2179                                     media_location_key: media_template % {
2180                                         'Number': segment_number,
2181                                         'Bandwidth': bandwidth,
2182                                     },
2183                                     'duration': segment_duration,
2184                                 } for segment_number in range(
2185                                     representation_ms_info['start_number'],
2186                                     representation_ms_info['total_number'] + representation_ms_info['start_number'])]
2187                             else:
2188                                 # $Number*$ or $Time$ in media template with S list available
2189                                 # Example $Number*$: http://www.svtplay.se/klipp/9023742/stopptid-om-bjorn-borg
2190                                 # Example $Time$: https://play.arkena.com/embed/avp/v2/player/media/b41dda37-d8e7-4d3f-b1b5-9a9db578bdfe/1/129411
2191                                 representation_ms_info['fragments'] = []
2192                                 segment_time = 0
2193                                 segment_d = None
2194                                 segment_number = representation_ms_info['start_number']
2195
2196                                 def add_segment_url():
2197                                     segment_url = media_template % {
2198                                         'Time': segment_time,
2199                                         'Bandwidth': bandwidth,
2200                                         'Number': segment_number,
2201                                     }
2202                                     representation_ms_info['fragments'].append({
2203                                         media_location_key: segment_url,
2204                                         'duration': float_or_none(segment_d, representation_ms_info['timescale']),
2205                                     })
2206
2207                                 for num, s in enumerate(representation_ms_info['s']):
2208                                     segment_time = s.get('t') or segment_time
2209                                     segment_d = s['d']
2210                                     add_segment_url()
2211                                     segment_number += 1
2212                                     for r in range(s.get('r', 0)):
2213                                         segment_time += segment_d
2214                                         add_segment_url()
2215                                         segment_number += 1
2216                                     segment_time += segment_d
2217                         elif 'segment_urls' in representation_ms_info and 's' in representation_ms_info:
2218                             # No media template
2219                             # Example: https://www.youtube.com/watch?v=iXZV5uAYMJI
2220                             # or any YouTube dashsegments video
2221                             fragments = []
2222                             segment_index = 0
2223                             timescale = representation_ms_info['timescale']
2224                             for s in representation_ms_info['s']:
2225                                 duration = float_or_none(s['d'], timescale)
2226                                 for r in range(s.get('r', 0) + 1):
2227                                     segment_uri = representation_ms_info['segment_urls'][segment_index]
2228                                     fragments.append({
2229                                         location_key(segment_uri): segment_uri,
2230                                         'duration': duration,
2231                                     })
2232                                     segment_index += 1
2233                             representation_ms_info['fragments'] = fragments
2234                         elif 'segment_urls' in representation_ms_info:
2235                             # Segment URLs with no SegmentTimeline
2236                             # Example: https://www.seznam.cz/zpravy/clanek/cesko-zasahne-vitr-o-sile-vichrice-muze-byt-i-zivotu-nebezpecny-39091
2237                             # https://github.com/rg3/youtube-dl/pull/14844
2238                             fragments = []
2239                             segment_duration = float_or_none(
2240                                 representation_ms_info['segment_duration'],
2241                                 representation_ms_info['timescale']) if 'segment_duration' in representation_ms_info else None
2242                             for segment_url in representation_ms_info['segment_urls']:
2243                                 fragment = {
2244                                     location_key(segment_url): segment_url,
2245                                 }
2246                                 if segment_duration:
2247                                     fragment['duration'] = segment_duration
2248                                 fragments.append(fragment)
2249                             representation_ms_info['fragments'] = fragments
2250                         # NB: MPD manifest may contain direct URLs to unfragmented media.
2251                         # No fragments key is present in this case.
2252                         if 'fragments' in representation_ms_info:
2253                             f.update({
2254                                 'fragment_base_url': base_url,
2255                                 'fragments': [],
2256                                 'protocol': 'http_dash_segments',
2257                             })
2258                             if 'initialization_url' in representation_ms_info:
2259                                 initialization_url = representation_ms_info['initialization_url']
2260                                 if not f.get('url'):
2261                                     f['url'] = initialization_url
2262                                 f['fragments'].append({location_key(initialization_url): initialization_url})
2263                             f['fragments'].extend(representation_ms_info['fragments'])
2264                         # According to [1, 5.3.5.2, Table 7, page 35] @id of Representation
2265                         # is not necessarily unique within a Period thus formats with
2266                         # the same `format_id` are quite possible. There are numerous examples
2267                         # of such manifests (see https://github.com/rg3/youtube-dl/issues/15111,
2268                         # https://github.com/rg3/youtube-dl/issues/13919)
2269                         full_info = formats_dict.get(representation_id, {}).copy()
2270                         full_info.update(f)
2271                         formats.append(full_info)
2272                     else:
2273                         self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
2274         return formats
2275
2276     def _extract_ism_formats(self, ism_url, video_id, ism_id=None, note=None, errnote=None, fatal=True):
2277         res = self._download_xml_handle(
2278             ism_url, video_id,
2279             note=note or 'Downloading ISM manifest',
2280             errnote=errnote or 'Failed to download ISM manifest',
2281             fatal=fatal)
2282         if res is False:
2283             return []
2284         ism_doc, urlh = res
2285
2286         return self._parse_ism_formats(ism_doc, urlh.geturl(), ism_id)
2287
2288     def _parse_ism_formats(self, ism_doc, ism_url, ism_id=None):
2289         """
2290         Parse formats from ISM manifest.
2291         References:
2292          1. [MS-SSTR]: Smooth Streaming Protocol,
2293             https://msdn.microsoft.com/en-us/library/ff469518.aspx
2294         """
2295         if ism_doc.get('IsLive') == 'TRUE' or ism_doc.find('Protection') is not None:
2296             return []
2297
2298         duration = int(ism_doc.attrib['Duration'])
2299         timescale = int_or_none(ism_doc.get('TimeScale')) or 10000000
2300
2301         formats = []
2302         for stream in ism_doc.findall('StreamIndex'):
2303             stream_type = stream.get('Type')
2304             if stream_type not in ('video', 'audio'):
2305                 continue
2306             url_pattern = stream.attrib['Url']
2307             stream_timescale = int_or_none(stream.get('TimeScale')) or timescale
2308             stream_name = stream.get('Name')
2309             for track in stream.findall('QualityLevel'):
2310                 fourcc = track.get('FourCC', 'AACL' if track.get('AudioTag') == '255' else None)
2311                 # TODO: add support for WVC1 and WMAP
2312                 if fourcc not in ('H264', 'AVC1', 'AACL'):
2313                     self.report_warning('%s is not a supported codec' % fourcc)
2314                     continue
2315                 tbr = int(track.attrib['Bitrate']) // 1000
2316                 # [1] does not mention Width and Height attributes. However,
2317                 # they're often present while MaxWidth and MaxHeight are
2318                 # missing, so should be used as fallbacks
2319                 width = int_or_none(track.get('MaxWidth') or track.get('Width'))
2320                 height = int_or_none(track.get('MaxHeight') or track.get('Height'))
2321                 sampling_rate = int_or_none(track.get('SamplingRate'))
2322
2323                 track_url_pattern = re.sub(r'{[Bb]itrate}', track.attrib['Bitrate'], url_pattern)
2324                 track_url_pattern = compat_urlparse.urljoin(ism_url, track_url_pattern)
2325
2326                 fragments = []
2327                 fragment_ctx = {
2328                     'time': 0,
2329                 }
2330                 stream_fragments = stream.findall('c')
2331                 for stream_fragment_index, stream_fragment in enumerate(stream_fragments):
2332                     fragment_ctx['time'] = int_or_none(stream_fragment.get('t')) or fragment_ctx['time']
2333                     fragment_repeat = int_or_none(stream_fragment.get('r')) or 1
2334                     fragment_ctx['duration'] = int_or_none(stream_fragment.get('d'))
2335                     if not fragment_ctx['duration']:
2336                         try:
2337                             next_fragment_time = int(stream_fragment[stream_fragment_index + 1].attrib['t'])
2338                         except IndexError:
2339                             next_fragment_time = duration
2340                         fragment_ctx['duration'] = (next_fragment_time - fragment_ctx['time']) / fragment_repeat
2341                     for _ in range(fragment_repeat):
2342                         fragments.append({
2343                             'url': re.sub(r'{start[ _]time}', compat_str(fragment_ctx['time']), track_url_pattern),
2344                             'duration': fragment_ctx['duration'] / stream_timescale,
2345                         })
2346                         fragment_ctx['time'] += fragment_ctx['duration']
2347
2348                 format_id = []
2349                 if ism_id:
2350                     format_id.append(ism_id)
2351                 if stream_name:
2352                     format_id.append(stream_name)
2353                 format_id.append(compat_str(tbr))
2354
2355                 formats.append({
2356                     'format_id': '-'.join(format_id),
2357                     'url': ism_url,
2358                     'manifest_url': ism_url,
2359                     'ext': 'ismv' if stream_type == 'video' else 'isma',
2360                     'width': width,
2361                     'height': height,
2362                     'tbr': tbr,
2363                     'asr': sampling_rate,
2364                     'vcodec': 'none' if stream_type == 'audio' else fourcc,
2365                     'acodec': 'none' if stream_type == 'video' else fourcc,
2366                     'protocol': 'ism',
2367                     'fragments': fragments,
2368                     '_download_params': {
2369                         'duration': duration,
2370                         'timescale': stream_timescale,
2371                         'width': width or 0,
2372                         'height': height or 0,
2373                         'fourcc': fourcc,
2374                         'codec_private_data': track.get('CodecPrivateData'),
2375                         'sampling_rate': sampling_rate,
2376                         'channels': int_or_none(track.get('Channels', 2)),
2377                         'bits_per_sample': int_or_none(track.get('BitsPerSample', 16)),
2378                         'nal_unit_length_field': int_or_none(track.get('NALUnitLengthField', 4)),
2379                     },
2380                 })
2381         return formats
2382
2383     def _parse_html5_media_entries(self, base_url, webpage, video_id, m3u8_id=None, m3u8_entry_protocol='m3u8', mpd_id=None, preference=None):
2384         def absolute_url(item_url):
2385             return urljoin(base_url, item_url)
2386
2387         def parse_content_type(content_type):
2388             if not content_type:
2389                 return {}
2390             ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
2391             if ctr:
2392                 mimetype, codecs = ctr.groups()
2393                 f = parse_codecs(codecs)
2394                 f['ext'] = mimetype2ext(mimetype)
2395                 return f
2396             return {}
2397
2398         def _media_formats(src, cur_media_type, type_info={}):
2399             full_url = absolute_url(src)
2400             ext = type_info.get('ext') or determine_ext(full_url)
2401             if ext == 'm3u8':
2402                 is_plain_url = False
2403                 formats = self._extract_m3u8_formats(
2404                     full_url, video_id, ext='mp4',
2405                     entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id,
2406                     preference=preference, fatal=False)
2407             elif ext == 'mpd':
2408                 is_plain_url = False
2409                 formats = self._extract_mpd_formats(
2410                     full_url, video_id, mpd_id=mpd_id, fatal=False)
2411             else:
2412                 is_plain_url = True
2413                 formats = [{
2414                     'url': full_url,
2415                     'vcodec': 'none' if cur_media_type == 'audio' else None,
2416                 }]
2417             return is_plain_url, formats
2418
2419         entries = []
2420         # amp-video and amp-audio are very similar to their HTML5 counterparts
2421         # so we wll include them right here (see
2422         # https://www.ampproject.org/docs/reference/components/amp-video)
2423         media_tags = [(media_tag, media_type, '')
2424                       for media_tag, media_type
2425                       in re.findall(r'(?s)(<(?:amp-)?(video|audio)[^>]*/>)', webpage)]
2426         media_tags.extend(re.findall(
2427             # We only allow video|audio followed by a whitespace or '>'.
2428             # Allowing more characters may end up in significant slow down (see
2429             # https://github.com/rg3/youtube-dl/issues/11979, example URL:
2430             # http://www.porntrex.com/maps/videositemap.xml).
2431             r'(?s)(<(?P<tag>(?:amp-)?(?:video|audio))(?:\s+[^>]*)?>)(.*?)</(?P=tag)>', webpage))
2432         for media_tag, media_type, media_content in media_tags:
2433             media_info = {
2434                 'formats': [],
2435                 'subtitles': {},
2436             }
2437             media_attributes = extract_attributes(media_tag)
2438             src = media_attributes.get('src')
2439             if src:
2440                 _, formats = _media_formats(src, media_type)
2441                 media_info['formats'].extend(formats)
2442             media_info['thumbnail'] = absolute_url(media_attributes.get('poster'))
2443             if media_content:
2444                 for source_tag in re.findall(r'<source[^>]+>', media_content):
2445                     source_attributes = extract_attributes(source_tag)
2446                     src = source_attributes.get('src')
2447                     if not src:
2448                         continue
2449                     f = parse_content_type(source_attributes.get('type'))
2450                     is_plain_url, formats = _media_formats(src, media_type, f)
2451                     if is_plain_url:
2452                         # res attribute is not standard but seen several times
2453                         # in the wild
2454                         f.update({
2455                             'height': int_or_none(source_attributes.get('res')),
2456                             'format_id': source_attributes.get('label'),
2457                         })
2458                         f.update(formats[0])
2459                         media_info['formats'].append(f)
2460                     else:
2461                         media_info['formats'].extend(formats)
2462                 for track_tag in re.findall(r'<track[^>]+>', media_content):
2463                     track_attributes = extract_attributes(track_tag)
2464                     kind = track_attributes.get('kind')
2465                     if not kind or kind in ('subtitles', 'captions'):
2466                         src = track_attributes.get('src')
2467                         if not src:
2468                             continue
2469                         lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
2470                         media_info['subtitles'].setdefault(lang, []).append({
2471                             'url': absolute_url(src),
2472                         })
2473             for f in media_info['formats']:
2474                 f.setdefault('http_headers', {})['Referer'] = base_url
2475             if media_info['formats'] or media_info['subtitles']:
2476                 entries.append(media_info)
2477         return entries
2478
2479     def _extract_akamai_formats(self, manifest_url, video_id, hosts={}):
2480         formats = []
2481         hdcore_sign = 'hdcore=3.7.0'
2482         f4m_url = re.sub(r'(https?://[^/]+)/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
2483         hds_host = hosts.get('hds')
2484         if hds_host:
2485             f4m_url = re.sub(r'(https?://)[^/]+', r'\1' + hds_host, f4m_url)
2486         if 'hdcore=' not in f4m_url:
2487             f4m_url += ('&' if '?' in f4m_url else '?') + hdcore_sign
2488         f4m_formats = self._extract_f4m_formats(
2489             f4m_url, video_id, f4m_id='hds', fatal=False)
2490         for entry in f4m_formats:
2491             entry.update({'extra_param_to_segment_url': hdcore_sign})
2492         formats.extend(f4m_formats)
2493         m3u8_url = re.sub(r'(https?://[^/]+)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
2494         hls_host = hosts.get('hls')
2495         if hls_host:
2496             m3u8_url = re.sub(r'(https?://)[^/]+', r'\1' + hls_host, m3u8_url)
2497         formats.extend(self._extract_m3u8_formats(
2498             m3u8_url, video_id, 'mp4', 'm3u8_native',
2499             m3u8_id='hls', fatal=False))
2500         return formats
2501
2502     def _extract_wowza_formats(self, url, video_id, m3u8_entry_protocol='m3u8_native', skip_protocols=[]):
2503         query = compat_urlparse.urlparse(url).query
2504         url = re.sub(r'/(?:manifest|playlist|jwplayer)\.(?:m3u8|f4m|mpd|smil)', '', url)
2505         mobj = re.search(
2506             r'(?:(?:http|rtmp|rtsp)(?P<s>s)?:)?(?P<url>//[^?]+)', url)
2507         url_base = mobj.group('url')
2508         http_base_url = '%s%s:%s' % ('http', mobj.group('s') or '', url_base)
2509         formats = []
2510
2511         def manifest_url(manifest):
2512             m_url = '%s/%s' % (http_base_url, manifest)
2513             if query:
2514                 m_url += '?%s' % query
2515             return m_url
2516
2517         if 'm3u8' not in skip_protocols:
2518             formats.extend(self._extract_m3u8_formats(
2519                 manifest_url('playlist.m3u8'), video_id, 'mp4',
2520                 m3u8_entry_protocol, m3u8_id='hls', fatal=False))
2521         if 'f4m' not in skip_protocols:
2522             formats.extend(self._extract_f4m_formats(
2523                 manifest_url('manifest.f4m'),
2524                 video_id, f4m_id='hds', fatal=False))
2525         if 'dash' not in skip_protocols:
2526             formats.extend(self._extract_mpd_formats(
2527                 manifest_url('manifest.mpd'),
2528                 video_id, mpd_id='dash', fatal=False))
2529         if re.search(r'(?:/smil:|\.smil)', url_base):
2530             if 'smil' not in skip_protocols:
2531                 rtmp_formats = self._extract_smil_formats(
2532                     manifest_url('jwplayer.smil'),
2533                     video_id, fatal=False)
2534                 for rtmp_format in rtmp_formats:
2535                     rtsp_format = rtmp_format.copy()
2536                     rtsp_format['url'] = '%s/%s' % (rtmp_format['url'], rtmp_format['play_path'])
2537                     del rtsp_format['play_path']
2538                     del rtsp_format['ext']
2539                     rtsp_format.update({
2540                         'url': rtsp_format['url'].replace('rtmp://', 'rtsp://'),
2541                         'format_id': rtmp_format['format_id'].replace('rtmp', 'rtsp'),
2542                         'protocol': 'rtsp',
2543                     })
2544                     formats.extend([rtmp_format, rtsp_format])
2545         else:
2546             for protocol in ('rtmp', 'rtsp'):
2547                 if protocol not in skip_protocols:
2548                     formats.append({
2549                         'url': '%s:%s' % (protocol, url_base),
2550                         'format_id': protocol,
2551                         'protocol': protocol,
2552                     })
2553         return formats
2554
2555     def _find_jwplayer_data(self, webpage, video_id=None, transform_source=js_to_json):
2556         mobj = re.search(
2557             r'(?s)jwplayer\((?P<quote>[\'"])[^\'" ]+(?P=quote)\)(?!</script>).*?\.setup\s*\((?P<options>[^)]+)\)',
2558             webpage)
2559         if mobj:
2560             try:
2561                 jwplayer_data = self._parse_json(mobj.group('options'),
2562                                                  video_id=video_id,
2563                                                  transform_source=transform_source)
2564             except ExtractorError:
2565                 pass
2566             else:
2567                 if isinstance(jwplayer_data, dict):
2568                     return jwplayer_data
2569
2570     def _extract_jwplayer_data(self, webpage, video_id, *args, **kwargs):
2571         jwplayer_data = self._find_jwplayer_data(
2572             webpage, video_id, transform_source=js_to_json)
2573         return self._parse_jwplayer_data(
2574             jwplayer_data, video_id, *args, **kwargs)
2575
2576     def _parse_jwplayer_data(self, jwplayer_data, video_id=None, require_title=True,
2577                              m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
2578         # JWPlayer backward compatibility: flattened playlists
2579         # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/api/config.js#L81-L96
2580         if 'playlist' not in jwplayer_data:
2581             jwplayer_data = {'playlist': [jwplayer_data]}
2582
2583         entries = []
2584
2585         # JWPlayer backward compatibility: single playlist item
2586         # https://github.com/jwplayer/jwplayer/blob/v7.7.0/src/js/playlist/playlist.js#L10
2587         if not isinstance(jwplayer_data['playlist'], list):
2588             jwplayer_data['playlist'] = [jwplayer_data['playlist']]
2589
2590         for video_data in jwplayer_data['playlist']:
2591             # JWPlayer backward compatibility: flattened sources
2592             # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/playlist/item.js#L29-L35
2593             if 'sources' not in video_data:
2594                 video_data['sources'] = [video_data]
2595
2596             this_video_id = video_id or video_data['mediaid']
2597
2598             formats = self._parse_jwplayer_formats(
2599                 video_data['sources'], video_id=this_video_id, m3u8_id=m3u8_id,
2600                 mpd_id=mpd_id, rtmp_params=rtmp_params, base_url=base_url)
2601
2602             subtitles = {}
2603             tracks = video_data.get('tracks')
2604             if tracks and isinstance(tracks, list):
2605                 for track in tracks:
2606                     if not isinstance(track, dict):
2607                         continue
2608                     track_kind = track.get('kind')
2609                     if not track_kind or not isinstance(track_kind, compat_str):
2610                         continue
2611                     if track_kind.lower() not in ('captions', 'subtitles'):
2612                         continue
2613                     track_url = urljoin(base_url, track.get('file'))
2614                     if not track_url:
2615                         continue
2616                     subtitles.setdefault(track.get('label') or 'en', []).append({
2617                         'url': self._proto_relative_url(track_url)
2618                     })
2619
2620             entry = {
2621                 'id': this_video_id,
2622                 'title': unescapeHTML(video_data['title'] if require_title else video_data.get('title')),
2623                 'description': video_data.get('description'),
2624                 'thumbnail': self._proto_relative_url(video_data.get('image')),
2625                 'timestamp': int_or_none(video_data.get('pubdate')),
2626                 'duration': float_or_none(jwplayer_data.get('duration') or video_data.get('duration')),
2627                 'subtitles': subtitles,
2628             }
2629             # https://github.com/jwplayer/jwplayer/blob/master/src/js/utils/validator.js#L32
2630             if len(formats) == 1 and re.search(r'^(?:http|//).*(?:youtube\.com|youtu\.be)/.+', formats[0]['url']):
2631                 entry.update({
2632                     '_type': 'url_transparent',
2633                     'url': formats[0]['url'],
2634                 })
2635             else:
2636                 self._sort_formats(formats)
2637                 entry['formats'] = formats
2638             entries.append(entry)
2639         if len(entries) == 1:
2640             return entries[0]
2641         else:
2642             return self.playlist_result(entries)
2643
2644     def _parse_jwplayer_formats(self, jwplayer_sources_data, video_id=None,
2645                                 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
2646         urls = []
2647         formats = []
2648         for source in jwplayer_sources_data:
2649             if not isinstance(source, dict):
2650                 continue
2651             source_url = self._proto_relative_url(source.get('file'))
2652             if not source_url:
2653                 continue
2654             if base_url:
2655                 source_url = compat_urlparse.urljoin(base_url, source_url)
2656             if source_url in urls:
2657                 continue
2658             urls.append(source_url)
2659             source_type = source.get('type') or ''
2660             ext = mimetype2ext(source_type) or determine_ext(source_url)
2661             if source_type == 'hls' or ext == 'm3u8':
2662                 formats.extend(self._extract_m3u8_formats(
2663                     source_url, video_id, 'mp4', entry_protocol='m3u8_native',
2664                     m3u8_id=m3u8_id, fatal=False))
2665             elif source_type == 'dash' or ext == 'mpd':
2666                 formats.extend(self._extract_mpd_formats(
2667                     source_url, video_id, mpd_id=mpd_id, fatal=False))
2668             elif ext == 'smil':
2669                 formats.extend(self._extract_smil_formats(
2670                     source_url, video_id, fatal=False))
2671             # https://github.com/jwplayer/jwplayer/blob/master/src/js/providers/default.js#L67
2672             elif source_type.startswith('audio') or ext in (
2673                     'oga', 'aac', 'mp3', 'mpeg', 'vorbis'):
2674                 formats.append({
2675                     'url': source_url,
2676                     'vcodec': 'none',
2677                     'ext': ext,
2678                 })
2679             else:
2680                 height = int_or_none(source.get('height'))
2681                 if height is None:
2682                     # Often no height is provided but there is a label in
2683                     # format like "1080p", "720p SD", or 1080.
2684                     height = int_or_none(self._search_regex(
2685                         r'^(\d{3,4})[pP]?(?:\b|$)', compat_str(source.get('label') or ''),
2686                         'height', default=None))
2687                 a_format = {
2688                     'url': source_url,
2689                     'width': int_or_none(source.get('width')),
2690                     'height': height,
2691                     'tbr': int_or_none(source.get('bitrate')),
2692                     'ext': ext,
2693                 }
2694                 if source_url.startswith('rtmp'):
2695                     a_format['ext'] = 'flv'
2696                     # See com/longtailvideo/jwplayer/media/RTMPMediaProvider.as
2697                     # of jwplayer.flash.swf
2698                     rtmp_url_parts = re.split(
2699                         r'((?:mp4|mp3|flv):)', source_url, 1)
2700                     if len(rtmp_url_parts) == 3:
2701                         rtmp_url, prefix, play_path = rtmp_url_parts
2702                         a_format.update({
2703                             'url': rtmp_url,
2704                             'play_path': prefix + play_path,
2705                         })
2706                     if rtmp_params:
2707                         a_format.update(rtmp_params)
2708                 formats.append(a_format)
2709         return formats
2710
2711     def _live_title(self, name):
2712         """ Generate the title for a live video """
2713         now = datetime.datetime.now()
2714         now_str = now.strftime('%Y-%m-%d %H:%M')
2715         return name + ' ' + now_str
2716
2717     def _int(self, v, name, fatal=False, **kwargs):
2718         res = int_or_none(v, **kwargs)
2719         if 'get_attr' in kwargs:
2720             print(getattr(v, kwargs['get_attr']))
2721         if res is None:
2722             msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
2723             if fatal:
2724                 raise ExtractorError(msg)
2725             else:
2726                 self._downloader.report_warning(msg)
2727         return res
2728
2729     def _float(self, v, name, fatal=False, **kwargs):
2730         res = float_or_none(v, **kwargs)
2731         if res is None:
2732             msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
2733             if fatal:
2734                 raise ExtractorError(msg)
2735             else:
2736                 self._downloader.report_warning(msg)
2737         return res
2738
2739     def _set_cookie(self, domain, name, value, expire_time=None, port=None,
2740                     path='/', secure=False, discard=False, rest={}, **kwargs):
2741         cookie = compat_cookiejar.Cookie(
2742             0, name, value, port, port is not None, domain, True,
2743             domain.startswith('.'), path, True, secure, expire_time,
2744             discard, None, None, rest)
2745         self._downloader.cookiejar.set_cookie(cookie)
2746
2747     def _get_cookies(self, url):
2748         """ Return a compat_cookies.SimpleCookie with the cookies for the url """
2749         req = sanitized_Request(url)
2750         self._downloader.cookiejar.add_cookie_header(req)
2751         return compat_cookies.SimpleCookie(req.get_header('Cookie'))
2752
2753     def get_testcases(self, include_onlymatching=False):
2754         t = getattr(self, '_TEST', None)
2755         if t:
2756             assert not hasattr(self, '_TESTS'), \
2757                 '%s has _TEST and _TESTS' % type(self).__name__
2758             tests = [t]
2759         else:
2760             tests = getattr(self, '_TESTS', [])
2761         for t in tests:
2762             if not include_onlymatching and t.get('only_matching', False):
2763                 continue
2764             t['name'] = type(self).__name__[:-len('IE')]
2765             yield t
2766
2767     def is_suitable(self, age_limit):
2768         """ Test whether the extractor is generally suitable for the given
2769         age limit (i.e. pornographic sites are not, all others usually are) """
2770
2771         any_restricted = False
2772         for tc in self.get_testcases(include_onlymatching=False):
2773             if tc.get('playlist', []):
2774                 tc = tc['playlist'][0]
2775             is_restricted = age_restricted(
2776                 tc.get('info_dict', {}).get('age_limit'), age_limit)
2777             if not is_restricted:
2778                 return True
2779             any_restricted = any_restricted or is_restricted
2780         return not any_restricted
2781
2782     def extract_subtitles(self, *args, **kwargs):
2783         if (self._downloader.params.get('writesubtitles', False) or
2784                 self._downloader.params.get('listsubtitles')):
2785             return self._get_subtitles(*args, **kwargs)
2786         return {}
2787
2788     def _get_subtitles(self, *args, **kwargs):
2789         raise NotImplementedError('This method must be implemented by subclasses')
2790
2791     @staticmethod
2792     def _merge_subtitle_items(subtitle_list1, subtitle_list2):
2793         """ Merge subtitle items for one language. Items with duplicated URLs
2794         will be dropped. """
2795         list1_urls = set([item['url'] for item in subtitle_list1])
2796         ret = list(subtitle_list1)
2797         ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
2798         return ret
2799
2800     @classmethod
2801     def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2):
2802         """ Merge two subtitle dictionaries, language by language. """
2803         ret = dict(subtitle_dict1)
2804         for lang in subtitle_dict2:
2805             ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang])
2806         return ret
2807
2808     def extract_automatic_captions(self, *args, **kwargs):
2809         if (self._downloader.params.get('writeautomaticsub', False) or
2810                 self._downloader.params.get('listsubtitles')):
2811             return self._get_automatic_captions(*args, **kwargs)
2812         return {}
2813
2814     def _get_automatic_captions(self, *args, **kwargs):
2815         raise NotImplementedError('This method must be implemented by subclasses')
2816
2817     def mark_watched(self, *args, **kwargs):
2818         if (self._downloader.params.get('mark_watched', False) and
2819                 (self._get_login_info()[0] is not None or
2820                     self._downloader.params.get('cookiefile') is not None)):
2821             self._mark_watched(*args, **kwargs)
2822
2823     def _mark_watched(self, *args, **kwargs):
2824         raise NotImplementedError('This method must be implemented by subclasses')
2825
2826     def geo_verification_headers(self):
2827         headers = {}
2828         geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
2829         if geo_verification_proxy:
2830             headers['Ytdl-request-proxy'] = geo_verification_proxy
2831         return headers
2832
2833     def _generic_id(self, url):
2834         return compat_urllib_parse_unquote(os.path.splitext(url.rstrip('/').split('/')[-1])[0])
2835
2836     def _generic_title(self, url):
2837         return compat_urllib_parse_unquote(os.path.splitext(url_basename(url))[0])
2838
2839
2840 class SearchInfoExtractor(InfoExtractor):
2841     """
2842     Base class for paged search queries extractors.
2843     They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
2844     Instances should define _SEARCH_KEY and _MAX_RESULTS.
2845     """
2846
2847     @classmethod
2848     def _make_valid_url(cls):
2849         return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
2850
2851     @classmethod
2852     def suitable(cls, url):
2853         return re.match(cls._make_valid_url(), url) is not None
2854
2855     def _real_extract(self, query):
2856         mobj = re.match(self._make_valid_url(), query)
2857         if mobj is None:
2858             raise ExtractorError('Invalid search query "%s"' % query)
2859
2860         prefix = mobj.group('prefix')
2861         query = mobj.group('query')
2862         if prefix == '':
2863             return self._get_n_results(query, 1)
2864         elif prefix == 'all':
2865             return self._get_n_results(query, self._MAX_RESULTS)
2866         else:
2867             n = int(prefix)
2868             if n <= 0:
2869                 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
2870             elif n > self._MAX_RESULTS:
2871                 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
2872                 n = self._MAX_RESULTS
2873             return self._get_n_results(query, n)
2874
2875     def _get_n_results(self, query, n):
2876         """Get a specified number of results for a query"""
2877         raise NotImplementedError('This method must be implemented by subclasses')
2878
2879     @property
2880     def SEARCH_KEY(self):
2881         return self._SEARCH_KEY