]> jfr.im git - yt-dlp.git/blame - yt_dlp/extractor/common.py
Update to ytdl v2021-04-01
[yt-dlp.git] / yt_dlp / extractor / common.py
CommitLineData
fd475508 1# coding: utf-8
6a3828fd 2from __future__ import unicode_literals
f1a9d64e 3
d6983cb4 4import base64
f4b1c7ad 5import datetime
3ec05685 6import hashlib
3d3538e4 7import json
4094b6e3 8import netrc
d6983cb4 9import os
773f291d 10import random
d6983cb4
PH
11import re
12import socket
f8c7bed1 13import ssl
d6983cb4 14import sys
4094b6e3 15import time
1bac3455 16import math
d6983cb4 17
8c25f81b 18from ..compat import (
6c22cee6 19 compat_cookiejar_Cookie,
799207e8 20 compat_cookies,
ee0ba927 21 compat_etree_Element,
e9c0cdd3 22 compat_etree_fromstring,
e64b7569 23 compat_getpass,
d391b7e2 24 compat_integer_types,
d6983cb4 25 compat_http_client,
e9c0cdd3
YCH
26 compat_os_name,
27 compat_str,
d6983cb4 28 compat_urllib_error,
98763ee3 29 compat_urllib_parse_unquote,
15707c7e 30 compat_urllib_parse_urlencode,
41d06b04 31 compat_urllib_request,
f0b5d6af 32 compat_urlparse,
e01c3d2e 33 compat_xml_parse_error,
8c25f81b 34)
eb8a4433 35from ..downloader import FileDownloader
48107c19
S
36from ..downloader.f4m import (
37 get_base_url,
38 remove_encrypted_media,
39)
8c25f81b 40from ..utils import (
c342041f 41 NO_DEFAULT,
05900629 42 age_restricted,
02dc0a36 43 base_url,
08f2a92c 44 bug_reports_message,
d6983cb4
PH
45 clean_html,
46 compiled_regex_type,
70f0f5a8 47 determine_ext,
46b18f23 48 determine_protocol,
d493f15c 49 dict_get,
9b9c5355 50 error_to_compat_str,
d6983cb4 51 ExtractorError,
46b18f23 52 extract_attributes,
97f4aecf 53 fix_xml_ampersands,
b14f3a4c 54 float_or_none,
773f291d
S
55 GeoRestrictedError,
56 GeoUtils,
31bb8d3f 57 int_or_none,
a4a554a7 58 js_to_json,
0685d972 59 JSON_LD_RE,
46b18f23
JH
60 mimetype2ext,
61 orderedSet,
d493f15c 62 parse_bitrate,
46b18f23
JH
63 parse_codecs,
64 parse_duration,
4ca2a3cf 65 parse_iso8601,
46b18f23 66 parse_m3u8_attributes,
d493f15c 67 parse_resolution,
55b3e45b 68 RegexNotFoundError,
5c2266df 69 sanitized_Request,
46b18f23 70 sanitize_filename,
d493f15c 71 str_or_none,
ce5b9040 72 str_to_int,
f856816b 73 strip_or_none,
f38de77f 74 unescapeHTML,
647eab45 75 unified_strdate,
6b3a3098 76 unified_timestamp,
46b18f23
JH
77 update_Request,
78 update_url_query,
79 urljoin,
a107193e 80 url_basename,
bebef109 81 url_or_none,
a6571f10 82 xpath_element,
8d6765cf
S
83 xpath_text,
84 xpath_with_ns,
d6983cb4 85)
c342041f 86
d6983cb4
PH
87
88class InfoExtractor(object):
89 """Information Extractor class.
90
91 Information extractors are the classes that, given a URL, extract
92 information about the video (or videos) the URL refers to. This
93 information includes the real video URL, the video title, author and
94 others. The information is stored in a dictionary which is then
5d380852 95 passed to the YoutubeDL. The YoutubeDL processes this
d6983cb4
PH
96 information possibly downloading the video to the file system, among
97 other possible outcomes.
98
cf0649f8 99 The type field determines the type of the result.
fed5d032
PH
100 By far the most common value (and the default if _type is missing) is
101 "video", which indicates a single video.
102
103 For a video, the dictionaries must include the following fields:
d6983cb4
PH
104
105 id: Video identifier.
d6983cb4 106 title: Video title, unescaped.
d67b0b15 107
f49d89ee 108 Additionally, it must contain either a formats entry or a url one:
d67b0b15 109
f49d89ee
PH
110 formats: A list of dictionaries for each format available, ordered
111 from worst to best quality.
112
113 Potential fields:
c790e93a
S
114 * url The mandatory URL representing the media:
115 for plain file media - HTTP URL of this file,
116 for RTMP - RTMP URL,
117 for HLS - URL of the M3U8 media playlist,
118 for HDS - URL of the F4M manifest,
79d2077e
S
119 for DASH
120 - HTTP URL to plain file media (in case of
121 unfragmented media)
122 - URL of the MPD manifest or base URL
123 representing the media if MPD manifest
8ed7a233 124 is parsed from a string (in case of
79d2077e 125 fragmented media)
c790e93a 126 for MSS - URL of the ISM manifest.
86f4d14f
S
127 * manifest_url
128 The URL of the manifest file in case of
c790e93a
S
129 fragmented media:
130 for HLS - URL of the M3U8 master playlist,
131 for HDS - URL of the F4M manifest,
132 for DASH - URL of the MPD manifest,
133 for MSS - URL of the ISM manifest.
10952eb2 134 * ext Will be calculated from URL if missing
d67b0b15
PH
135 * format A human-readable description of the format
136 ("mp4 container with h264/opus").
137 Calculated from the format_id, width, height.
138 and format_note fields if missing.
139 * format_id A short description of the format
5d4f3985
PH
140 ("mp4_h264_opus" or "19").
141 Technically optional, but strongly recommended.
d67b0b15
PH
142 * format_note Additional info about the format
143 ("3D" or "DASH video")
144 * width Width of the video, if known
145 * height Height of the video, if known
f49d89ee 146 * resolution Textual description of width and height
7217e148 147 * tbr Average bitrate of audio and video in KBit/s
d67b0b15
PH
148 * abr Average audio bitrate in KBit/s
149 * acodec Name of the audio codec in use
dd27fd17 150 * asr Audio sampling rate in Hertz
d67b0b15 151 * vbr Average video bitrate in KBit/s
fbb21cf5 152 * fps Frame rate
d67b0b15 153 * vcodec Name of the video codec in use
1394ce65 154 * container Name of the container format
d67b0b15 155 * filesize The number of bytes, if known in advance
9732d77e 156 * filesize_approx An estimate for the number of bytes
d67b0b15 157 * player_url SWF Player URL (used for rtmpdump).
c7deaa4c
PH
158 * protocol The protocol that will be used for the actual
159 download, lower-case.
b04b8852 160 "http", "https", "rtsp", "rtmp", "rtmpe",
af7d5a63 161 "m3u8", "m3u8_native" or "http_dash_segments".
c58c2d63
S
162 * fragment_base_url
163 Base URL for fragments. Each fragment's path
164 value (if present) will be relative to
165 this URL.
166 * fragments A list of fragments of a fragmented media.
167 Each fragment entry must contain either an url
168 or a path. If an url is present it should be
169 considered by a client. Otherwise both path and
170 fragment_base_url must be present. Here is
171 the list of all potential fields:
172 * "url" - fragment's URL
173 * "path" - fragment's path relative to
174 fragment_base_url
a0d5077c
S
175 * "duration" (optional, int or float)
176 * "filesize" (optional, int)
f49d89ee 177 * preference Order number of this format. If this field is
08d13955 178 present and not None, the formats get sorted
38d63d84 179 by this field, regardless of all other values.
f49d89ee
PH
180 -1 for default (order by other properties),
181 -2 or smaller for less than default.
e65566a9
PH
182 < -1000 to hide the format (if there is
183 another one which is strictly better)
32f90364
PH
184 * language Language code, e.g. "de" or "en-US".
185 * language_preference Is this in the language mentioned in
186 the URL?
aff2f4f4
PH
187 10 if it's what the URL is about,
188 -1 for default (don't know),
189 -10 otherwise, other values reserved for now.
5d73273f
PH
190 * quality Order number of the video quality of this
191 format, irrespective of the file format.
192 -1 for default (order by other properties),
193 -2 or smaller for less than default.
c64ed2a3
PH
194 * source_preference Order number for this video source
195 (quality takes higher priority)
196 -1 for default (order by other properties),
197 -2 or smaller for less than default.
d769be6c
PH
198 * http_headers A dictionary of additional HTTP headers
199 to add to the request.
6271f1ca 200 * stretched_ratio If given and not 1, indicates that the
3dee7826
PH
201 video's pixels are not square.
202 width : height ratio as float.
203 * no_resume The server does not support resuming the
204 (HTTP or RTMP) download. Boolean.
00c97e3e
S
205 * downloader_options A dictionary of downloader options as
206 described in FileDownloader
3dee7826 207
c0ba0f48 208 url: Final video URL.
d6983cb4 209 ext: Video filename extension.
d67b0b15
PH
210 format: The video format, defaults to ext (used for --get-format)
211 player_url: SWF Player URL (used for rtmpdump).
2f5865cc 212
d6983cb4
PH
213 The following fields are optional:
214
f5e43bc6 215 alt_title: A secondary title of the video.
0afef30b
PH
216 display_id An alternative identifier for the video, not necessarily
217 unique, but available before title. Typically, id is
218 something like "4234987", title "Dancing naked mole rats",
219 and display_id "dancing-naked-mole-rats"
d5519808 220 thumbnails: A list of dictionaries, with the following entries:
cfb56d1a 221 * "id" (optional, string) - Thumbnail format ID
d5519808 222 * "url"
cfb56d1a 223 * "preference" (optional, int) - quality of the image
d5519808
PH
224 * "width" (optional, int)
225 * "height" (optional, int)
5e1c39ac 226 * "resolution" (optional, string "{width}x{height}",
d5519808 227 deprecated)
2de624fd 228 * "filesize" (optional, int)
d6983cb4 229 thumbnail: Full URL to a video thumbnail image.
f5e43bc6 230 description: Full video description.
d6983cb4 231 uploader: Full name of the video uploader.
2bc0c46f 232 license: License name the video is licensed under.
8a92e51c 233 creator: The creator of the video.
10db0d2f 234 release_timestamp: UNIX timestamp of the moment the video was released.
8aab976b 235 release_date: The date (YYYYMMDD) when the video was released.
10db0d2f 236 timestamp: UNIX timestamp of the moment the video was uploaded
d6983cb4 237 upload_date: Video upload date (YYYYMMDD).
955c4514 238 If not explicitly set, calculated from timestamp.
d6983cb4 239 uploader_id: Nickname or id of the video uploader.
7bcd2830 240 uploader_url: Full URL to a personal webpage of the video uploader.
6f1f59f3 241 channel: Full name of the channel the video is uploaded on.
0e7b8d3e 242 Note that channel fields may or may not repeat uploader
6f1f59f3
S
243 fields. This depends on a particular extractor.
244 channel_id: Id of the channel.
245 channel_url: Full URL to a channel webpage.
da9ec3b9 246 location: Physical location where the video was filmed.
a504ced0 247 subtitles: The available subtitles as a dictionary in the format
4606c34e
YCH
248 {tag: subformats}. "tag" is usually a language code, and
249 "subformats" is a list sorted from lower to higher
250 preference, each element is a dictionary with the "ext"
251 entry and one of:
a504ced0 252 * "data": The subtitles file contents
10952eb2 253 * "url": A URL pointing to the subtitles file
4bba3716 254 "ext" will be calculated from URL if missing
e167860c 255 automatic_captions: Like 'subtitles'; contains automatically generated
256 captions instead of normal subtitles
62d231c0 257 duration: Length of the video in seconds, as an integer or float.
f3d29461 258 view_count: How many users have watched the video on the platform.
19e3dfc9
PH
259 like_count: Number of positive ratings of the video
260 dislike_count: Number of negative ratings of the video
02835c6b 261 repost_count: Number of reposts of the video
2d30521a 262 average_rating: Average rating give by users, the scale used depends on the webpage
19e3dfc9 263 comment_count: Number of comments on the video
dd622d7c
PH
264 comments: A list of comments, each with one or more of the following
265 properties (all but one of text or html optional):
266 * "author" - human-readable name of the comment author
267 * "author_id" - user ID of the comment author
a1c5d2ca 268 * "author_thumbnail" - The thumbnail of the comment author
dd622d7c
PH
269 * "id" - Comment ID
270 * "html" - Comment as HTML
271 * "text" - Plain text of the comment
272 * "timestamp" - UNIX timestamp of comment
273 * "parent" - ID of the comment this one is replying to.
274 Set to "root" to indicate that this is a
275 comment to the original video.
a1c5d2ca
M
276 * "like_count" - Number of positive ratings of the comment
277 * "dislike_count" - Number of negative ratings of the comment
278 * "is_favorited" - Whether the comment is marked as
279 favorite by the video uploader
280 * "author_is_uploader" - Whether the comment is made by
281 the video uploader
8dbe9899 282 age_limit: Age restriction for the video, as an integer (years)
7a5c1cfe 283 webpage_url: The URL to the video webpage, if given to yt-dlp it
9103bbc5
JMF
284 should allow to get the same result again. (It will be set
285 by YoutubeDL if it's missing)
ad3bc6ac
PH
286 categories: A list of categories that the video falls in, for example
287 ["Sports", "Berlin"]
864f24bd 288 tags: A list of tags assigned to the video, e.g. ["sweden", "pop music"]
7267bd53
PH
289 is_live: True, False, or None (=unknown). Whether this video is a
290 live stream that goes on instead of a fixed-length video.
f76ede8e 291 was_live: True, False, or None (=unknown). Whether this video was
292 originally a live stream.
7c80519c 293 start_time: Time in seconds where the reproduction should start, as
10952eb2 294 specified in the URL.
297a564b 295 end_time: Time in seconds where the reproduction should end, as
10952eb2 296 specified in the URL.
55949fed 297 chapters: A list of dictionaries, with the following entries:
298 * "start_time" - The start time of the chapter in seconds
299 * "end_time" - The end time of the chapter in seconds
300 * "title" (optional, string)
6cfda058 301 playable_in_embed: Whether this video is allowed to play in embedded
302 players on other sites. Can be True (=always allowed),
303 False (=never allowed), None (=unknown), or a string
c224251a
M
304 specifying the criteria for embedability (Eg: 'whitelist')
305 availability: Under what condition the video is available. One of
306 'private', 'premium_only', 'subscriber_only', 'needs_auth',
307 'unlisted' or 'public'. Use 'InfoExtractor._availability'
308 to set it
277d6ff5 309 __post_extractor: A function to be called just before the metadata is
310 written to either disk, logger or console. The function
311 must return a dict which will be added to the info_dict.
312 This is usefull for additional information that is
313 time-consuming to extract. Note that the fields thus
314 extracted will not be available to output template and
315 match_filter. So, only "comments" and "comment_count" are
316 currently allowed to be extracted via this method.
d6983cb4 317
7109903e
S
318 The following fields should only be used when the video belongs to some logical
319 chapter or section:
320
321 chapter: Name or title of the chapter the video belongs to.
27bfd4e5
S
322 chapter_number: Number of the chapter the video belongs to, as an integer.
323 chapter_id: Id of the chapter the video belongs to, as a unicode string.
7109903e
S
324
325 The following fields should only be used when the video is an episode of some
8d76bdf1 326 series, programme or podcast:
7109903e
S
327
328 series: Title of the series or programme the video episode belongs to.
329 season: Title of the season the video episode belongs to.
27bfd4e5
S
330 season_number: Number of the season the video episode belongs to, as an integer.
331 season_id: Id of the season the video episode belongs to, as a unicode string.
7109903e
S
332 episode: Title of the video episode. Unlike mandatory video title field,
333 this field should denote the exact title of the video episode
334 without any kind of decoration.
27bfd4e5
S
335 episode_number: Number of the video episode within a season, as an integer.
336 episode_id: Id of the video episode, as a unicode string.
7109903e 337
7a93ab5f
S
338 The following fields should only be used when the media is a track or a part of
339 a music album:
340
341 track: Title of the track.
342 track_number: Number of the track within an album or a disc, as an integer.
343 track_id: Id of the track (useful in case of custom indexing, e.g. 6.iii),
344 as a unicode string.
345 artist: Artist(s) of the track.
346 genre: Genre(s) of the track.
347 album: Title of the album the track belongs to.
348 album_type: Type of the album (e.g. "Demo", "Full-length", "Split", "Compilation", etc).
349 album_artist: List of all artists appeared on the album (e.g.
350 "Ash Borer / Fell Voices" or "Various Artists", useful for splits
351 and compilations).
352 disc_number: Number of the disc or other physical medium the track belongs to,
353 as an integer.
354 release_year: Year (YYYY) when the album was released.
355
deefc05b 356 Unless mentioned otherwise, the fields should be Unicode strings.
d6983cb4 357
d838b1bd
PH
358 Unless mentioned otherwise, None is equivalent to absence of information.
359
fed5d032
PH
360
361 _type "playlist" indicates multiple videos.
b82f815f
PH
362 There must be a key "entries", which is a list, an iterable, or a PagedList
363 object, each element of which is a valid dictionary by this specification.
fed5d032 364
b60419c5 365 Additionally, playlists can have "id", "title", and any other relevent
366 attributes with the same semantics as videos (see above).
fed5d032
PH
367
368
369 _type "multi_video" indicates that there are multiple videos that
370 form a single show, for examples multiple acts of an opera or TV episode.
371 It must have an entries key like a playlist and contain all the keys
372 required for a video at the same time.
373
374
375 _type "url" indicates that the video must be extracted from another
376 location, possibly by a different extractor. Its only required key is:
377 "url" - the next URL to extract.
f58766ce
PH
378 The key "ie_key" can be set to the class name (minus the trailing "IE",
379 e.g. "Youtube") if the extractor class is known in advance.
380 Additionally, the dictionary may have any properties of the resolved entity
381 known in advance, for example "title" if the title of the referred video is
fed5d032
PH
382 known ahead of time.
383
384
385 _type "url_transparent" entities have the same specification as "url", but
386 indicate that the given additional information is more precise than the one
387 associated with the resolved URL.
388 This is useful when a site employs a video service that hosts the video and
389 its technical metadata, but that video service does not embed a useful
390 title, description etc.
391
392
d6983cb4
PH
393 Subclasses of this one should re-define the _real_initialize() and
394 _real_extract() methods and define a _VALID_URL regexp.
395 Probably, they should also be added to the list of extractors.
396
4248dad9 397 _GEO_BYPASS attribute may be set to False in order to disable
773f291d
S
398 geo restriction bypass mechanisms for a particular extractor.
399 Though it won't disable explicit geo restriction bypass based on
504f20dd 400 country code provided with geo_bypass_country.
4248dad9
S
401
402 _GEO_COUNTRIES attribute may contain a list of presumably geo unrestricted
403 countries for this extractor. One of these countries will be used by
404 geo restriction bypass mechanism right away in order to bypass
504f20dd 405 geo restriction, of course, if the mechanism is not disabled.
773f291d 406
5f95927a
S
407 _GEO_IP_BLOCKS attribute may contain a list of presumably geo unrestricted
408 IP blocks in CIDR notation for this extractor. One of these IP blocks
409 will be used by geo restriction bypass mechanism similarly
504f20dd 410 to _GEO_COUNTRIES.
3ccdde8c 411
d6983cb4
PH
412 Finally, the _WORKING attribute should be set to False for broken IEs
413 in order to warn the users and skip the tests.
414 """
415
416 _ready = False
417 _downloader = None
773f291d 418 _x_forwarded_for_ip = None
4248dad9
S
419 _GEO_BYPASS = True
420 _GEO_COUNTRIES = None
5f95927a 421 _GEO_IP_BLOCKS = None
d6983cb4
PH
422 _WORKING = True
423
424 def __init__(self, downloader=None):
425 """Constructor. Receives an optional downloader."""
426 self._ready = False
773f291d 427 self._x_forwarded_for_ip = None
d6983cb4
PH
428 self.set_downloader(downloader)
429
430 @classmethod
431 def suitable(cls, url):
432 """Receives a URL and returns True if suitable for this IE."""
79cb2577
PH
433
434 # This does not use has/getattr intentionally - we want to know whether
435 # we have cached the regexp for *this* class, whereas getattr would also
436 # match the superclass
437 if '_VALID_URL_RE' not in cls.__dict__:
438 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
439 return cls._VALID_URL_RE.match(url) is not None
d6983cb4 440
ed9266db
PH
441 @classmethod
442 def _match_id(cls, url):
443 if '_VALID_URL_RE' not in cls.__dict__:
444 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
445 m = cls._VALID_URL_RE.match(url)
446 assert m
1afd0b0d 447 return compat_str(m.group('id'))
ed9266db 448
d6983cb4
PH
449 @classmethod
450 def working(cls):
451 """Getter method for _WORKING."""
452 return cls._WORKING
453
454 def initialize(self):
455 """Initializes an instance (authentication, etc)."""
5f95927a
S
456 self._initialize_geo_bypass({
457 'countries': self._GEO_COUNTRIES,
458 'ip_blocks': self._GEO_IP_BLOCKS,
459 })
4248dad9
S
460 if not self._ready:
461 self._real_initialize()
462 self._ready = True
463
5f95927a 464 def _initialize_geo_bypass(self, geo_bypass_context):
e39b5d4a
S
465 """
466 Initialize geo restriction bypass mechanism.
467
468 This method is used to initialize geo bypass mechanism based on faking
469 X-Forwarded-For HTTP header. A random country from provided country list
dc0a869e 470 is selected and a random IP belonging to this country is generated. This
e39b5d4a
S
471 IP will be passed as X-Forwarded-For HTTP header in all subsequent
472 HTTP requests.
e39b5d4a
S
473
474 This method will be used for initial geo bypass mechanism initialization
5f95927a
S
475 during the instance initialization with _GEO_COUNTRIES and
476 _GEO_IP_BLOCKS.
e39b5d4a 477
5f95927a 478 You may also manually call it from extractor's code if geo bypass
e39b5d4a 479 information is not available beforehand (e.g. obtained during
5f95927a
S
480 extraction) or due to some other reason. In this case you should pass
481 this information in geo bypass context passed as first argument. It may
482 contain following fields:
483
484 countries: List of geo unrestricted countries (similar
485 to _GEO_COUNTRIES)
486 ip_blocks: List of geo unrestricted IP blocks in CIDR notation
487 (similar to _GEO_IP_BLOCKS)
488
e39b5d4a 489 """
773f291d 490 if not self._x_forwarded_for_ip:
5f95927a
S
491
492 # Geo bypass mechanism is explicitly disabled by user
493 if not self._downloader.params.get('geo_bypass', True):
494 return
495
496 if not geo_bypass_context:
497 geo_bypass_context = {}
498
499 # Backward compatibility: previously _initialize_geo_bypass
500 # expected a list of countries, some 3rd party code may still use
501 # it this way
502 if isinstance(geo_bypass_context, (list, tuple)):
503 geo_bypass_context = {
504 'countries': geo_bypass_context,
505 }
506
507 # The whole point of geo bypass mechanism is to fake IP
508 # as X-Forwarded-For HTTP header based on some IP block or
509 # country code.
510
511 # Path 1: bypassing based on IP block in CIDR notation
512
513 # Explicit IP block specified by user, use it right away
514 # regardless of whether extractor is geo bypassable or not
515 ip_block = self._downloader.params.get('geo_bypass_ip_block', None)
516
517 # Otherwise use random IP block from geo bypass context but only
518 # if extractor is known as geo bypassable
519 if not ip_block:
520 ip_blocks = geo_bypass_context.get('ip_blocks')
521 if self._GEO_BYPASS and ip_blocks:
522 ip_block = random.choice(ip_blocks)
523
524 if ip_block:
525 self._x_forwarded_for_ip = GeoUtils.random_ipv4(ip_block)
526 if self._downloader.params.get('verbose', False):
527 self._downloader.to_screen(
528 '[debug] Using fake IP %s as X-Forwarded-For.'
529 % self._x_forwarded_for_ip)
530 return
531
532 # Path 2: bypassing based on country code
533
534 # Explicit country code specified by user, use it right away
535 # regardless of whether extractor is geo bypassable or not
536 country = self._downloader.params.get('geo_bypass_country', None)
537
538 # Otherwise use random country code from geo bypass context but
539 # only if extractor is known as geo bypassable
540 if not country:
541 countries = geo_bypass_context.get('countries')
542 if self._GEO_BYPASS and countries:
543 country = random.choice(countries)
544
545 if country:
546 self._x_forwarded_for_ip = GeoUtils.random_ipv4(country)
4248dad9 547 if self._downloader.params.get('verbose', False):
6a9cb295 548 self._downloader.to_screen(
eea0716c 549 '[debug] Using fake IP %s (%s) as X-Forwarded-For.'
5f95927a 550 % (self._x_forwarded_for_ip, country.upper()))
d6983cb4
PH
551
552 def extract(self, url):
553 """Extracts URL information and returns it in list of dicts."""
3a5bcd03 554 try:
773f291d
S
555 for _ in range(2):
556 try:
557 self.initialize()
0016b84e
S
558 ie_result = self._real_extract(url)
559 if self._x_forwarded_for_ip:
560 ie_result['__x_forwarded_for_ip'] = self._x_forwarded_for_ip
561 return ie_result
773f291d 562 except GeoRestrictedError as e:
4248dad9
S
563 if self.__maybe_fake_ip_and_retry(e.countries):
564 continue
773f291d 565 raise
3a5bcd03
PH
566 except ExtractorError:
567 raise
568 except compat_http_client.IncompleteRead as e:
dfb1b146 569 raise ExtractorError('A network error has occurred.', cause=e, expected=True)
9650885b 570 except (KeyError, StopIteration) as e:
dfb1b146 571 raise ExtractorError('An extractor error has occurred.', cause=e)
d6983cb4 572
4248dad9 573 def __maybe_fake_ip_and_retry(self, countries):
3089bc74
S
574 if (not self._downloader.params.get('geo_bypass_country', None)
575 and self._GEO_BYPASS
576 and self._downloader.params.get('geo_bypass', True)
577 and not self._x_forwarded_for_ip
578 and countries):
eea0716c
S
579 country_code = random.choice(countries)
580 self._x_forwarded_for_ip = GeoUtils.random_ipv4(country_code)
4248dad9
S
581 if self._x_forwarded_for_ip:
582 self.report_warning(
eea0716c
S
583 'Video is geo restricted. Retrying extraction with fake IP %s (%s) as X-Forwarded-For.'
584 % (self._x_forwarded_for_ip, country_code.upper()))
4248dad9
S
585 return True
586 return False
587
d6983cb4
PH
588 def set_downloader(self, downloader):
589 """Sets the downloader for this IE."""
590 self._downloader = downloader
591
592 def _real_initialize(self):
593 """Real initialization process. Redefine in subclasses."""
594 pass
595
596 def _real_extract(self, url):
597 """Real extraction process. Redefine in subclasses."""
598 pass
599
56c73665
JMF
600 @classmethod
601 def ie_key(cls):
602 """A string for getting the InfoExtractor with get_info_extractor"""
dc519b54 603 return compat_str(cls.__name__[:-2])
56c73665 604
d6983cb4
PH
605 @property
606 def IE_NAME(self):
dc519b54 607 return compat_str(type(self).__name__[:-2])
d6983cb4 608
d391b7e2
S
609 @staticmethod
610 def __can_accept_status_code(err, expected_status):
611 assert isinstance(err, compat_urllib_error.HTTPError)
612 if expected_status is None:
613 return False
614 if isinstance(expected_status, compat_integer_types):
615 return err.code == expected_status
616 elif isinstance(expected_status, (list, tuple)):
617 return err.code in expected_status
618 elif callable(expected_status):
619 return expected_status(err.code) is True
620 else:
621 assert False
622
623 def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, data=None, headers={}, query={}, expected_status=None):
624 """
625 Return the response handle.
626
627 See _download_webpage docstring for arguments specification.
628 """
1cf376f5 629 if not self._downloader._first_webpage_request:
630 sleep_interval = float_or_none(self._downloader.params.get('sleep_interval_requests')) or 0
631 if sleep_interval > 0:
5ef7d9bd 632 self.to_screen('Sleeping %s seconds ...' % sleep_interval)
1cf376f5 633 time.sleep(sleep_interval)
634 else:
635 self._downloader._first_webpage_request = False
636
d6983cb4
PH
637 if note is None:
638 self.report_download_webpage(video_id)
639 elif note is not False:
7cc3570e 640 if video_id is None:
f1a9d64e 641 self.to_screen('%s' % (note,))
7cc3570e 642 else:
f1a9d64e 643 self.to_screen('%s: %s' % (video_id, note))
2132edaa
S
644
645 # Some sites check X-Forwarded-For HTTP header in order to figure out
646 # the origin of the client behind proxy. This allows bypassing geo
647 # restriction by faking this header's value to IP that belongs to some
648 # geo unrestricted country. We will do so once we encounter any
649 # geo restriction error.
650 if self._x_forwarded_for_ip:
651 if 'X-Forwarded-For' not in headers:
652 headers['X-Forwarded-For'] = self._x_forwarded_for_ip
653
41d06b04
S
654 if isinstance(url_or_request, compat_urllib_request.Request):
655 url_or_request = update_Request(
656 url_or_request, data=data, headers=headers, query=query)
657 else:
cdfee168 658 if query:
659 url_or_request = update_url_query(url_or_request, query)
2c0d9c62 660 if data is not None or headers:
41d06b04 661 url_or_request = sanitized_Request(url_or_request, data, headers)
f8c7bed1
S
662 exceptions = [compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error]
663 if hasattr(ssl, 'CertificateError'):
664 exceptions.append(ssl.CertificateError)
d6983cb4 665 try:
dca08720 666 return self._downloader.urlopen(url_or_request)
f8c7bed1 667 except tuple(exceptions) as err:
d391b7e2
S
668 if isinstance(err, compat_urllib_error.HTTPError):
669 if self.__can_accept_status_code(err, expected_status):
95e42d73
XDG
670 # Retain reference to error to prevent file object from
671 # being closed before it can be read. Works around the
672 # effects of <https://bugs.python.org/issue15002>
673 # introduced in Python 3.4.1.
674 err.fp._error = err
d391b7e2
S
675 return err.fp
676
aa94a6d3
PH
677 if errnote is False:
678 return False
d6983cb4 679 if errnote is None:
f1a9d64e 680 errnote = 'Unable to download webpage'
7f8b2714 681
9b9c5355 682 errmsg = '%s: %s' % (errnote, error_to_compat_str(err))
7cc3570e
PH
683 if fatal:
684 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
685 else:
686 self._downloader.report_warning(errmsg)
687 return False
d6983cb4 688
d391b7e2
S
689 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):
690 """
691 Return a tuple (page content as string, URL handle).
692
693 See _download_webpage docstring for arguments specification.
694 """
b9d3e163
PH
695 # Strip hashes from the URL (#1038)
696 if isinstance(url_or_request, (compat_str, str)):
697 url_or_request = url_or_request.partition('#')[0]
698
d391b7e2 699 urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal, data=data, headers=headers, query=query, expected_status=expected_status)
7cc3570e
PH
700 if urlh is False:
701 assert not fatal
702 return False
c9a77969 703 content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding)
23be51d8
PH
704 return (content, urlh)
705
c9a77969
YCH
706 @staticmethod
707 def _guess_encoding_from_content(content_type, webpage_bytes):
d6983cb4
PH
708 m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
709 if m:
710 encoding = m.group(1)
711 else:
0d75ae2c 712 m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
f143d86a
PH
713 webpage_bytes[:1024])
714 if m:
715 encoding = m.group(1).decode('ascii')
b60016e8
PH
716 elif webpage_bytes.startswith(b'\xff\xfe'):
717 encoding = 'utf-16'
f143d86a
PH
718 else:
719 encoding = 'utf-8'
c9a77969
YCH
720
721 return encoding
722
4457823d
S
723 def __check_blocked(self, content):
724 first_block = content[:512]
3089bc74
S
725 if ('<title>Access to this site is blocked</title>' in content
726 and 'Websense' in first_block):
4457823d
S
727 msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
728 blocked_iframe = self._html_search_regex(
729 r'<iframe src="([^"]+)"', content,
730 'Websense information URL', default=None)
731 if blocked_iframe:
732 msg += ' Visit %s for more details' % blocked_iframe
733 raise ExtractorError(msg, expected=True)
734 if '<title>The URL you requested has been blocked</title>' in first_block:
735 msg = (
736 'Access to this webpage has been blocked by Indian censorship. '
737 'Use a VPN or proxy server (with --proxy) to route around it.')
738 block_msg = self._html_search_regex(
739 r'</h1><p>(.*?)</p>',
740 content, 'block message', default=None)
741 if block_msg:
742 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
743 raise ExtractorError(msg, expected=True)
3089bc74
S
744 if ('<title>TTK :: Доступ к ресурсу ограничен</title>' in content
745 and 'blocklist.rkn.gov.ru' in content):
4457823d
S
746 raise ExtractorError(
747 'Access to this webpage has been blocked by decision of the Russian government. '
748 'Visit http://blocklist.rkn.gov.ru/ for a block reason.',
749 expected=True)
750
c9a77969
YCH
751 def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None):
752 content_type = urlh.headers.get('Content-Type', '')
753 webpage_bytes = urlh.read()
754 if prefix is not None:
755 webpage_bytes = prefix + webpage_bytes
756 if not encoding:
757 encoding = self._guess_encoding_from_content(content_type, webpage_bytes)
d6983cb4 758 if self._downloader.params.get('dump_intermediate_pages', False):
f610dbb0 759 self.to_screen('Dumping request to ' + urlh.geturl())
d6983cb4
PH
760 dump = base64.b64encode(webpage_bytes).decode('ascii')
761 self._downloader.to_screen(dump)
d41e6efc 762 if self._downloader.params.get('write_pages', False):
f610dbb0 763 basen = '%s_%s' % (video_id, urlh.geturl())
c1bce22f 764 if len(basen) > 240:
f1a9d64e 765 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
c1bce22f
PH
766 basen = basen[:240 - len(h)] + h
767 raw_filename = basen + '.dump'
d41e6efc 768 filename = sanitize_filename(raw_filename, restricted=True)
f1a9d64e 769 self.to_screen('Saving request to ' + filename)
5f58165d
S
770 # Working around MAX_PATH limitation on Windows (see
771 # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
e9c0cdd3 772 if compat_os_name == 'nt':
5f58165d
S
773 absfilepath = os.path.abspath(filename)
774 if len(absfilepath) > 259:
775 filename = '\\\\?\\' + absfilepath
d41e6efc
PH
776 with open(filename, 'wb') as outf:
777 outf.write(webpage_bytes)
778
ec0fafbb
AA
779 try:
780 content = webpage_bytes.decode(encoding, 'replace')
781 except LookupError:
782 content = webpage_bytes.decode('utf-8', 'replace')
2410c43d 783
4457823d 784 self.__check_blocked(content)
2410c43d 785
23be51d8 786 return content
d6983cb4 787
d391b7e2
S
788 def _download_webpage(
789 self, url_or_request, video_id, note=None, errnote=None,
790 fatal=True, tries=1, timeout=5, encoding=None, data=None,
791 headers={}, query={}, expected_status=None):
792 """
793 Return the data of the page as a string.
794
795 Arguments:
796 url_or_request -- plain text URL as a string or
797 a compat_urllib_request.Requestobject
798 video_id -- Video/playlist/item identifier (string)
799
800 Keyword arguments:
801 note -- note printed before downloading (string)
802 errnote -- note printed in case of an error (string)
803 fatal -- flag denoting whether error should be considered fatal,
804 i.e. whether it should cause ExtractionError to be raised,
805 otherwise a warning will be reported and extraction continued
806 tries -- number of tries
807 timeout -- sleep interval between tries
808 encoding -- encoding for a page content decoding, guessed automatically
809 when not explicitly specified
810 data -- POST data (bytes)
811 headers -- HTTP headers (dict)
812 query -- URL query (dict)
813 expected_status -- allows to accept failed HTTP requests (non 2xx
814 status code) by explicitly specifying a set of accepted status
815 codes. Can be any of the following entities:
816 - an integer type specifying an exact failed status code to
817 accept
818 - a list or a tuple of integer types specifying a list of
819 failed status codes to accept
820 - a callable accepting an actual failed status code and
821 returning True if it should be accepted
822 Note that this argument does not affect success status codes (2xx)
823 which are always accepted.
824 """
825
995ad69c
TF
826 success = False
827 try_count = 0
828 while success is False:
829 try:
d391b7e2
S
830 res = self._download_webpage_handle(
831 url_or_request, video_id, note, errnote, fatal,
832 encoding=encoding, data=data, headers=headers, query=query,
833 expected_status=expected_status)
995ad69c
TF
834 success = True
835 except compat_http_client.IncompleteRead as e:
836 try_count += 1
837 if try_count >= tries:
838 raise e
839 self._sleep(timeout, video_id)
7cc3570e
PH
840 if res is False:
841 return res
842 else:
843 content, _ = res
844 return content
d6983cb4 845
e0d198c1
S
846 def _download_xml_handle(
847 self, url_or_request, video_id, note='Downloading XML',
848 errnote='Unable to download XML', transform_source=None,
d391b7e2
S
849 fatal=True, encoding=None, data=None, headers={}, query={},
850 expected_status=None):
851 """
ee0ba927 852 Return a tuple (xml as an compat_etree_Element, URL handle).
d391b7e2
S
853
854 See _download_webpage docstring for arguments specification.
855 """
e0d198c1
S
856 res = self._download_webpage_handle(
857 url_or_request, video_id, note, errnote, fatal=fatal,
d391b7e2
S
858 encoding=encoding, data=data, headers=headers, query=query,
859 expected_status=expected_status)
e0d198c1
S
860 if res is False:
861 return res
862 xml_string, urlh = res
863 return self._parse_xml(
864 xml_string, video_id, transform_source=transform_source,
865 fatal=fatal), urlh
866
d391b7e2
S
867 def _download_xml(
868 self, url_or_request, video_id,
869 note='Downloading XML', errnote='Unable to download XML',
870 transform_source=None, fatal=True, encoding=None,
871 data=None, headers={}, query={}, expected_status=None):
872 """
ee0ba927 873 Return the xml as an compat_etree_Element.
d391b7e2
S
874
875 See _download_webpage docstring for arguments specification.
876 """
e0d198c1
S
877 res = self._download_xml_handle(
878 url_or_request, video_id, note=note, errnote=errnote,
879 transform_source=transform_source, fatal=fatal, encoding=encoding,
d391b7e2
S
880 data=data, headers=headers, query=query,
881 expected_status=expected_status)
e0d198c1 882 return res if res is False else res[0]
e01c3d2e
S
883
884 def _parse_xml(self, xml_string, video_id, transform_source=None, fatal=True):
e2b38da9
PH
885 if transform_source:
886 xml_string = transform_source(xml_string)
e01c3d2e
S
887 try:
888 return compat_etree_fromstring(xml_string.encode('utf-8'))
889 except compat_xml_parse_error as ve:
890 errmsg = '%s: Failed to parse XML ' % video_id
891 if fatal:
892 raise ExtractorError(errmsg, cause=ve)
893 else:
894 self.report_warning(errmsg + str(ve))
267ed0c5 895
0fe7783e
S
896 def _download_json_handle(
897 self, url_or_request, video_id, note='Downloading JSON metadata',
898 errnote='Unable to download JSON metadata', transform_source=None,
d391b7e2
S
899 fatal=True, encoding=None, data=None, headers={}, query={},
900 expected_status=None):
901 """
902 Return a tuple (JSON object, URL handle).
903
904 See _download_webpage docstring for arguments specification.
905 """
0fe7783e 906 res = self._download_webpage_handle(
c9a77969 907 url_or_request, video_id, note, errnote, fatal=fatal,
d391b7e2
S
908 encoding=encoding, data=data, headers=headers, query=query,
909 expected_status=expected_status)
0fe7783e
S
910 if res is False:
911 return res
912 json_string, urlh = res
ebb64199 913 return self._parse_json(
0fe7783e
S
914 json_string, video_id, transform_source=transform_source,
915 fatal=fatal), urlh
916
917 def _download_json(
918 self, url_or_request, video_id, note='Downloading JSON metadata',
919 errnote='Unable to download JSON metadata', transform_source=None,
d391b7e2
S
920 fatal=True, encoding=None, data=None, headers={}, query={},
921 expected_status=None):
922 """
923 Return the JSON object as a dict.
924
925 See _download_webpage docstring for arguments specification.
926 """
0fe7783e
S
927 res = self._download_json_handle(
928 url_or_request, video_id, note=note, errnote=errnote,
929 transform_source=transform_source, fatal=fatal, encoding=encoding,
d391b7e2
S
930 data=data, headers=headers, query=query,
931 expected_status=expected_status)
0fe7783e 932 return res if res is False else res[0]
ebb64199
TF
933
934 def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
81c2f20b
PH
935 if transform_source:
936 json_string = transform_source(json_string)
3d3538e4
PH
937 try:
938 return json.loads(json_string)
939 except ValueError as ve:
e7b6d122
PH
940 errmsg = '%s: Failed to parse JSON ' % video_id
941 if fatal:
942 raise ExtractorError(errmsg, cause=ve)
943 else:
944 self.report_warning(errmsg + str(ve))
3d3538e4 945
f45f96f8 946 def report_warning(self, msg, video_id=None):
f1a9d64e 947 idstr = '' if video_id is None else '%s: ' % video_id
f45f96f8 948 self._downloader.report_warning(
f1a9d64e 949 '[%s] %s%s' % (self.IE_NAME, idstr, msg))
f45f96f8 950
d6983cb4
PH
951 def to_screen(self, msg):
952 """Print msg to screen, prefixing it with '[ie_name]'"""
f1a9d64e 953 self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
d6983cb4
PH
954
955 def report_extraction(self, id_or_name):
956 """Report information extraction."""
f1a9d64e 957 self.to_screen('%s: Extracting information' % id_or_name)
d6983cb4
PH
958
959 def report_download_webpage(self, video_id):
960 """Report webpage download."""
f1a9d64e 961 self.to_screen('%s: Downloading webpage' % video_id)
d6983cb4
PH
962
963 def report_age_confirmation(self):
964 """Report attempt to confirm age."""
f1a9d64e 965 self.to_screen('Confirming age')
d6983cb4 966
fc79158d
JMF
967 def report_login(self):
968 """Report attempt to log in."""
f1a9d64e 969 self.to_screen('Logging in')
fc79158d 970
43e7d3c9
S
971 @staticmethod
972 def raise_login_required(msg='This video is only available for registered users'):
973 raise ExtractorError(
974 '%s. Use --username and --password or --netrc to provide account credentials.' % msg,
975 expected=True)
976
c430802e 977 @staticmethod
773f291d
S
978 def raise_geo_restricted(msg='This video is not available from your location due to geo restriction', countries=None):
979 raise GeoRestrictedError(msg, countries=countries)
c430802e 980
5f6a1245 981 # Methods for following #608
c0d0b01f 982 @staticmethod
830d53bf 983 def url_result(url, ie=None, video_id=None, video_title=None):
10952eb2 984 """Returns a URL that points to a page that should be processed"""
5f6a1245 985 # TODO: ie should be the class used for getting the info
d6983cb4
PH
986 video_info = {'_type': 'url',
987 'url': url,
988 'ie_key': ie}
7012b23c
PH
989 if video_id is not None:
990 video_info['id'] = video_id
830d53bf
S
991 if video_title is not None:
992 video_info['title'] = video_title
d6983cb4 993 return video_info
5f6a1245 994
749ca5ec
S
995 def playlist_from_matches(self, matches, playlist_id=None, playlist_title=None, getter=None, ie=None):
996 urls = orderedSet(
46b18f23
JH
997 self.url_result(self._proto_relative_url(getter(m) if getter else m), ie)
998 for m in matches)
999 return self.playlist_result(
749ca5ec 1000 urls, playlist_id=playlist_id, playlist_title=playlist_title)
46b18f23 1001
c0d0b01f 1002 @staticmethod
b60419c5 1003 def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None, **kwargs):
d6983cb4
PH
1004 """Returns a playlist"""
1005 video_info = {'_type': 'playlist',
1006 'entries': entries}
b60419c5 1007 video_info.update(kwargs)
d6983cb4
PH
1008 if playlist_id:
1009 video_info['id'] = playlist_id
1010 if playlist_title:
1011 video_info['title'] = playlist_title
ecc97af3 1012 if playlist_description is not None:
acf5cbfe 1013 video_info['description'] = playlist_description
d6983cb4
PH
1014 return video_info
1015
c342041f 1016 def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
1017 """
1018 Perform a regex search on the given string, using a single or a list of
1019 patterns returning the first matching group.
1020 In case of failure return a default value or raise a WARNING or a
55b3e45b 1021 RegexNotFoundError, depending on fatal, specifying the field name.
d6983cb4
PH
1022 """
1023 if isinstance(pattern, (str, compat_str, compiled_regex_type)):
1024 mobj = re.search(pattern, string, flags)
1025 else:
1026 for p in pattern:
1027 mobj = re.search(p, string, flags)
c3415d1b
PH
1028 if mobj:
1029 break
d6983cb4 1030
e9c0cdd3 1031 if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
f1a9d64e 1032 _name = '\033[0;34m%s\033[0m' % name
d6983cb4
PH
1033 else:
1034 _name = name
1035
1036 if mobj:
711ede6e
PH
1037 if group is None:
1038 # return the first matching group
1039 return next(g for g in mobj.groups() if g is not None)
1040 else:
1041 return mobj.group(group)
c342041f 1042 elif default is not NO_DEFAULT:
d6983cb4
PH
1043 return default
1044 elif fatal:
f1a9d64e 1045 raise RegexNotFoundError('Unable to extract %s' % _name)
d6983cb4 1046 else:
08f2a92c 1047 self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message())
d6983cb4
PH
1048 return None
1049
c342041f 1050 def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
1051 """
1052 Like _search_regex, but strips HTML tags and unescapes entities.
1053 """
711ede6e 1054 res = self._search_regex(pattern, string, name, default, fatal, flags, group)
d6983cb4
PH
1055 if res:
1056 return clean_html(res).strip()
1057 else:
1058 return res
1059
2118fdd1
RA
1060 def _get_netrc_login_info(self, netrc_machine=None):
1061 username = None
1062 password = None
1063 netrc_machine = netrc_machine or self._NETRC_MACHINE
1064
1065 if self._downloader.params.get('usenetrc', False):
1066 try:
1067 info = netrc.netrc().authenticators(netrc_machine)
1068 if info is not None:
1069 username = info[0]
1070 password = info[2]
1071 else:
dcce092e
S
1072 raise netrc.NetrcParseError(
1073 'No authenticators for %s' % netrc_machine)
2118fdd1 1074 except (IOError, netrc.NetrcParseError) as err:
dcce092e
S
1075 self._downloader.report_warning(
1076 'parsing .netrc: %s' % error_to_compat_str(err))
2118fdd1 1077
dcce092e 1078 return username, password
2118fdd1 1079
1b6712ab 1080 def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
fc79158d 1081 """
cf0649f8 1082 Get the login info as (username, password)
32443dd3
S
1083 First look for the manually specified credentials using username_option
1084 and password_option as keys in params dictionary. If no such credentials
1085 available look in the netrc file using the netrc_machine or _NETRC_MACHINE
1086 value.
fc79158d
JMF
1087 If there's no info available, return (None, None)
1088 """
1089 if self._downloader is None:
1090 return (None, None)
1091
fc79158d
JMF
1092 downloader_params = self._downloader.params
1093
1094 # Attempt to use provided username and password or .netrc data
1b6712ab
RA
1095 if downloader_params.get(username_option) is not None:
1096 username = downloader_params[username_option]
1097 password = downloader_params[password_option]
2118fdd1 1098 else:
1b6712ab 1099 username, password = self._get_netrc_login_info(netrc_machine)
5f6a1245 1100
2133565c 1101 return username, password
fc79158d 1102
e64b7569 1103 def _get_tfa_info(self, note='two-factor verification code'):
83317f69 1104 """
1105 Get the two-factor authentication info
1106 TODO - asking the user will be required for sms/phone verify
1107 currently just uses the command line option
1108 If there's no info available, return None
1109 """
1110 if self._downloader is None:
83317f69 1111 return None
1112 downloader_params = self._downloader.params
1113
d800609c 1114 if downloader_params.get('twofactor') is not None:
83317f69 1115 return downloader_params['twofactor']
1116
e64b7569 1117 return compat_getpass('Type %s and press [Return]: ' % note)
83317f69 1118
46720279
JMF
1119 # Helper functions for extracting OpenGraph info
1120 @staticmethod
ab2d5247 1121 def _og_regexes(prop):
448ef1f3 1122 content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
22f5f5c6 1123 property_re = (r'(?:name|property)=(?:\'og[:-]%(prop)s\'|"og[:-]%(prop)s"|\s*og[:-]%(prop)s\b)'
7a6d76a6 1124 % {'prop': re.escape(prop)})
78fb87b2 1125 template = r'<meta[^>]+?%s[^>]+?%s'
ab2d5247 1126 return [
78fb87b2
JMF
1127 template % (property_re, content_re),
1128 template % (content_re, property_re),
ab2d5247 1129 ]
46720279 1130
864f24bd
S
1131 @staticmethod
1132 def _meta_regex(prop):
1133 return r'''(?isx)<meta
8b9848ac 1134 (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
864f24bd
S
1135 [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
1136
3c4e6d83 1137 def _og_search_property(self, prop, html, name=None, **kargs):
b070564e
S
1138 if not isinstance(prop, (list, tuple)):
1139 prop = [prop]
46720279 1140 if name is None:
b070564e
S
1141 name = 'OpenGraph %s' % prop[0]
1142 og_regexes = []
1143 for p in prop:
1144 og_regexes.extend(self._og_regexes(p))
1145 escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
eb0a8398
PH
1146 if escaped is None:
1147 return None
1148 return unescapeHTML(escaped)
46720279
JMF
1149
1150 def _og_search_thumbnail(self, html, **kargs):
10952eb2 1151 return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
46720279
JMF
1152
1153 def _og_search_description(self, html, **kargs):
1154 return self._og_search_property('description', html, fatal=False, **kargs)
1155
1156 def _og_search_title(self, html, **kargs):
1157 return self._og_search_property('title', html, **kargs)
1158
8ffa13e0 1159 def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
a3681973
PH
1160 regexes = self._og_regexes('video') + self._og_regexes('video:url')
1161 if secure:
1162 regexes = self._og_regexes('video:secure_url') + regexes
8ffa13e0 1163 return self._html_search_regex(regexes, html, name, **kargs)
46720279 1164
78338f71
JMF
1165 def _og_search_url(self, html, **kargs):
1166 return self._og_search_property('url', html, **kargs)
1167
40c696e5 1168 def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
88d9f6c0
S
1169 if not isinstance(name, (list, tuple)):
1170 name = [name]
59040888 1171 if display_name is None:
88d9f6c0 1172 display_name = name[0]
59040888 1173 return self._html_search_regex(
88d9f6c0 1174 [self._meta_regex(n) for n in name],
711ede6e 1175 html, display_name, fatal=fatal, group='content', **kwargs)
59040888
PH
1176
1177 def _dc_search_uploader(self, html):
1178 return self._html_search_meta('dc.creator', html, 'uploader')
1179
8dbe9899
PH
1180 def _rta_search(self, html):
1181 # See http://www.rtalabel.org/index.php?content=howtofaq#single
1182 if re.search(r'(?ix)<meta\s+name="rating"\s+'
1183 r' content="RTA-5042-1996-1400-1577-RTA"',
1184 html):
1185 return 18
1186 return 0
1187
59040888
PH
1188 def _media_rating_search(self, html):
1189 # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
1190 rating = self._html_search_meta('rating', html)
1191
1192 if not rating:
1193 return None
1194
1195 RATING_TABLE = {
1196 'safe for kids': 0,
1197 'general': 8,
1198 '14 years': 14,
1199 'mature': 17,
1200 'restricted': 19,
1201 }
d800609c 1202 return RATING_TABLE.get(rating.lower())
59040888 1203
69319969 1204 def _family_friendly_search(self, html):
6ca7732d 1205 # See http://schema.org/VideoObject
ac8491fc
S
1206 family_friendly = self._html_search_meta(
1207 'isFamilyFriendly', html, default=None)
69319969
NJ
1208
1209 if not family_friendly:
1210 return None
1211
1212 RATING_TABLE = {
1213 '1': 0,
1214 'true': 0,
1215 '0': 18,
1216 'false': 18,
1217 }
d800609c 1218 return RATING_TABLE.get(family_friendly.lower())
69319969 1219
0c708f11
JMF
1220 def _twitter_search_player(self, html):
1221 return self._html_search_meta('twitter:player', html,
9e1a5b84 1222 'twitter card player')
0c708f11 1223
95b31e26 1224 def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
4433bb02 1225 json_ld_list = list(re.finditer(JSON_LD_RE, html))
321b5e08 1226 default = kwargs.get('default', NO_DEFAULT)
321b5e08
S
1227 # JSON-LD may be malformed and thus `fatal` should be respected.
1228 # At the same time `default` may be passed that assumes `fatal=False`
1229 # for _search_regex. Let's simulate the same behavior here as well.
1230 fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
4433bb02
S
1231 json_ld = []
1232 for mobj in json_ld_list:
1233 json_ld_item = self._parse_json(
1234 mobj.group('json_ld'), video_id, fatal=fatal)
1235 if not json_ld_item:
1236 continue
1237 if isinstance(json_ld_item, dict):
1238 json_ld.append(json_ld_item)
1239 elif isinstance(json_ld_item, (list, tuple)):
1240 json_ld.extend(json_ld_item)
1241 if json_ld:
1242 json_ld = self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
1243 if json_ld:
1244 return json_ld
1245 if default is not NO_DEFAULT:
1246 return default
1247 elif fatal:
1248 raise RegexNotFoundError('Unable to extract JSON-LD')
1249 else:
1250 self._downloader.report_warning('unable to extract JSON-LD %s' % bug_reports_message())
1251 return {}
4ca2a3cf 1252
95b31e26 1253 def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
4ca2a3cf
S
1254 if isinstance(json_ld, compat_str):
1255 json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
1256 if not json_ld:
1257 return {}
1258 info = {}
46933a15
S
1259 if not isinstance(json_ld, (list, tuple, dict)):
1260 return info
1261 if isinstance(json_ld, dict):
1262 json_ld = [json_ld]
bae14048 1263
e7e4a6e0
S
1264 INTERACTION_TYPE_MAP = {
1265 'CommentAction': 'comment',
1266 'AgreeAction': 'like',
1267 'DisagreeAction': 'dislike',
1268 'LikeAction': 'like',
1269 'DislikeAction': 'dislike',
1270 'ListenAction': 'view',
1271 'WatchAction': 'view',
1272 'ViewAction': 'view',
1273 }
1274
29f7c58a 1275 def extract_interaction_type(e):
1276 interaction_type = e.get('interactionType')
1277 if isinstance(interaction_type, dict):
1278 interaction_type = interaction_type.get('@type')
1279 return str_or_none(interaction_type)
1280
e7e4a6e0
S
1281 def extract_interaction_statistic(e):
1282 interaction_statistic = e.get('interactionStatistic')
29f7c58a 1283 if isinstance(interaction_statistic, dict):
1284 interaction_statistic = [interaction_statistic]
e7e4a6e0
S
1285 if not isinstance(interaction_statistic, list):
1286 return
1287 for is_e in interaction_statistic:
1288 if not isinstance(is_e, dict):
1289 continue
1290 if is_e.get('@type') != 'InteractionCounter':
1291 continue
29f7c58a 1292 interaction_type = extract_interaction_type(is_e)
1293 if not interaction_type:
e7e4a6e0 1294 continue
ce5b9040
S
1295 # For interaction count some sites provide string instead of
1296 # an integer (as per spec) with non digit characters (e.g. ",")
1297 # so extracting count with more relaxed str_to_int
1298 interaction_count = str_to_int(is_e.get('userInteractionCount'))
e7e4a6e0
S
1299 if interaction_count is None:
1300 continue
1301 count_kind = INTERACTION_TYPE_MAP.get(interaction_type.split('/')[-1])
1302 if not count_kind:
1303 continue
1304 count_key = '%s_count' % count_kind
1305 if info.get(count_key) is not None:
1306 continue
1307 info[count_key] = interaction_count
1308
bae14048
S
1309 def extract_video_object(e):
1310 assert e['@type'] == 'VideoObject'
1311 info.update({
bebef109 1312 'url': url_or_none(e.get('contentUrl')),
bae14048
S
1313 'title': unescapeHTML(e.get('name')),
1314 'description': unescapeHTML(e.get('description')),
bebef109 1315 'thumbnail': url_or_none(e.get('thumbnailUrl') or e.get('thumbnailURL')),
bae14048
S
1316 'duration': parse_duration(e.get('duration')),
1317 'timestamp': unified_timestamp(e.get('uploadDate')),
ad06b99d 1318 'uploader': str_or_none(e.get('author')),
bae14048
S
1319 'filesize': float_or_none(e.get('contentSize')),
1320 'tbr': int_or_none(e.get('bitrate')),
1321 'width': int_or_none(e.get('width')),
1322 'height': int_or_none(e.get('height')),
33a81c2c 1323 'view_count': int_or_none(e.get('interactionCount')),
bae14048 1324 })
e7e4a6e0 1325 extract_interaction_statistic(e)
bae14048 1326
46933a15 1327 for e in json_ld:
4433bb02 1328 if '@context' in e:
46933a15
S
1329 item_type = e.get('@type')
1330 if expected_type is not None and expected_type != item_type:
4433bb02 1331 continue
c69701c6 1332 if item_type in ('TVEpisode', 'Episode'):
440863ad 1333 episode_name = unescapeHTML(e.get('name'))
46933a15 1334 info.update({
440863ad 1335 'episode': episode_name,
46933a15
S
1336 'episode_number': int_or_none(e.get('episodeNumber')),
1337 'description': unescapeHTML(e.get('description')),
1338 })
440863ad
S
1339 if not info.get('title') and episode_name:
1340 info['title'] = episode_name
46933a15 1341 part_of_season = e.get('partOfSeason')
c69701c6 1342 if isinstance(part_of_season, dict) and part_of_season.get('@type') in ('TVSeason', 'Season', 'CreativeWorkSeason'):
458fd30f
S
1343 info.update({
1344 'season': unescapeHTML(part_of_season.get('name')),
1345 'season_number': int_or_none(part_of_season.get('seasonNumber')),
1346 })
d16b3c66 1347 part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
c69701c6 1348 if isinstance(part_of_series, dict) and part_of_series.get('@type') in ('TVSeries', 'Series', 'CreativeWorkSeries'):
46933a15 1349 info['series'] = unescapeHTML(part_of_series.get('name'))
391256dc
S
1350 elif item_type == 'Movie':
1351 info.update({
1352 'title': unescapeHTML(e.get('name')),
1353 'description': unescapeHTML(e.get('description')),
1354 'duration': parse_duration(e.get('duration')),
1355 'timestamp': unified_timestamp(e.get('dateCreated')),
1356 })
3931b845 1357 elif item_type in ('Article', 'NewsArticle'):
46933a15
S
1358 info.update({
1359 'timestamp': parse_iso8601(e.get('datePublished')),
1360 'title': unescapeHTML(e.get('headline')),
1361 'description': unescapeHTML(e.get('articleBody')),
1362 })
1363 elif item_type == 'VideoObject':
bae14048 1364 extract_video_object(e)
4433bb02
S
1365 if expected_type is None:
1366 continue
1367 else:
1368 break
c69701c6
S
1369 video = e.get('video')
1370 if isinstance(video, dict) and video.get('@type') == 'VideoObject':
1371 extract_video_object(video)
4433bb02
S
1372 if expected_type is None:
1373 continue
1374 else:
1375 break
4ca2a3cf
S
1376 return dict((k, v) for k, v in info.items() if v is not None)
1377
27713812 1378 @staticmethod
f8da79f8 1379 def _hidden_inputs(html):
586f1cc5 1380 html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
201ea3ee 1381 hidden_inputs = {}
c8498368
S
1382 for input in re.findall(r'(?i)(<input[^>]+>)', html):
1383 attrs = extract_attributes(input)
1384 if not input:
201ea3ee 1385 continue
c8498368 1386 if attrs.get('type') not in ('hidden', 'submit'):
201ea3ee 1387 continue
c8498368
S
1388 name = attrs.get('name') or attrs.get('id')
1389 value = attrs.get('value')
1390 if name and value is not None:
1391 hidden_inputs[name] = value
201ea3ee 1392 return hidden_inputs
27713812 1393
cf61d96d
S
1394 def _form_hidden_inputs(self, form_id, html):
1395 form = self._search_regex(
73eb13df 1396 r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
cf61d96d
S
1397 html, '%s form' % form_id, group='form')
1398 return self._hidden_inputs(form)
1399
eb8a4433 1400 class FormatSort:
1401 regex = r' *((?P<reverse>\+)?(?P<field>[a-zA-Z0-9_]+)((?P<seperator>[~:])(?P<limit>.*?))?)? *$'
1402
c10d0213 1403 default = ('hidden', 'hasvid', 'ie_pref', 'lang', 'quality',
155d2b48 1404 'res', 'fps', 'codec:vp9.2', 'size', 'br', 'asr',
c10d0213 1405 'proto', 'ext', 'has_audio', 'source', 'format_id') # These must not be aliases
eb8a4433 1406
1407 settings = {
1408 'vcodec': {'type': 'ordered', 'regex': True,
155d2b48 1409 'order': ['av0?1', 'vp0?9.2', 'vp0?9', '[hx]265|he?vc?', '[hx]264|avc', 'vp0?8', 'mp4v|h263', 'theora', '', None, 'none']},
eb8a4433 1410 'acodec': {'type': 'ordered', 'regex': True,
1411 'order': ['opus', 'vorbis', 'aac', 'mp?4a?', 'mp3', 'e?a?c-?3', 'dts', '', None, 'none']},
f137c99e 1412 'proto': {'type': 'ordered', 'regex': True, 'field': 'protocol',
63be1aab 1413 'order': ['(ht|f)tps', '(ht|f)tp$', 'm3u8.+', 'm3u8', '.*dash', '', 'mms|rtsp', 'none', 'f4']},
eb8a4433 1414 'vext': {'type': 'ordered', 'field': 'video_ext',
91ebc640 1415 'order': ('mp4', 'webm', 'flv', '', 'none'),
eb8a4433 1416 'order_free': ('webm', 'mp4', 'flv', '', 'none')},
1417 'aext': {'type': 'ordered', 'field': 'audio_ext',
1418 'order': ('m4a', 'aac', 'mp3', 'ogg', 'opus', 'webm', '', 'none'),
1419 'order_free': ('opus', 'ogg', 'webm', 'm4a', 'mp3', 'aac', '', 'none')},
1420 'hidden': {'visible': False, 'forced': True, 'type': 'extractor', 'max': -1000},
f983b875 1421 'ie_pref': {'priority': True, 'type': 'extractor'},
63be1aab 1422 'hasvid': {'priority': True, 'field': 'vcodec', 'type': 'boolean', 'not_in_list': ('none',)},
1423 'hasaud': {'field': 'acodec', 'type': 'boolean', 'not_in_list': ('none',)},
e4beae70 1424 'lang': {'priority': True, 'convert': 'ignore', 'field': 'language_preference'},
1425 'quality': {'convert': 'float_none'},
eb8a4433 1426 'filesize': {'convert': 'bytes'},
f137c99e 1427 'fs_approx': {'convert': 'bytes', 'field': 'filesize_approx'},
1428 'id': {'convert': 'string', 'field': 'format_id'},
eb8a4433 1429 'height': {'convert': 'float_none'},
1430 'width': {'convert': 'float_none'},
1431 'fps': {'convert': 'float_none'},
1432 'tbr': {'convert': 'float_none'},
1433 'vbr': {'convert': 'float_none'},
1434 'abr': {'convert': 'float_none'},
1435 'asr': {'convert': 'float_none'},
e4beae70 1436 'source': {'convert': 'ignore', 'field': 'source_preference'},
63be1aab 1437
eb8a4433 1438 'codec': {'type': 'combined', 'field': ('vcodec', 'acodec')},
63be1aab 1439 'br': {'type': 'combined', 'field': ('tbr', 'vbr', 'abr'), 'same_limit': True},
1440 'size': {'type': 'combined', 'same_limit': True, 'field': ('filesize', 'fs_approx')},
1441 'ext': {'type': 'combined', 'field': ('vext', 'aext')},
1442 'res': {'type': 'multiple', 'field': ('height', 'width'), 'function': min},
1443
1444 # Most of these exist only for compatibility reasons
1445 'dimension': {'type': 'alias', 'field': 'res'},
1446 'resolution': {'type': 'alias', 'field': 'res'},
1447 'extension': {'type': 'alias', 'field': 'ext'},
1448 'bitrate': {'type': 'alias', 'field': 'br'},
eb8a4433 1449 'total_bitrate': {'type': 'alias', 'field': 'tbr'},
1450 'video_bitrate': {'type': 'alias', 'field': 'vbr'},
1451 'audio_bitrate': {'type': 'alias', 'field': 'abr'},
1452 'framerate': {'type': 'alias', 'field': 'fps'},
63be1aab 1453 'language_preference': {'type': 'alias', 'field': 'lang'}, # not named as 'language' because such a field exists
1454 'protocol': {'type': 'alias', 'field': 'proto'},
1455 'source_preference': {'type': 'alias', 'field': 'source'},
1456 'filesize_approx': {'type': 'alias', 'field': 'fs_approx'},
1457 'filesize_estimate': {'type': 'alias', 'field': 'size'},
eb8a4433 1458 'samplerate': {'type': 'alias', 'field': 'asr'},
1459 'video_ext': {'type': 'alias', 'field': 'vext'},
1460 'audio_ext': {'type': 'alias', 'field': 'aext'},
1461 'video_codec': {'type': 'alias', 'field': 'vcodec'},
1462 'audio_codec': {'type': 'alias', 'field': 'acodec'},
63be1aab 1463 'video': {'type': 'alias', 'field': 'hasvid'},
1464 'has_video': {'type': 'alias', 'field': 'hasvid'},
1465 'audio': {'type': 'alias', 'field': 'hasaud'},
1466 'has_audio': {'type': 'alias', 'field': 'hasaud'},
1467 'extractor': {'type': 'alias', 'field': 'ie_pref'},
1468 'preference': {'type': 'alias', 'field': 'ie_pref'},
1469 'extractor_preference': {'type': 'alias', 'field': 'ie_pref'},
1470 'format_id': {'type': 'alias', 'field': 'id'},
1471 }
eb8a4433 1472
1473 _order = []
1474
1475 def _get_field_setting(self, field, key):
1476 if field not in self.settings:
1477 self.settings[field] = {}
1478 propObj = self.settings[field]
1479 if key not in propObj:
1480 type = propObj.get('type')
1481 if key == 'field':
1482 default = 'preference' if type == 'extractor' else (field,) if type in ('combined', 'multiple') else field
1483 elif key == 'convert':
1484 default = 'order' if type == 'ordered' else 'float_string' if field else 'ignore'
4bcc7bd1 1485 else:
eb8a4433 1486 default = {'type': 'field', 'visible': True, 'order': [], 'not_in_list': (None,), 'function': max}.get(key, None)
1487 propObj[key] = default
1488 return propObj[key]
1489
1490 def _resolve_field_value(self, field, value, convertNone=False):
1491 if value is None:
1492 if not convertNone:
1493 return None
4bcc7bd1 1494 else:
eb8a4433 1495 value = value.lower()
1496 conversion = self._get_field_setting(field, 'convert')
1497 if conversion == 'ignore':
1498 return None
1499 if conversion == 'string':
1500 return value
1501 elif conversion == 'float_none':
1502 return float_or_none(value)
1503 elif conversion == 'bytes':
1504 return FileDownloader.parse_bytes(value)
1505 elif conversion == 'order':
da9be05e 1506 order_list = (self._use_free_order and self._get_field_setting(field, 'order_free')) or self._get_field_setting(field, 'order')
eb8a4433 1507 use_regex = self._get_field_setting(field, 'regex')
1508 list_length = len(order_list)
1509 empty_pos = order_list.index('') if '' in order_list else list_length + 1
1510 if use_regex and value is not None:
da9be05e 1511 for i, regex in enumerate(order_list):
eb8a4433 1512 if regex and re.match(regex, value):
1513 return list_length - i
1514 return list_length - empty_pos # not in list
1515 else: # not regex or value = None
1516 return list_length - (order_list.index(value) if value in order_list else empty_pos)
1517 else:
1518 if value.isnumeric():
1519 return float(value)
4bcc7bd1 1520 else:
eb8a4433 1521 self.settings[field]['convert'] = 'string'
1522 return value
1523
1524 def evaluate_params(self, params, sort_extractor):
1525 self._use_free_order = params.get('prefer_free_formats', False)
1526 self._sort_user = params.get('format_sort', [])
1527 self._sort_extractor = sort_extractor
1528
1529 def add_item(field, reverse, closest, limit_text):
1530 field = field.lower()
1531 if field in self._order:
1532 return
1533 self._order.append(field)
1534 limit = self._resolve_field_value(field, limit_text)
1535 data = {
1536 'reverse': reverse,
1537 'closest': False if limit is None else closest,
1538 'limit_text': limit_text,
1539 'limit': limit}
1540 if field in self.settings:
1541 self.settings[field].update(data)
1542 else:
1543 self.settings[field] = data
1544
1545 sort_list = (
1546 tuple(field for field in self.default if self._get_field_setting(field, 'forced'))
1547 + (tuple() if params.get('format_sort_force', False)
1548 else tuple(field for field in self.default if self._get_field_setting(field, 'priority')))
1549 + tuple(self._sort_user) + tuple(sort_extractor) + self.default)
1550
1551 for item in sort_list:
1552 match = re.match(self.regex, item)
1553 if match is None:
1554 raise ExtractorError('Invalid format sort string "%s" given by extractor' % item)
1555 field = match.group('field')
1556 if field is None:
1557 continue
1558 if self._get_field_setting(field, 'type') == 'alias':
1559 field = self._get_field_setting(field, 'field')
1560 reverse = match.group('reverse') is not None
1561 closest = match.group('seperator') == '~'
1562 limit_text = match.group('limit')
1563
1564 has_limit = limit_text is not None
1565 has_multiple_fields = self._get_field_setting(field, 'type') == 'combined'
1566 has_multiple_limits = has_limit and has_multiple_fields and not self._get_field_setting(field, 'same_limit')
1567
1568 fields = self._get_field_setting(field, 'field') if has_multiple_fields else (field,)
1569 limits = limit_text.split(":") if has_multiple_limits else (limit_text,) if has_limit else tuple()
1570 limit_count = len(limits)
1571 for (i, f) in enumerate(fields):
1572 add_item(f, reverse, closest,
1573 limits[i] if i < limit_count
1574 else limits[0] if has_limit and not has_multiple_limits
1575 else None)
1576
1577 def print_verbose_info(self, to_screen):
1578 to_screen('[debug] Sort order given by user: %s' % ','.join(self._sort_user))
1579 if self._sort_extractor:
f983b875 1580 to_screen('[debug] Sort order given by extractor: %s' % ', '.join(self._sort_extractor))
eb8a4433 1581 to_screen('[debug] Formats sorted by: %s' % ', '.join(['%s%s%s' % (
1582 '+' if self._get_field_setting(field, 'reverse') else '', field,
1583 '%s%s(%s)' % ('~' if self._get_field_setting(field, 'closest') else ':',
1584 self._get_field_setting(field, 'limit_text'),
1585 self._get_field_setting(field, 'limit'))
1586 if self._get_field_setting(field, 'limit_text') is not None else '')
1587 for field in self._order if self._get_field_setting(field, 'visible')]))
1588
1589 def _calculate_field_preference_from_value(self, format, field, type, value):
1590 reverse = self._get_field_setting(field, 'reverse')
1591 closest = self._get_field_setting(field, 'closest')
1592 limit = self._get_field_setting(field, 'limit')
1593
1594 if type == 'extractor':
1595 maximum = self._get_field_setting(field, 'max')
1596 if value is None or (maximum is not None and value >= maximum):
f983b875 1597 value = -1
eb8a4433 1598 elif type == 'boolean':
1599 in_list = self._get_field_setting(field, 'in_list')
1600 not_in_list = self._get_field_setting(field, 'not_in_list')
1601 value = 0 if ((in_list is None or value in in_list) and (not_in_list is None or value not in not_in_list)) else -1
1602 elif type == 'ordered':
1603 value = self._resolve_field_value(field, value, True)
1604
1605 # try to convert to number
1606 val_num = float_or_none(value)
1607 is_num = self._get_field_setting(field, 'convert') != 'string' and val_num is not None
1608 if is_num:
1609 value = val_num
1610
1611 return ((-10, 0) if value is None
1612 else (1, value, 0) if not is_num # if a field has mixed strings and numbers, strings are sorted higher
1613 else (0, -abs(value - limit), value - limit if reverse else limit - value) if closest
1614 else (0, value, 0) if not reverse and (limit is None or value <= limit)
1615 else (0, -value, 0) if limit is None or (reverse and value == limit) or value > limit
1616 else (-1, value, 0))
1617
1618 def _calculate_field_preference(self, format, field):
1619 type = self._get_field_setting(field, 'type') # extractor, boolean, ordered, field, multiple
1620 get_value = lambda f: format.get(self._get_field_setting(f, 'field'))
1621 if type == 'multiple':
1622 type = 'field' # Only 'field' is allowed in multiple for now
1623 actual_fields = self._get_field_setting(field, 'field')
1624
1625 def wrapped_function(values):
1626 values = tuple(filter(lambda x: x is not None, values))
1627 return (self._get_field_setting(field, 'function')(*values) if len(values) > 1
1628 else values[0] if values
1629 else None)
1630
1631 value = wrapped_function((get_value(f) for f in actual_fields))
1632 else:
1633 value = get_value(field)
1634 return self._calculate_field_preference_from_value(format, field, type, value)
1635
1636 def calculate_preference(self, format):
1637 # Determine missing protocol
1638 if not format.get('protocol'):
1639 format['protocol'] = determine_protocol(format)
1640
1641 # Determine missing ext
1642 if not format.get('ext') and 'url' in format:
1643 format['ext'] = determine_ext(format['url'])
1644 if format.get('vcodec') == 'none':
1645 format['audio_ext'] = format['ext']
1646 format['video_ext'] = 'none'
1647 else:
1648 format['video_ext'] = format['ext']
1649 format['audio_ext'] = 'none'
1650 # if format.get('preference') is None and format.get('ext') in ('f4f', 'f4m'): # Not supported?
1651 # format['preference'] = -1000
1652
1653 # Determine missing bitrates
1654 if format.get('tbr') is None:
1655 if format.get('vbr') is not None and format.get('abr') is not None:
1656 format['tbr'] = format.get('vbr', 0) + format.get('abr', 0)
1657 else:
1658 if format.get('vcodec') != "none" and format.get('vbr') is None:
1659 format['vbr'] = format.get('tbr') - format.get('abr', 0)
1660 if format.get('acodec') != "none" and format.get('abr') is None:
1661 format['abr'] = format.get('tbr') - format.get('vbr', 0)
1662
1663 return tuple(self._calculate_field_preference(format, field) for field in self._order)
1664
1665 def _sort_formats(self, formats, field_preference=[]):
1666 if not formats:
1667 raise ExtractorError('No video formats found')
1668 format_sort = self.FormatSort() # params and to_screen are taken from the downloader
1669 format_sort.evaluate_params(self._downloader.params, field_preference)
1670 if self._downloader.params.get('verbose', False):
1671 format_sort.print_verbose_info(self._downloader.to_screen)
1672 formats.sort(key=lambda f: format_sort.calculate_preference(f))
59040888 1673
96a53167
S
1674 def _check_formats(self, formats, video_id):
1675 if formats:
1676 formats[:] = filter(
1677 lambda f: self._is_valid_url(
1678 f['url'], video_id,
1679 item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
1680 formats)
1681
f5bdb444
S
1682 @staticmethod
1683 def _remove_duplicate_formats(formats):
1684 format_urls = set()
1685 unique_formats = []
1686 for f in formats:
1687 if f['url'] not in format_urls:
1688 format_urls.add(f['url'])
1689 unique_formats.append(f)
1690 formats[:] = unique_formats
1691
45024183 1692 def _is_valid_url(self, url, video_id, item='video', headers={}):
2f0f6578
S
1693 url = self._proto_relative_url(url, scheme='http:')
1694 # For now assume non HTTP(S) URLs always valid
1695 if not (url.startswith('http://') or url.startswith('https://')):
1696 return True
96a53167 1697 try:
45024183 1698 self._request_webpage(url, video_id, 'Checking %s URL' % item, headers=headers)
96a53167 1699 return True
8bdd16b4 1700 except ExtractorError as e:
25e911a9 1701 self.to_screen(
8bdd16b4 1702 '%s: %s URL is invalid, skipping: %s'
1703 % (video_id, item, error_to_compat_str(e.cause)))
25e911a9 1704 return False
96a53167 1705
20991253 1706 def http_scheme(self):
1ede5b24 1707 """ Either "http:" or "https:", depending on the user's preferences """
20991253
PH
1708 return (
1709 'http:'
1710 if self._downloader.params.get('prefer_insecure', False)
1711 else 'https:')
1712
57c7411f
PH
1713 def _proto_relative_url(self, url, scheme=None):
1714 if url is None:
1715 return url
1716 if url.startswith('//'):
1717 if scheme is None:
1718 scheme = self.http_scheme()
1719 return scheme + url
1720 else:
1721 return url
1722
4094b6e3
PH
1723 def _sleep(self, timeout, video_id, msg_template=None):
1724 if msg_template is None:
f1a9d64e 1725 msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
4094b6e3
PH
1726 msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1727 self.to_screen(msg)
1728 time.sleep(timeout)
1729
f983b875 1730 def _extract_f4m_formats(self, manifest_url, video_id, preference=None, quality=None, f4m_id=None,
4de61310 1731 transform_source=lambda s: fix_xml_ampersands(s).strip(),
7360c06f 1732 fatal=True, m3u8_id=None, data=None, headers={}, query={}):
f036a632
JMF
1733 manifest = self._download_xml(
1734 manifest_url, video_id, 'Downloading f4m manifest',
97f4aecf
S
1735 'Unable to download f4m manifest',
1736 # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
067aa17e 1737 # (see https://github.com/ytdl-org/youtube-dl/issues/6215#issuecomment-121704244)
4de61310 1738 transform_source=transform_source,
7360c06f 1739 fatal=fatal, data=data, headers=headers, query=query)
4de61310
S
1740
1741 if manifest is False:
8d29e47f 1742 return []
31bb8d3f 1743
0fdbb332 1744 return self._parse_f4m_formats(
f983b875 1745 manifest, manifest_url, video_id, preference=preference, quality=quality, f4m_id=f4m_id,
448bb5f3 1746 transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
0fdbb332 1747
f983b875 1748 def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, quality=None, f4m_id=None,
0fdbb332 1749 transform_source=lambda s: fix_xml_ampersands(s).strip(),
448bb5f3 1750 fatal=True, m3u8_id=None):
ee0ba927 1751 if not isinstance(manifest, compat_etree_Element) and not fatal:
d9eb580a
S
1752 return []
1753
7a5c1cfe 1754 # currently yt-dlp cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
fb72ec58 1755 akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1756 if akamai_pv is not None and ';' in akamai_pv.text:
1757 playerVerificationChallenge = akamai_pv.text.split(';')[0]
1758 if playerVerificationChallenge.strip() != '':
1759 return []
1760
31bb8d3f 1761 formats = []
7a47d07c 1762 manifest_version = '1.0'
b2527359 1763 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
34e48bed 1764 if not media_nodes:
7a47d07c 1765 manifest_version = '2.0'
34e48bed 1766 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
b22ca762 1767 # Remove unsupported DRM protected media from final formats
067aa17e 1768 # rendition (see https://github.com/ytdl-org/youtube-dl/issues/8573).
b22ca762
S
1769 media_nodes = remove_encrypted_media(media_nodes)
1770 if not media_nodes:
1771 return formats
48107c19
S
1772
1773 manifest_base_url = get_base_url(manifest)
0a5685b2 1774
a6571f10 1775 bootstrap_info = xpath_element(
0a5685b2
YCH
1776 manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1777 'bootstrap info', default=None)
1778
edd6074c
RA
1779 vcodec = None
1780 mime_type = xpath_text(
1781 manifest, ['{http://ns.adobe.com/f4m/1.0}mimeType', '{http://ns.adobe.com/f4m/2.0}mimeType'],
1782 'base URL', default=None)
1783 if mime_type and mime_type.startswith('audio/'):
1784 vcodec = 'none'
1785
b2527359 1786 for i, media_el in enumerate(media_nodes):
77b8b4e6
S
1787 tbr = int_or_none(media_el.attrib.get('bitrate'))
1788 width = int_or_none(media_el.attrib.get('width'))
1789 height = int_or_none(media_el.attrib.get('height'))
1790 format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
448bb5f3
YCH
1791 # If <bootstrapInfo> is present, the specified f4m is a
1792 # stream-level manifest, and only set-level manifests may refer to
1793 # external resources. See section 11.4 and section 4 of F4M spec
1794 if bootstrap_info is None:
1795 media_url = None
1796 # @href is introduced in 2.0, see section 11.6 of F4M spec
1797 if manifest_version == '2.0':
1798 media_url = media_el.attrib.get('href')
1799 if media_url is None:
1800 media_url = media_el.attrib.get('url')
31c746e5
S
1801 if not media_url:
1802 continue
cc357c4d
S
1803 manifest_url = (
1804 media_url if media_url.startswith('http://') or media_url.startswith('https://')
48107c19 1805 else ((manifest_base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
70f0f5a8
S
1806 # If media_url is itself a f4m manifest do the recursive extraction
1807 # since bitrates in parent manifest (this one) and media_url manifest
1808 # may differ leading to inability to resolve the format by requested
1809 # bitrate in f4m downloader
240b6045
YCH
1810 ext = determine_ext(manifest_url)
1811 if ext == 'f4m':
77b8b4e6 1812 f4m_formats = self._extract_f4m_formats(
f983b875 1813 manifest_url, video_id, preference=preference, quality=quality, f4m_id=f4m_id,
77b8b4e6
S
1814 transform_source=transform_source, fatal=fatal)
1815 # Sometimes stream-level manifest contains single media entry that
1816 # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1817 # At the same time parent's media entry in set-level manifest may
1818 # contain it. We will copy it from parent in such cases.
1819 if len(f4m_formats) == 1:
1820 f = f4m_formats[0]
1821 f.update({
1822 'tbr': f.get('tbr') or tbr,
1823 'width': f.get('width') or width,
1824 'height': f.get('height') or height,
1825 'format_id': f.get('format_id') if not tbr else format_id,
edd6074c 1826 'vcodec': vcodec,
77b8b4e6
S
1827 })
1828 formats.extend(f4m_formats)
70f0f5a8 1829 continue
240b6045
YCH
1830 elif ext == 'm3u8':
1831 formats.extend(self._extract_m3u8_formats(
1832 manifest_url, video_id, 'mp4', preference=preference,
f983b875 1833 quality=quality, m3u8_id=m3u8_id, fatal=fatal))
240b6045 1834 continue
31bb8d3f 1835 formats.append({
77b8b4e6 1836 'format_id': format_id,
31bb8d3f 1837 'url': manifest_url,
30d0b549 1838 'manifest_url': manifest_url,
a6571f10 1839 'ext': 'flv' if bootstrap_info is not None else None,
187ee66c 1840 'protocol': 'f4m',
b2527359 1841 'tbr': tbr,
77b8b4e6
S
1842 'width': width,
1843 'height': height,
edd6074c 1844 'vcodec': vcodec,
60ca389c 1845 'preference': preference,
f983b875 1846 'quality': quality,
31bb8d3f 1847 })
31bb8d3f
JMF
1848 return formats
1849
f983b875 1850 def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, quality=None, m3u8_id=None):
16da9bbc 1851 return {
f207019c 1852 'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
704df56d
PH
1853 'url': m3u8_url,
1854 'ext': ext,
1855 'protocol': 'm3u8',
37768f92 1856 'preference': preference - 100 if preference else -100,
f983b875 1857 'quality': quality,
704df56d
PH
1858 'resolution': 'multiple',
1859 'format_note': 'Quality selection URL',
16da9bbc
YCH
1860 }
1861
1862 def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
f983b875 1863 entry_protocol='m3u8', preference=None, quality=None,
fc21af50 1864 m3u8_id=None, note=None, errnote=None,
1865 fatal=True, live=False, data=None, headers={},
1866 query={}):
dbd82a1d 1867 res = self._download_webpage_handle(
81515ad9 1868 m3u8_url, video_id,
621ed9f5 1869 note=note or 'Downloading m3u8 information',
13af92fd 1870 errnote=errnote or 'Failed to download m3u8 information',
7360c06f 1871 fatal=fatal, data=data, headers=headers, query=query)
cb252080 1872
dbd82a1d 1873 if res is False:
8d29e47f 1874 return []
cb252080 1875
dbd82a1d 1876 m3u8_doc, urlh = res
37113045 1877 m3u8_url = urlh.geturl()
9cdffeeb 1878
cb252080
S
1879 return self._parse_m3u8_formats(
1880 m3u8_doc, m3u8_url, ext=ext, entry_protocol=entry_protocol,
310c2ed2 1881 preference=preference, quality=quality, m3u8_id=m3u8_id,
1882 note=note, errnote=errnote, fatal=fatal, live=live, data=data,
1883 headers=headers, query=query, video_id=video_id)
cb252080
S
1884
1885 def _parse_m3u8_formats(self, m3u8_doc, m3u8_url, ext=None,
f983b875 1886 entry_protocol='m3u8', preference=None, quality=None,
310c2ed2 1887 m3u8_id=None, live=False, note=None, errnote=None,
1888 fatal=True, data=None, headers={}, query={}, video_id=None):
08a00eef
RA
1889 if '#EXT-X-FAXS-CM:' in m3u8_doc: # Adobe Flash Access
1890 return []
1891
ea229584
RA
1892 if re.search(r'#EXT-X-SESSION-KEY:.*?URI="skd://', m3u8_doc): # Apple FairPlay
1893 return []
1894
ff99fe52 1895 formats = []
0def7587
RA
1896
1897 format_url = lambda u: (
1898 u
1899 if re.match(r'^https?://', u)
1900 else compat_urlparse.urljoin(m3u8_url, u))
1901
310c2ed2 1902 split_discontinuity = self._downloader.params.get('hls_split_discontinuity', False)
1903
cb252080
S
1904 # References:
1905 # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-21
067aa17e
S
1906 # 2. https://github.com/ytdl-org/youtube-dl/issues/12211
1907 # 3. https://github.com/ytdl-org/youtube-dl/issues/18923
cb252080
S
1908
1909 # We should try extracting formats only from master playlists [1, 4.3.4],
1910 # i.e. playlists that describe available qualities. On the other hand
1911 # media playlists [1, 4.3.3] should be returned as is since they contain
1912 # just the media without qualities renditions.
9cdffeeb 1913 # Fortunately, master playlist can be easily distinguished from media
cb252080 1914 # playlist based on particular tags availability. As of [1, 4.3.3, 4.3.4]
a0566bbf 1915 # master playlist tags MUST NOT appear in a media playlist and vice versa.
cb252080
S
1916 # As of [1, 4.3.3.1] #EXT-X-TARGETDURATION tag is REQUIRED for every
1917 # media playlist and MUST NOT appear in master playlist thus we can
1918 # clearly detect media playlist with this criterion.
1919
b3b30a4b 1920 def _extract_m3u8_playlist_formats(format_url=None, m3u8_doc=None, video_id=None,
1921 fatal=True, data=None, headers={}):
310c2ed2 1922 if not m3u8_doc:
ed9b7e3d 1923 if not format_url:
1924 return []
310c2ed2 1925 res = self._download_webpage_handle(
1926 format_url, video_id,
1927 note=False,
b3b30a4b 1928 errnote='Failed to download m3u8 playlist information',
1929 fatal=fatal, data=data, headers=headers)
310c2ed2 1930
1931 if res is False:
1932 return []
1933
1934 m3u8_doc, urlh = res
1935 format_url = urlh.geturl()
1936
1937 playlist_formats = []
1938 i = (
1939 0
1940 if split_discontinuity
1941 else None)
1942 format_info = {
1943 'index': i,
1944 'key_data': None,
1945 'files': [],
1946 }
1947 for line in m3u8_doc.splitlines():
1948 if not line.startswith('#'):
1949 format_info['files'].append(line)
1950 elif split_discontinuity and line.startswith('#EXT-X-DISCONTINUITY'):
1951 i += 1
1952 playlist_formats.append(format_info)
1953 format_info = {
1954 'index': i,
1955 'url': format_url,
1956 'files': [],
1957 }
1958 playlist_formats.append(format_info)
1959 return playlist_formats
1960
9cdffeeb 1961 if '#EXT-X-TARGETDURATION' in m3u8_doc: # media playlist, return as is
310c2ed2 1962
ed9b7e3d 1963 playlist_formats = _extract_m3u8_playlist_formats(m3u8_doc=m3u8_doc)
310c2ed2 1964
1965 for format in playlist_formats:
1966 format_id = []
1967 if m3u8_id:
1968 format_id.append(m3u8_id)
1969 format_index = format.get('index')
1970 if format_index:
1971 format_id.append(str(format_index))
1972 f = {
1973 'format_id': '-'.join(format_id),
1974 'format_index': format_index,
1975 'url': m3u8_url,
1976 'ext': ext,
1977 'protocol': entry_protocol,
1978 'preference': preference,
1979 'quality': quality,
1980 }
1981 formats.append(f)
1982
1983 return formats
cb252080
S
1984
1985 groups = {}
1986 last_stream_inf = {}
1987
1988 def extract_media(x_media_line):
1989 media = parse_m3u8_attributes(x_media_line)
1990 # As per [1, 4.3.4.1] TYPE, GROUP-ID and NAME are REQUIRED
1991 media_type, group_id, name = media.get('TYPE'), media.get('GROUP-ID'), media.get('NAME')
1992 if not (media_type and group_id and name):
1993 return
1994 groups.setdefault(group_id, []).append(media)
1995 if media_type not in ('VIDEO', 'AUDIO'):
1996 return
1997 media_url = media.get('URI')
1998 if media_url:
310c2ed2 1999 manifest_url = format_url(media_url)
cb252080 2000 format_id = []
b3b30a4b 2001 playlist_formats = _extract_m3u8_playlist_formats(manifest_url, video_id=video_id,
2002 fatal=fatal, data=data, headers=headers)
310c2ed2 2003
2004 for format in playlist_formats:
2005 format_index = format.get('index')
2006 for v in (m3u8_id, group_id, name):
2007 if v:
2008 format_id.append(v)
2009 if format_index:
2010 format_id.append(str(format_index))
2011 f = {
2012 'format_id': '-'.join(format_id),
2013 'format_index': format_index,
2014 'url': manifest_url,
2015 'manifest_url': m3u8_url,
2016 'language': media.get('LANGUAGE'),
2017 'ext': ext,
2018 'protocol': entry_protocol,
2019 'preference': preference,
2020 'quality': quality,
2021 }
2022 if media_type == 'AUDIO':
2023 f['vcodec'] = 'none'
2024 formats.append(f)
cb252080
S
2025
2026 def build_stream_name():
2027 # Despite specification does not mention NAME attribute for
3019cb0c
S
2028 # EXT-X-STREAM-INF tag it still sometimes may be present (see [1]
2029 # or vidio test in TestInfoExtractor.test_parse_m3u8_formats)
ddd258f9 2030 # 1. http://www.vidio.com/watch/165683-dj_ambred-booyah-live-2015
cb252080
S
2031 stream_name = last_stream_inf.get('NAME')
2032 if stream_name:
2033 return stream_name
2034 # If there is no NAME in EXT-X-STREAM-INF it will be obtained
2035 # from corresponding rendition group
2036 stream_group_id = last_stream_inf.get('VIDEO')
2037 if not stream_group_id:
2038 return
2039 stream_group = groups.get(stream_group_id)
2040 if not stream_group:
2041 return stream_group_id
2042 rendition = stream_group[0]
2043 return rendition.get('NAME') or stream_group_id
2044
379306ef 2045 # parse EXT-X-MEDIA tags before EXT-X-STREAM-INF in order to have the
2bfc1d9d
RA
2046 # chance to detect video only formats when EXT-X-STREAM-INF tags
2047 # precede EXT-X-MEDIA tags in HLS manifest such as [3].
2048 for line in m3u8_doc.splitlines():
2049 if line.startswith('#EXT-X-MEDIA:'):
2050 extract_media(line)
2051
704df56d
PH
2052 for line in m3u8_doc.splitlines():
2053 if line.startswith('#EXT-X-STREAM-INF:'):
cb252080 2054 last_stream_inf = parse_m3u8_attributes(line)
704df56d
PH
2055 elif line.startswith('#') or not line.strip():
2056 continue
2057 else:
9c99bef7 2058 tbr = float_or_none(
3089bc74
S
2059 last_stream_inf.get('AVERAGE-BANDWIDTH')
2060 or last_stream_inf.get('BANDWIDTH'), scale=1000)
30d0b549 2061 manifest_url = format_url(line.strip())
5ef62fc4 2062
b3b30a4b 2063 playlist_formats = _extract_m3u8_playlist_formats(manifest_url, video_id=video_id,
2064 fatal=fatal, data=data, headers=headers)
310c2ed2 2065
fc21af50 2066 for frmt in playlist_formats:
310c2ed2 2067 format_id = []
2068 if m3u8_id:
2069 format_id.append(m3u8_id)
fc21af50 2070 format_index = frmt.get('index')
310c2ed2 2071 stream_name = build_stream_name()
2072 # Bandwidth of live streams may differ over time thus making
2073 # format_id unpredictable. So it's better to keep provided
2074 # format_id intact.
2075 if not live:
2076 format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
2077 if format_index:
2078 format_id.append(str(format_index))
2079 f = {
2080 'format_id': '-'.join(format_id),
2081 'format_index': format_index,
2082 'url': manifest_url,
2083 'manifest_url': m3u8_url,
2084 'tbr': tbr,
2085 'ext': ext,
2086 'fps': float_or_none(last_stream_inf.get('FRAME-RATE')),
2087 'protocol': entry_protocol,
2088 'preference': preference,
2089 'quality': quality,
2090 }
2091 resolution = last_stream_inf.get('RESOLUTION')
2092 if resolution:
2093 mobj = re.search(r'(?P<width>\d+)[xX](?P<height>\d+)', resolution)
2094 if mobj:
2095 f['width'] = int(mobj.group('width'))
2096 f['height'] = int(mobj.group('height'))
2097 # Unified Streaming Platform
2098 mobj = re.search(
2099 r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
2100 if mobj:
2101 abr, vbr = mobj.groups()
2102 abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
2103 f.update({
2104 'vbr': vbr,
2105 'abr': abr,
2106 })
2107 codecs = parse_codecs(last_stream_inf.get('CODECS'))
2108 f.update(codecs)
2109 audio_group_id = last_stream_inf.get('AUDIO')
2110 # As per [1, 4.3.4.1.1] any EXT-X-STREAM-INF tag which
2111 # references a rendition group MUST have a CODECS attribute.
2112 # However, this is not always respected, for example, [2]
2113 # contains EXT-X-STREAM-INF tag which references AUDIO
2114 # rendition group but does not have CODECS and despite
2115 # referencing an audio group it represents a complete
2116 # (with audio and video) format. So, for such cases we will
2117 # ignore references to rendition groups and treat them
2118 # as complete formats.
2119 if audio_group_id and codecs and f.get('vcodec') != 'none':
2120 audio_group = groups.get(audio_group_id)
2121 if audio_group and audio_group[0].get('URI'):
2122 # TODO: update acodec for audio only formats with
2123 # the same GROUP-ID
2124 f['acodec'] = 'none'
fc21af50 2125 if not f.get('ext'):
2126 f['ext'] = 'm4a' if f.get('vcodec') == 'none' else 'mp4'
310c2ed2 2127 formats.append(f)
2128
2129 # for DailyMotion
2130 progressive_uri = last_stream_inf.get('PROGRESSIVE-URI')
2131 if progressive_uri:
2132 http_f = f.copy()
2133 del http_f['manifest_url']
2134 http_f.update({
2135 'format_id': f['format_id'].replace('hls-', 'http-'),
2136 'protocol': 'http',
2137 'url': progressive_uri,
2138 })
2139 formats.append(http_f)
5ef62fc4 2140
cb252080 2141 last_stream_inf = {}
704df56d
PH
2142 return formats
2143
a107193e
S
2144 @staticmethod
2145 def _xpath_ns(path, namespace=None):
2146 if not namespace:
2147 return path
2148 out = []
2149 for c in path.split('/'):
2150 if not c or c == '.':
2151 out.append(c)
2152 else:
2153 out.append('{%s}%s' % (namespace, c))
2154 return '/'.join(out)
2155
09f572fb 2156 def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
2157 smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
a107193e 2158
995029a1
PH
2159 if smil is False:
2160 assert not fatal
2161 return []
e89a2aab 2162
17712eeb 2163 namespace = self._parse_smil_namespace(smil)
a107193e
S
2164
2165 return self._parse_smil_formats(
2166 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
2167
2168 def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
2169 smil = self._download_smil(smil_url, video_id, fatal=fatal)
2170 if smil is False:
2171 return {}
2172 return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
2173
09f572fb 2174 def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
a107193e
S
2175 return self._download_xml(
2176 smil_url, video_id, 'Downloading SMIL file',
09f572fb 2177 'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
a107193e
S
2178
2179 def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
17712eeb 2180 namespace = self._parse_smil_namespace(smil)
a107193e
S
2181
2182 formats = self._parse_smil_formats(
2183 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
2184 subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
2185
2186 video_id = os.path.splitext(url_basename(smil_url))[0]
2187 title = None
2188 description = None
647eab45 2189 upload_date = None
a107193e
S
2190 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
2191 name = meta.attrib.get('name')
2192 content = meta.attrib.get('content')
2193 if not name or not content:
2194 continue
2195 if not title and name == 'title':
2196 title = content
2197 elif not description and name in ('description', 'abstract'):
2198 description = content
647eab45
S
2199 elif not upload_date and name == 'date':
2200 upload_date = unified_strdate(content)
a107193e 2201
1e5bcdec
S
2202 thumbnails = [{
2203 'id': image.get('type'),
2204 'url': image.get('src'),
2205 'width': int_or_none(image.get('width')),
2206 'height': int_or_none(image.get('height')),
2207 } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
2208
a107193e
S
2209 return {
2210 'id': video_id,
2211 'title': title or video_id,
2212 'description': description,
647eab45 2213 'upload_date': upload_date,
1e5bcdec 2214 'thumbnails': thumbnails,
a107193e
S
2215 'formats': formats,
2216 'subtitles': subtitles,
2217 }
2218
17712eeb
S
2219 def _parse_smil_namespace(self, smil):
2220 return self._search_regex(
2221 r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
2222
f877c6ae 2223 def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
a107193e
S
2224 base = smil_url
2225 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
2226 b = meta.get('base') or meta.get('httpBase')
2227 if b:
2228 base = b
2229 break
e89a2aab
S
2230
2231 formats = []
2232 rtmp_count = 0
a107193e 2233 http_count = 0
7f32e5dc 2234 m3u8_count = 0
a107193e 2235
81e1c4e2 2236 srcs = []
ad96b4c8
YCH
2237 media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
2238 for medium in media:
2239 src = medium.get('src')
81e1c4e2 2240 if not src or src in srcs:
a107193e 2241 continue
81e1c4e2 2242 srcs.append(src)
a107193e 2243
ad96b4c8
YCH
2244 bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
2245 filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
2246 width = int_or_none(medium.get('width'))
2247 height = int_or_none(medium.get('height'))
2248 proto = medium.get('proto')
2249 ext = medium.get('ext')
a107193e 2250 src_ext = determine_ext(src)
ad96b4c8 2251 streamer = medium.get('streamer') or base
a107193e
S
2252
2253 if proto == 'rtmp' or streamer.startswith('rtmp'):
2254 rtmp_count += 1
2255 formats.append({
2256 'url': streamer,
2257 'play_path': src,
2258 'ext': 'flv',
2259 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
2260 'tbr': bitrate,
2261 'filesize': filesize,
2262 'width': width,
2263 'height': height,
2264 })
f877c6ae
YCH
2265 if transform_rtmp_url:
2266 streamer, src = transform_rtmp_url(streamer, src)
2267 formats[-1].update({
2268 'url': streamer,
2269 'play_path': src,
2270 })
a107193e
S
2271 continue
2272
2273 src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
c349456e 2274 src_url = src_url.strip()
a107193e
S
2275
2276 if proto == 'm3u8' or src_ext == 'm3u8':
7f32e5dc 2277 m3u8_formats = self._extract_m3u8_formats(
2278 src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
2279 if len(m3u8_formats) == 1:
2280 m3u8_count += 1
2281 m3u8_formats[0].update({
2282 'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
2283 'tbr': bitrate,
2284 'width': width,
2285 'height': height,
2286 })
2287 formats.extend(m3u8_formats)
bd21ead2 2288 elif src_ext == 'f4m':
a107193e
S
2289 f4m_url = src_url
2290 if not f4m_params:
2291 f4m_params = {
2292 'hdcore': '3.2.0',
2293 'plugin': 'flowplayer-3.2.0.1',
2294 }
2295 f4m_url += '&' if '?' in f4m_url else '?'
15707c7e 2296 f4m_url += compat_urllib_parse_urlencode(f4m_params)
7e5edcfd 2297 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
bd21ead2
RA
2298 elif src_ext == 'mpd':
2299 formats.extend(self._extract_mpd_formats(
2300 src_url, video_id, mpd_id='dash', fatal=False))
2301 elif re.search(r'\.ism/[Mm]anifest', src_url):
2302 formats.extend(self._extract_ism_formats(
2303 src_url, video_id, ism_id='mss', fatal=False))
2304 elif src_url.startswith('http') and self._is_valid_url(src, video_id):
a107193e
S
2305 http_count += 1
2306 formats.append({
2307 'url': src_url,
2308 'ext': ext or src_ext or 'flv',
2309 'format_id': 'http-%d' % (bitrate or http_count),
2310 'tbr': bitrate,
2311 'filesize': filesize,
2312 'width': width,
2313 'height': height,
2314 })
63757032 2315
e89a2aab
S
2316 return formats
2317
ce00af87 2318 def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
d413095f 2319 urls = []
a107193e
S
2320 subtitles = {}
2321 for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
2322 src = textstream.get('src')
d413095f 2323 if not src or src in urls:
a107193e 2324 continue
d413095f 2325 urls.append(src)
df634be2 2326 ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
03bc7237 2327 lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
a107193e
S
2328 subtitles.setdefault(lang, []).append({
2329 'url': src,
2330 'ext': ext,
2331 })
2332 return subtitles
63757032 2333
47a5cb77 2334 def _extract_xspf_playlist(self, xspf_url, playlist_id, fatal=True):
942acef5 2335 xspf = self._download_xml(
47a5cb77 2336 xspf_url, playlist_id, 'Downloading xpsf playlist',
942acef5
S
2337 'Unable to download xspf manifest', fatal=fatal)
2338 if xspf is False:
2339 return []
47a5cb77
S
2340 return self._parse_xspf(
2341 xspf, playlist_id, xspf_url=xspf_url,
2342 xspf_base_url=base_url(xspf_url))
8d6765cf 2343
47a5cb77 2344 def _parse_xspf(self, xspf_doc, playlist_id, xspf_url=None, xspf_base_url=None):
8d6765cf
S
2345 NS_MAP = {
2346 'xspf': 'http://xspf.org/ns/0/',
2347 's1': 'http://static.streamone.nl/player/ns/0',
2348 }
2349
2350 entries = []
47a5cb77 2351 for track in xspf_doc.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
8d6765cf 2352 title = xpath_text(
98044462 2353 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
8d6765cf
S
2354 description = xpath_text(
2355 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
2356 thumbnail = xpath_text(
2357 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
2358 duration = float_or_none(
2359 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
2360
47a5cb77
S
2361 formats = []
2362 for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP)):
2363 format_url = urljoin(xspf_base_url, location.text)
2364 if not format_url:
2365 continue
2366 formats.append({
2367 'url': format_url,
2368 'manifest_url': xspf_url,
2369 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
2370 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
2371 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
2372 })
8d6765cf
S
2373 self._sort_formats(formats)
2374
2375 entries.append({
2376 'id': playlist_id,
2377 'title': title,
2378 'description': description,
2379 'thumbnail': thumbnail,
2380 'duration': duration,
2381 'formats': formats,
2382 })
2383 return entries
2384
545cc85d 2385 def _extract_mpd_formats(self, mpd_url, video_id, mpd_id=None, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
47a5cb77 2386 res = self._download_xml_handle(
1bac3455 2387 mpd_url, video_id,
2388 note=note or 'Downloading MPD manifest',
2389 errnote=errnote or 'Failed to download MPD manifest',
7360c06f 2390 fatal=fatal, data=data, headers=headers, query=query)
1bac3455 2391 if res is False:
2d2fa82d 2392 return []
47a5cb77 2393 mpd_doc, urlh = res
c25720ef
RA
2394 if mpd_doc is None:
2395 return []
02dc0a36 2396 mpd_base_url = base_url(urlh.geturl())
1bac3455 2397
91cb6b50 2398 return self._parse_mpd_formats(
545cc85d 2399 mpd_doc, mpd_id, mpd_base_url, mpd_url)
2d2fa82d 2400
545cc85d 2401 def _parse_mpd_formats(self, mpd_doc, mpd_id=None, mpd_base_url='', mpd_url=None):
f0948348
S
2402 """
2403 Parse formats from MPD manifest.
2404 References:
2405 1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
2406 http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
2407 2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
2408 """
78895bd3
U
2409 if not self._downloader.params.get('dynamic_mpd'):
2410 if mpd_doc.get('type') == 'dynamic':
2411 return []
2d2fa82d 2412
91cb6b50 2413 namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
f14be228 2414
2415 def _add_ns(path):
2416 return self._xpath_ns(path, namespace)
2417
675d0016 2418 def is_drm_protected(element):
2419 return element.find(_add_ns('ContentProtection')) is not None
2420
1bac3455 2421 def extract_multisegment_info(element, ms_parent_info):
2422 ms_info = ms_parent_info.copy()
b4c1d6e8
S
2423
2424 # As per [1, 5.3.9.2.2] SegmentList and SegmentTemplate share some
2425 # common attributes and elements. We will only extract relevant
2426 # for us.
2427 def extract_common(source):
2428 segment_timeline = source.find(_add_ns('SegmentTimeline'))
2429 if segment_timeline is not None:
2430 s_e = segment_timeline.findall(_add_ns('S'))
2431 if s_e:
2432 ms_info['total_number'] = 0
2433 ms_info['s'] = []
2434 for s in s_e:
2435 r = int(s.get('r', 0))
2436 ms_info['total_number'] += 1 + r
2437 ms_info['s'].append({
2438 't': int(s.get('t', 0)),
2439 # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
2440 'd': int(s.attrib['d']),
2441 'r': r,
2442 })
2443 start_number = source.get('startNumber')
2444 if start_number:
2445 ms_info['start_number'] = int(start_number)
2446 timescale = source.get('timescale')
2447 if timescale:
2448 ms_info['timescale'] = int(timescale)
2449 segment_duration = source.get('duration')
2450 if segment_duration:
48504785 2451 ms_info['segment_duration'] = float(segment_duration)
b4c1d6e8
S
2452
2453 def extract_Initialization(source):
2454 initialization = source.find(_add_ns('Initialization'))
2455 if initialization is not None:
2456 ms_info['initialization_url'] = initialization.attrib['sourceURL']
2457
f14be228 2458 segment_list = element.find(_add_ns('SegmentList'))
1bac3455 2459 if segment_list is not None:
b4c1d6e8
S
2460 extract_common(segment_list)
2461 extract_Initialization(segment_list)
f14be228 2462 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
1bac3455 2463 if segment_urls_e:
2464 ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
1bac3455 2465 else:
f14be228 2466 segment_template = element.find(_add_ns('SegmentTemplate'))
1bac3455 2467 if segment_template is not None:
b4c1d6e8 2468 extract_common(segment_template)
e228616c
S
2469 media = segment_template.get('media')
2470 if media:
2471 ms_info['media'] = media
1bac3455 2472 initialization = segment_template.get('initialization')
2473 if initialization:
e228616c 2474 ms_info['initialization'] = initialization
1bac3455 2475 else:
b4c1d6e8 2476 extract_Initialization(segment_template)
1bac3455 2477 return ms_info
b323e170 2478
06869367 2479 skip_unplayable = not self._downloader.params.get('allow_unplayable_formats')
63ad4d43 2480
1bac3455 2481 mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
17b598d3 2482 formats = []
f14be228 2483 for period in mpd_doc.findall(_add_ns('Period')):
1bac3455 2484 period_duration = parse_duration(period.get('duration')) or mpd_duration
2485 period_ms_info = extract_multisegment_info(period, {
2486 'start_number': 1,
2487 'timescale': 1,
2488 })
f14be228 2489 for adaptation_set in period.findall(_add_ns('AdaptationSet')):
06869367 2490 if skip_unplayable and is_drm_protected(adaptation_set):
675d0016 2491 continue
1bac3455 2492 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
f14be228 2493 for representation in adaptation_set.findall(_add_ns('Representation')):
06869367 2494 if skip_unplayable and is_drm_protected(representation):
675d0016 2495 continue
1bac3455 2496 representation_attrib = adaptation_set.attrib.copy()
2497 representation_attrib.update(representation.attrib)
f0948348 2498 # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
a6c8b759
YCH
2499 mime_type = representation_attrib['mimeType']
2500 content_type = mime_type.split('/')[0]
1bac3455 2501 if content_type == 'text':
2502 # TODO implement WebVTT downloading
2503 pass
40fcba5e 2504 elif content_type in ('video', 'audio'):
1bac3455 2505 base_url = ''
2506 for element in (representation, adaptation_set, period, mpd_doc):
f14be228 2507 base_url_e = element.find(_add_ns('BaseURL'))
1bac3455 2508 if base_url_e is not None:
2509 base_url = base_url_e.text + base_url
2510 if re.match(r'^https?://', base_url):
2511 break
bb20526b
S
2512 if mpd_base_url and not re.match(r'^https?://', base_url):
2513 if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
2514 mpd_base_url += '/'
1bac3455 2515 base_url = mpd_base_url + base_url
2516 representation_id = representation_attrib.get('id')
d577c796 2517 lang = representation_attrib.get('lang')
51e9094f 2518 url_el = representation.find(_add_ns('BaseURL'))
2519 filesize = int_or_none(url_el.attrib.get('{http://youtube.com/yt/2012/10/10}contentLength') if url_el is not None else None)
e228616c 2520 bandwidth = int_or_none(representation_attrib.get('bandwidth'))
1bac3455 2521 f = {
154c209e 2522 'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
86f4d14f 2523 'manifest_url': mpd_url,
a6c8b759 2524 'ext': mimetype2ext(mime_type),
1bac3455 2525 'width': int_or_none(representation_attrib.get('width')),
2526 'height': int_or_none(representation_attrib.get('height')),
9c99bef7 2527 'tbr': float_or_none(bandwidth, 1000),
1bac3455 2528 'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
2529 'fps': int_or_none(representation_attrib.get('frameRate')),
d577c796 2530 'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
1bac3455 2531 'format_note': 'DASH %s' % content_type,
51e9094f 2532 'filesize': filesize,
126f225b 2533 'container': mimetype2ext(mime_type) + '_dash',
1bac3455 2534 }
7fe15920 2535 f.update(parse_codecs(representation_attrib.get('codecs')))
1bac3455 2536 representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
b4c1d6e8 2537
e228616c 2538 def prepare_template(template_name, identifiers):
eca1f0d1
S
2539 tmpl = representation_ms_info[template_name]
2540 # First of, % characters outside $...$ templates
2541 # must be escaped by doubling for proper processing
2542 # by % operator string formatting used further (see
067aa17e 2543 # https://github.com/ytdl-org/youtube-dl/issues/16867).
eca1f0d1
S
2544 t = ''
2545 in_template = False
2546 for c in tmpl:
2547 t += c
2548 if c == '$':
2549 in_template = not in_template
2550 elif c == '%' and not in_template:
2551 t += c
2552 # Next, $...$ templates are translated to their
2553 # %(...) counterparts to be used with % operator
e228616c
S
2554 t = t.replace('$RepresentationID$', representation_id)
2555 t = re.sub(r'\$(%s)\$' % '|'.join(identifiers), r'%(\1)d', t)
2556 t = re.sub(r'\$(%s)%%([^$]+)\$' % '|'.join(identifiers), r'%(\1)\2', t)
2557 t.replace('$$', '$')
2558 return t
2559
2560 # @initialization is a regular template like @media one
2561 # so it should be handled just the same way (see
067aa17e 2562 # https://github.com/ytdl-org/youtube-dl/issues/11605)
e228616c
S
2563 if 'initialization' in representation_ms_info:
2564 initialization_template = prepare_template(
2565 'initialization',
2566 # As per [1, 5.3.9.4.2, Table 15, page 54] $Number$ and
2567 # $Time$ shall not be included for @initialization thus
2568 # only $Bandwidth$ remains
2569 ('Bandwidth', ))
2570 representation_ms_info['initialization_url'] = initialization_template % {
2571 'Bandwidth': bandwidth,
2572 }
2573
1141e910
S
2574 def location_key(location):
2575 return 'url' if re.match(r'^https?://', location) else 'path'
2576
e228616c
S
2577 if 'segment_urls' not in representation_ms_info and 'media' in representation_ms_info:
2578
2579 media_template = prepare_template('media', ('Number', 'Bandwidth', 'Time'))
1141e910 2580 media_location_key = location_key(media_template)
f0948348
S
2581
2582 # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
2583 # can't be used at the same time
b4c1d6e8
S
2584 if '%(Number' in media_template and 's' not in representation_ms_info:
2585 segment_duration = None
c110944f 2586 if 'total_number' not in representation_ms_info and 'segment_duration' in representation_ms_info:
b4c1d6e8
S
2587 segment_duration = float_or_none(representation_ms_info['segment_duration'], representation_ms_info['timescale'])
2588 representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
b4c1d6e8 2589 representation_ms_info['fragments'] = [{
1141e910 2590 media_location_key: media_template % {
b4c1d6e8 2591 'Number': segment_number,
e228616c 2592 'Bandwidth': bandwidth,
b4c1d6e8
S
2593 },
2594 'duration': segment_duration,
2595 } for segment_number in range(
2596 representation_ms_info['start_number'],
2597 representation_ms_info['total_number'] + representation_ms_info['start_number'])]
f0948348 2598 else:
b4c1d6e8
S
2599 # $Number*$ or $Time$ in media template with S list available
2600 # Example $Number*$: http://www.svtplay.se/klipp/9023742/stopptid-om-bjorn-borg
2601 # Example $Time$: https://play.arkena.com/embed/avp/v2/player/media/b41dda37-d8e7-4d3f-b1b5-9a9db578bdfe/1/129411
b4c1d6e8 2602 representation_ms_info['fragments'] = []
f0948348 2603 segment_time = 0
b4c1d6e8
S
2604 segment_d = None
2605 segment_number = representation_ms_info['start_number']
f0948348
S
2606
2607 def add_segment_url():
b4c1d6e8
S
2608 segment_url = media_template % {
2609 'Time': segment_time,
e228616c 2610 'Bandwidth': bandwidth,
b4c1d6e8
S
2611 'Number': segment_number,
2612 }
b4c1d6e8 2613 representation_ms_info['fragments'].append({
1141e910 2614 media_location_key: segment_url,
b4c1d6e8
S
2615 'duration': float_or_none(segment_d, representation_ms_info['timescale']),
2616 })
f0948348
S
2617
2618 for num, s in enumerate(representation_ms_info['s']):
2619 segment_time = s.get('t') or segment_time
b4c1d6e8 2620 segment_d = s['d']
f0948348 2621 add_segment_url()
b4c1d6e8 2622 segment_number += 1
f0948348 2623 for r in range(s.get('r', 0)):
b4c1d6e8 2624 segment_time += segment_d
f0948348 2625 add_segment_url()
b4c1d6e8
S
2626 segment_number += 1
2627 segment_time += segment_d
2628 elif 'segment_urls' in representation_ms_info and 's' in representation_ms_info:
2629 # No media template
2630 # Example: https://www.youtube.com/watch?v=iXZV5uAYMJI
2631 # or any YouTube dashsegments video
2632 fragments = []
d04621da
S
2633 segment_index = 0
2634 timescale = representation_ms_info['timescale']
2635 for s in representation_ms_info['s']:
2636 duration = float_or_none(s['d'], timescale)
b4c1d6e8 2637 for r in range(s.get('r', 0) + 1):
1141e910 2638 segment_uri = representation_ms_info['segment_urls'][segment_index]
b4c1d6e8 2639 fragments.append({
1141e910 2640 location_key(segment_uri): segment_uri,
d04621da 2641 'duration': duration,
b4c1d6e8 2642 })
d04621da 2643 segment_index += 1
b4c1d6e8 2644 representation_ms_info['fragments'] = fragments
41bf647e
PN
2645 elif 'segment_urls' in representation_ms_info:
2646 # Segment URLs with no SegmentTimeline
2647 # Example: https://www.seznam.cz/zpravy/clanek/cesko-zasahne-vitr-o-sile-vichrice-muze-byt-i-zivotu-nebezpecny-39091
067aa17e 2648 # https://github.com/ytdl-org/youtube-dl/pull/14844
41bf647e 2649 fragments = []
603fc4e0
S
2650 segment_duration = float_or_none(
2651 representation_ms_info['segment_duration'],
2652 representation_ms_info['timescale']) if 'segment_duration' in representation_ms_info else None
41bf647e 2653 for segment_url in representation_ms_info['segment_urls']:
603fc4e0 2654 fragment = {
41bf647e 2655 location_key(segment_url): segment_url,
603fc4e0
S
2656 }
2657 if segment_duration:
2658 fragment['duration'] = segment_duration
2659 fragments.append(fragment)
41bf647e 2660 representation_ms_info['fragments'] = fragments
79d2077e
S
2661 # If there is a fragments key available then we correctly recognized fragmented media.
2662 # Otherwise we will assume unfragmented media with direct access. Technically, such
2663 # assumption is not necessarily correct since we may simply have no support for
2664 # some forms of fragmented media renditions yet, but for now we'll use this fallback.
86f4d14f 2665 if 'fragments' in representation_ms_info:
1bac3455 2666 f.update({
79d2077e
S
2667 # NB: mpd_url may be empty when MPD manifest is parsed from a string
2668 'url': mpd_url or base_url,
1141e910 2669 'fragment_base_url': base_url,
b4c1d6e8 2670 'fragments': [],
1bac3455 2671 'protocol': 'http_dash_segments',
df374b52 2672 })
1bac3455 2673 if 'initialization_url' in representation_ms_info:
e228616c 2674 initialization_url = representation_ms_info['initialization_url']
1bac3455 2675 if not f.get('url'):
2676 f['url'] = initialization_url
1141e910 2677 f['fragments'].append({location_key(initialization_url): initialization_url})
b4c1d6e8 2678 f['fragments'].extend(representation_ms_info['fragments'])
79d2077e
S
2679 else:
2680 # Assuming direct URL to unfragmented media.
2681 f['url'] = base_url
545cc85d 2682 formats.append(f)
17b598d3 2683 else:
1bac3455 2684 self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
17b598d3
YCH
2685 return formats
2686
7360c06f 2687 def _extract_ism_formats(self, ism_url, video_id, ism_id=None, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
47a5cb77 2688 res = self._download_xml_handle(
b2758123
RA
2689 ism_url, video_id,
2690 note=note or 'Downloading ISM manifest',
2691 errnote=errnote or 'Failed to download ISM manifest',
7360c06f 2692 fatal=fatal, data=data, headers=headers, query=query)
b2758123
RA
2693 if res is False:
2694 return []
47a5cb77 2695 ism_doc, urlh = res
13b08034
S
2696 if ism_doc is None:
2697 return []
b2758123 2698
7947a1f7 2699 return self._parse_ism_formats(ism_doc, urlh.geturl(), ism_id)
b2758123
RA
2700
2701 def _parse_ism_formats(self, ism_doc, ism_url, ism_id=None):
76d5a363
S
2702 """
2703 Parse formats from ISM manifest.
2704 References:
2705 1. [MS-SSTR]: Smooth Streaming Protocol,
2706 https://msdn.microsoft.com/en-us/library/ff469518.aspx
2707 """
06869367 2708 if ism_doc.get('IsLive') == 'TRUE':
2709 return []
2710 if (not self._downloader.params.get('allow_unplayable_formats')
2711 and ism_doc.find('Protection') is not None):
b2758123
RA
2712 return []
2713
b2758123
RA
2714 duration = int(ism_doc.attrib['Duration'])
2715 timescale = int_or_none(ism_doc.get('TimeScale')) or 10000000
2716
2717 formats = []
2718 for stream in ism_doc.findall('StreamIndex'):
2719 stream_type = stream.get('Type')
2720 if stream_type not in ('video', 'audio'):
2721 continue
2722 url_pattern = stream.attrib['Url']
2723 stream_timescale = int_or_none(stream.get('TimeScale')) or timescale
2724 stream_name = stream.get('Name')
2725 for track in stream.findall('QualityLevel'):
2501d41e 2726 fourcc = track.get('FourCC', 'AACL' if track.get('AudioTag') == '255' else None)
b2758123
RA
2727 # TODO: add support for WVC1 and WMAP
2728 if fourcc not in ('H264', 'AVC1', 'AACL'):
2729 self.report_warning('%s is not a supported codec' % fourcc)
2730 continue
2731 tbr = int(track.attrib['Bitrate']) // 1000
76d5a363
S
2732 # [1] does not mention Width and Height attributes. However,
2733 # they're often present while MaxWidth and MaxHeight are
2734 # missing, so should be used as fallbacks
2735 width = int_or_none(track.get('MaxWidth') or track.get('Width'))
2736 height = int_or_none(track.get('MaxHeight') or track.get('Height'))
b2758123
RA
2737 sampling_rate = int_or_none(track.get('SamplingRate'))
2738
2739 track_url_pattern = re.sub(r'{[Bb]itrate}', track.attrib['Bitrate'], url_pattern)
2740 track_url_pattern = compat_urlparse.urljoin(ism_url, track_url_pattern)
2741
2742 fragments = []
2743 fragment_ctx = {
2744 'time': 0,
2745 }
2746 stream_fragments = stream.findall('c')
2747 for stream_fragment_index, stream_fragment in enumerate(stream_fragments):
2748 fragment_ctx['time'] = int_or_none(stream_fragment.get('t')) or fragment_ctx['time']
2749 fragment_repeat = int_or_none(stream_fragment.get('r')) or 1
2750 fragment_ctx['duration'] = int_or_none(stream_fragment.get('d'))
2751 if not fragment_ctx['duration']:
2752 try:
2753 next_fragment_time = int(stream_fragment[stream_fragment_index + 1].attrib['t'])
2754 except IndexError:
2755 next_fragment_time = duration
1616f9b4 2756 fragment_ctx['duration'] = (next_fragment_time - fragment_ctx['time']) / fragment_repeat
b2758123
RA
2757 for _ in range(fragment_repeat):
2758 fragments.append({
1616f9b4 2759 'url': re.sub(r'{start[ _]time}', compat_str(fragment_ctx['time']), track_url_pattern),
b2758123
RA
2760 'duration': fragment_ctx['duration'] / stream_timescale,
2761 })
2762 fragment_ctx['time'] += fragment_ctx['duration']
2763
2764 format_id = []
2765 if ism_id:
2766 format_id.append(ism_id)
2767 if stream_name:
2768 format_id.append(stream_name)
2769 format_id.append(compat_str(tbr))
2770
2771 formats.append({
2772 'format_id': '-'.join(format_id),
2773 'url': ism_url,
2774 'manifest_url': ism_url,
2775 'ext': 'ismv' if stream_type == 'video' else 'isma',
2776 'width': width,
2777 'height': height,
2778 'tbr': tbr,
2779 'asr': sampling_rate,
2780 'vcodec': 'none' if stream_type == 'audio' else fourcc,
2781 'acodec': 'none' if stream_type == 'video' else fourcc,
2782 'protocol': 'ism',
2783 'fragments': fragments,
2784 '_download_params': {
2785 'duration': duration,
2786 'timescale': stream_timescale,
2787 'width': width or 0,
2788 'height': height or 0,
2789 'fourcc': fourcc,
2790 'codec_private_data': track.get('CodecPrivateData'),
2791 'sampling_rate': sampling_rate,
2792 'channels': int_or_none(track.get('Channels', 2)),
2793 'bits_per_sample': int_or_none(track.get('BitsPerSample', 16)),
2794 'nal_unit_length_field': int_or_none(track.get('NALUnitLengthField', 4)),
2795 },
2796 })
2797 return formats
2798
f983b875 2799 def _parse_html5_media_entries(self, base_url, webpage, video_id, m3u8_id=None, m3u8_entry_protocol='m3u8', mpd_id=None, preference=None, quality=None):
6780154e
S
2800 def absolute_url(item_url):
2801 return urljoin(base_url, item_url)
59bbe491 2802
2803 def parse_content_type(content_type):
2804 if not content_type:
2805 return {}
2806 ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
2807 if ctr:
2808 mimetype, codecs = ctr.groups()
2809 f = parse_codecs(codecs)
2810 f['ext'] = mimetype2ext(mimetype)
2811 return f
2812 return {}
2813
868f79db 2814 def _media_formats(src, cur_media_type, type_info={}):
520251c0 2815 full_url = absolute_url(src)
82889d4a 2816 ext = type_info.get('ext') or determine_ext(full_url)
87a449c1 2817 if ext == 'm3u8':
520251c0
YCH
2818 is_plain_url = False
2819 formats = self._extract_m3u8_formats(
ad120ae1 2820 full_url, video_id, ext='mp4',
eeb0a956 2821 entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id,
f983b875 2822 preference=preference, quality=quality, fatal=False)
87a449c1
S
2823 elif ext == 'mpd':
2824 is_plain_url = False
2825 formats = self._extract_mpd_formats(
b359e977 2826 full_url, video_id, mpd_id=mpd_id, fatal=False)
520251c0
YCH
2827 else:
2828 is_plain_url = True
2829 formats = [{
2830 'url': full_url,
2831 'vcodec': 'none' if cur_media_type == 'audio' else None,
2832 }]
2833 return is_plain_url, formats
2834
59bbe491 2835 entries = []
4328ddf8
S
2836 # amp-video and amp-audio are very similar to their HTML5 counterparts
2837 # so we wll include them right here (see
2838 # https://www.ampproject.org/docs/reference/components/amp-video)
29f7c58a 2839 # For dl8-* tags see https://delight-vr.com/documentation/dl8-video/
2840 _MEDIA_TAG_NAME_RE = r'(?:(?:amp|dl8(?:-live)?)-)?(video|audio)'
2841 media_tags = [(media_tag, media_tag_name, media_type, '')
2842 for media_tag, media_tag_name, media_type
2843 in re.findall(r'(?s)(<(%s)[^>]*/>)' % _MEDIA_TAG_NAME_RE, webpage)]
2aec7256
S
2844 media_tags.extend(re.findall(
2845 # We only allow video|audio followed by a whitespace or '>'.
2846 # Allowing more characters may end up in significant slow down (see
067aa17e 2847 # https://github.com/ytdl-org/youtube-dl/issues/11979, example URL:
2aec7256 2848 # http://www.porntrex.com/maps/videositemap.xml).
29f7c58a 2849 r'(?s)(<(?P<tag>%s)(?:\s+[^>]*)?>)(.*?)</(?P=tag)>' % _MEDIA_TAG_NAME_RE, webpage))
2850 for media_tag, _, media_type, media_content in media_tags:
59bbe491 2851 media_info = {
2852 'formats': [],
2853 'subtitles': {},
2854 }
2855 media_attributes = extract_attributes(media_tag)
f856816b 2856 src = strip_or_none(media_attributes.get('src'))
59bbe491 2857 if src:
dedb1770 2858 _, formats = _media_formats(src, media_type)
520251c0 2859 media_info['formats'].extend(formats)
6780154e 2860 media_info['thumbnail'] = absolute_url(media_attributes.get('poster'))
59bbe491 2861 if media_content:
2862 for source_tag in re.findall(r'<source[^>]+>', media_content):
d493f15c
S
2863 s_attr = extract_attributes(source_tag)
2864 # data-video-src and data-src are non standard but seen
2865 # several times in the wild
f856816b 2866 src = strip_or_none(dict_get(s_attr, ('src', 'data-video-src', 'data-src')))
59bbe491 2867 if not src:
2868 continue
d493f15c 2869 f = parse_content_type(s_attr.get('type'))
868f79db 2870 is_plain_url, formats = _media_formats(src, media_type, f)
520251c0 2871 if is_plain_url:
d493f15c
S
2872 # width, height, res, label and title attributes are
2873 # all not standard but seen several times in the wild
2874 labels = [
2875 s_attr.get(lbl)
2876 for lbl in ('label', 'title')
2877 if str_or_none(s_attr.get(lbl))
2878 ]
2879 width = int_or_none(s_attr.get('width'))
3089bc74
S
2880 height = (int_or_none(s_attr.get('height'))
2881 or int_or_none(s_attr.get('res')))
d493f15c
S
2882 if not width or not height:
2883 for lbl in labels:
2884 resolution = parse_resolution(lbl)
2885 if not resolution:
2886 continue
2887 width = width or resolution.get('width')
2888 height = height or resolution.get('height')
2889 for lbl in labels:
2890 tbr = parse_bitrate(lbl)
2891 if tbr:
2892 break
2893 else:
2894 tbr = None
1ed45499 2895 f.update({
d493f15c
S
2896 'width': width,
2897 'height': height,
2898 'tbr': tbr,
2899 'format_id': s_attr.get('label') or s_attr.get('title'),
1ed45499 2900 })
520251c0
YCH
2901 f.update(formats[0])
2902 media_info['formats'].append(f)
2903 else:
2904 media_info['formats'].extend(formats)
59bbe491 2905 for track_tag in re.findall(r'<track[^>]+>', media_content):
2906 track_attributes = extract_attributes(track_tag)
2907 kind = track_attributes.get('kind')
5968d7d2 2908 if not kind or kind in ('subtitles', 'captions'):
f856816b 2909 src = strip_or_none(track_attributes.get('src'))
59bbe491 2910 if not src:
2911 continue
2912 lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
2913 media_info['subtitles'].setdefault(lang, []).append({
2914 'url': absolute_url(src),
2915 })
5e8e2fa5
S
2916 for f in media_info['formats']:
2917 f.setdefault('http_headers', {})['Referer'] = base_url
5968d7d2 2918 if media_info['formats'] or media_info['subtitles']:
59bbe491 2919 entries.append(media_info)
2920 return entries
2921
c4251b9a 2922 def _extract_akamai_formats(self, manifest_url, video_id, hosts={}):
29f7c58a 2923 signed = 'hdnea=' in manifest_url
2924 if not signed:
2925 # https://learn.akamai.com/en-us/webhelp/media-services-on-demand/stream-packaging-user-guide/GUID-BE6C0F73-1E06-483B-B0EA-57984B91B7F9.html
2926 manifest_url = re.sub(
2927 r'(?:b=[\d,-]+|(?:__a__|attributes)=off|__b__=\d+)&?',
2928 '', manifest_url).strip('?')
2929
c7c43a93 2930 formats = []
70c5802b 2931
e71a4509 2932 hdcore_sign = 'hdcore=3.7.0'
ff6f9a67 2933 f4m_url = re.sub(r'(https?://[^/]+)/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
c4251b9a
RA
2934 hds_host = hosts.get('hds')
2935 if hds_host:
2936 f4m_url = re.sub(r'(https?://)[^/]+', r'\1' + hds_host, f4m_url)
e71a4509
RA
2937 if 'hdcore=' not in f4m_url:
2938 f4m_url += ('&' if '?' in f4m_url else '?') + hdcore_sign
2939 f4m_formats = self._extract_f4m_formats(
2940 f4m_url, video_id, f4m_id='hds', fatal=False)
2941 for entry in f4m_formats:
2942 entry.update({'extra_param_to_segment_url': hdcore_sign})
2943 formats.extend(f4m_formats)
70c5802b 2944
c4251b9a
RA
2945 m3u8_url = re.sub(r'(https?://[^/]+)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
2946 hls_host = hosts.get('hls')
2947 if hls_host:
2948 m3u8_url = re.sub(r'(https?://)[^/]+', r'\1' + hls_host, m3u8_url)
29f7c58a 2949 m3u8_formats = self._extract_m3u8_formats(
c7c43a93 2950 m3u8_url, video_id, 'mp4', 'm3u8_native',
29f7c58a 2951 m3u8_id='hls', fatal=False)
2952 formats.extend(m3u8_formats)
70c5802b 2953
2954 http_host = hosts.get('http')
29f7c58a 2955 if http_host and m3u8_formats and not signed:
2956 REPL_REGEX = r'https?://[^/]+/i/([^,]+),([^/]+),([^/]+)\.csmil/.+'
70c5802b 2957 qualities = re.match(REPL_REGEX, m3u8_url).group(2).split(',')
2958 qualities_length = len(qualities)
29f7c58a 2959 if len(m3u8_formats) in (qualities_length, qualities_length + 1):
70c5802b 2960 i = 0
29f7c58a 2961 for f in m3u8_formats:
2962 if f['vcodec'] != 'none':
70c5802b 2963 for protocol in ('http', 'https'):
2964 http_f = f.copy()
2965 del http_f['manifest_url']
2966 http_url = re.sub(
29f7c58a 2967 REPL_REGEX, protocol + r'://%s/\g<1>%s\3' % (http_host, qualities[i]), f['url'])
70c5802b 2968 http_f.update({
2969 'format_id': http_f['format_id'].replace('hls-', protocol + '-'),
2970 'url': http_url,
2971 'protocol': protocol,
2972 })
29f7c58a 2973 formats.append(http_f)
70c5802b 2974 i += 1
70c5802b 2975
c7c43a93
RA
2976 return formats
2977
6ad02195 2978 def _extract_wowza_formats(self, url, video_id, m3u8_entry_protocol='m3u8_native', skip_protocols=[]):
044eeb14 2979 query = compat_urlparse.urlparse(url).query
6ad02195 2980 url = re.sub(r'/(?:manifest|playlist|jwplayer)\.(?:m3u8|f4m|mpd|smil)', '', url)
240f2622
S
2981 mobj = re.search(
2982 r'(?:(?:http|rtmp|rtsp)(?P<s>s)?:)?(?P<url>//[^?]+)', url)
2983 url_base = mobj.group('url')
2984 http_base_url = '%s%s:%s' % ('http', mobj.group('s') or '', url_base)
6ad02195 2985 formats = []
044eeb14
S
2986
2987 def manifest_url(manifest):
2988 m_url = '%s/%s' % (http_base_url, manifest)
2989 if query:
2990 m_url += '?%s' % query
2991 return m_url
2992
6ad02195
RA
2993 if 'm3u8' not in skip_protocols:
2994 formats.extend(self._extract_m3u8_formats(
044eeb14 2995 manifest_url('playlist.m3u8'), video_id, 'mp4',
6ad02195
RA
2996 m3u8_entry_protocol, m3u8_id='hls', fatal=False))
2997 if 'f4m' not in skip_protocols:
2998 formats.extend(self._extract_f4m_formats(
044eeb14 2999 manifest_url('manifest.f4m'),
6ad02195 3000 video_id, f4m_id='hds', fatal=False))
0384932e
RA
3001 if 'dash' not in skip_protocols:
3002 formats.extend(self._extract_mpd_formats(
044eeb14 3003 manifest_url('manifest.mpd'),
0384932e 3004 video_id, mpd_id='dash', fatal=False))
6ad02195 3005 if re.search(r'(?:/smil:|\.smil)', url_base):
6ad02195
RA
3006 if 'smil' not in skip_protocols:
3007 rtmp_formats = self._extract_smil_formats(
044eeb14 3008 manifest_url('jwplayer.smil'),
6ad02195
RA
3009 video_id, fatal=False)
3010 for rtmp_format in rtmp_formats:
3011 rtsp_format = rtmp_format.copy()
3012 rtsp_format['url'] = '%s/%s' % (rtmp_format['url'], rtmp_format['play_path'])
3013 del rtsp_format['play_path']
3014 del rtsp_format['ext']
3015 rtsp_format.update({
3016 'url': rtsp_format['url'].replace('rtmp://', 'rtsp://'),
3017 'format_id': rtmp_format['format_id'].replace('rtmp', 'rtsp'),
3018 'protocol': 'rtsp',
3019 })
3020 formats.extend([rtmp_format, rtsp_format])
3021 else:
3022 for protocol in ('rtmp', 'rtsp'):
3023 if protocol not in skip_protocols:
3024 formats.append({
f2e2f0c7 3025 'url': '%s:%s' % (protocol, url_base),
6ad02195
RA
3026 'format_id': protocol,
3027 'protocol': protocol,
3028 })
3029 return formats
3030
c73e330e 3031 def _find_jwplayer_data(self, webpage, video_id=None, transform_source=js_to_json):
a4a554a7 3032 mobj = re.search(
ac9c69ac 3033 r'(?s)jwplayer\((?P<quote>[\'"])[^\'" ]+(?P=quote)\)(?!</script>).*?\.setup\s*\((?P<options>[^)]+)\)',
a4a554a7
YCH
3034 webpage)
3035 if mobj:
c73e330e
RU
3036 try:
3037 jwplayer_data = self._parse_json(mobj.group('options'),
3038 video_id=video_id,
3039 transform_source=transform_source)
3040 except ExtractorError:
3041 pass
3042 else:
3043 if isinstance(jwplayer_data, dict):
3044 return jwplayer_data
a4a554a7
YCH
3045
3046 def _extract_jwplayer_data(self, webpage, video_id, *args, **kwargs):
c73e330e
RU
3047 jwplayer_data = self._find_jwplayer_data(
3048 webpage, video_id, transform_source=js_to_json)
a4a554a7
YCH
3049 return self._parse_jwplayer_data(
3050 jwplayer_data, video_id, *args, **kwargs)
3051
3052 def _parse_jwplayer_data(self, jwplayer_data, video_id=None, require_title=True,
3053 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
3054 # JWPlayer backward compatibility: flattened playlists
3055 # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/api/config.js#L81-L96
3056 if 'playlist' not in jwplayer_data:
3057 jwplayer_data = {'playlist': [jwplayer_data]}
3058
3059 entries = []
3060
3061 # JWPlayer backward compatibility: single playlist item
3062 # https://github.com/jwplayer/jwplayer/blob/v7.7.0/src/js/playlist/playlist.js#L10
3063 if not isinstance(jwplayer_data['playlist'], list):
3064 jwplayer_data['playlist'] = [jwplayer_data['playlist']]
3065
3066 for video_data in jwplayer_data['playlist']:
3067 # JWPlayer backward compatibility: flattened sources
3068 # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/playlist/item.js#L29-L35
3069 if 'sources' not in video_data:
3070 video_data['sources'] = [video_data]
3071
3072 this_video_id = video_id or video_data['mediaid']
3073
1a2192cb
S
3074 formats = self._parse_jwplayer_formats(
3075 video_data['sources'], video_id=this_video_id, m3u8_id=m3u8_id,
3076 mpd_id=mpd_id, rtmp_params=rtmp_params, base_url=base_url)
a4a554a7
YCH
3077
3078 subtitles = {}
3079 tracks = video_data.get('tracks')
3080 if tracks and isinstance(tracks, list):
3081 for track in tracks:
96a2daa1
S
3082 if not isinstance(track, dict):
3083 continue
f4b74272
S
3084 track_kind = track.get('kind')
3085 if not track_kind or not isinstance(track_kind, compat_str):
3086 continue
3087 if track_kind.lower() not in ('captions', 'subtitles'):
a4a554a7
YCH
3088 continue
3089 track_url = urljoin(base_url, track.get('file'))
3090 if not track_url:
3091 continue
3092 subtitles.setdefault(track.get('label') or 'en', []).append({
3093 'url': self._proto_relative_url(track_url)
3094 })
3095
50d808f5 3096 entry = {
a4a554a7 3097 'id': this_video_id,
50d808f5 3098 'title': unescapeHTML(video_data['title'] if require_title else video_data.get('title')),
f81dd65b 3099 'description': clean_html(video_data.get('description')),
6945b9e7 3100 'thumbnail': urljoin(base_url, self._proto_relative_url(video_data.get('image'))),
a4a554a7
YCH
3101 'timestamp': int_or_none(video_data.get('pubdate')),
3102 'duration': float_or_none(jwplayer_data.get('duration') or video_data.get('duration')),
3103 'subtitles': subtitles,
50d808f5
RA
3104 }
3105 # https://github.com/jwplayer/jwplayer/blob/master/src/js/utils/validator.js#L32
3106 if len(formats) == 1 and re.search(r'^(?:http|//).*(?:youtube\.com|youtu\.be)/.+', formats[0]['url']):
3107 entry.update({
3108 '_type': 'url_transparent',
3109 'url': formats[0]['url'],
3110 })
3111 else:
3112 self._sort_formats(formats)
3113 entry['formats'] = formats
3114 entries.append(entry)
a4a554a7
YCH
3115 if len(entries) == 1:
3116 return entries[0]
3117 else:
3118 return self.playlist_result(entries)
3119
ed0cf9b3
S
3120 def _parse_jwplayer_formats(self, jwplayer_sources_data, video_id=None,
3121 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
bf1b87cd 3122 urls = []
ed0cf9b3 3123 formats = []
1a2192cb 3124 for source in jwplayer_sources_data:
0a268c6e
S
3125 if not isinstance(source, dict):
3126 continue
6945b9e7
RA
3127 source_url = urljoin(
3128 base_url, self._proto_relative_url(source.get('file')))
3129 if not source_url or source_url in urls:
bf1b87cd
RA
3130 continue
3131 urls.append(source_url)
ed0cf9b3
S
3132 source_type = source.get('type') or ''
3133 ext = mimetype2ext(source_type) or determine_ext(source_url)
3134 if source_type == 'hls' or ext == 'm3u8':
3135 formats.extend(self._extract_m3u8_formats(
0236cd0d
S
3136 source_url, video_id, 'mp4', entry_protocol='m3u8_native',
3137 m3u8_id=m3u8_id, fatal=False))
0d9c48de 3138 elif source_type == 'dash' or ext == 'mpd':
ed0cf9b3
S
3139 formats.extend(self._extract_mpd_formats(
3140 source_url, video_id, mpd_id=mpd_id, fatal=False))
b51dc9db
S
3141 elif ext == 'smil':
3142 formats.extend(self._extract_smil_formats(
3143 source_url, video_id, fatal=False))
ed0cf9b3 3144 # https://github.com/jwplayer/jwplayer/blob/master/src/js/providers/default.js#L67
0236cd0d
S
3145 elif source_type.startswith('audio') or ext in (
3146 'oga', 'aac', 'mp3', 'mpeg', 'vorbis'):
ed0cf9b3
S
3147 formats.append({
3148 'url': source_url,
3149 'vcodec': 'none',
3150 'ext': ext,
3151 })
3152 else:
3153 height = int_or_none(source.get('height'))
3154 if height is None:
3155 # Often no height is provided but there is a label in
0236cd0d 3156 # format like "1080p", "720p SD", or 1080.
ed0cf9b3 3157 height = int_or_none(self._search_regex(
0236cd0d 3158 r'^(\d{3,4})[pP]?(?:\b|$)', compat_str(source.get('label') or ''),
ed0cf9b3
S
3159 'height', default=None))
3160 a_format = {
3161 'url': source_url,
3162 'width': int_or_none(source.get('width')),
3163 'height': height,
0236cd0d 3164 'tbr': int_or_none(source.get('bitrate')),
ed0cf9b3
S
3165 'ext': ext,
3166 }
3167 if source_url.startswith('rtmp'):
3168 a_format['ext'] = 'flv'
ed0cf9b3
S
3169 # See com/longtailvideo/jwplayer/media/RTMPMediaProvider.as
3170 # of jwplayer.flash.swf
3171 rtmp_url_parts = re.split(
3172 r'((?:mp4|mp3|flv):)', source_url, 1)
3173 if len(rtmp_url_parts) == 3:
3174 rtmp_url, prefix, play_path = rtmp_url_parts
3175 a_format.update({
3176 'url': rtmp_url,
3177 'play_path': prefix + play_path,
3178 })
3179 if rtmp_params:
3180 a_format.update(rtmp_params)
3181 formats.append(a_format)
3182 return formats
3183
f4b1c7ad
PH
3184 def _live_title(self, name):
3185 """ Generate the title for a live video """
3186 now = datetime.datetime.now()
611c1dd9 3187 now_str = now.strftime('%Y-%m-%d %H:%M')
f4b1c7ad
PH
3188 return name + ' ' + now_str
3189
b14f3a4c
PH
3190 def _int(self, v, name, fatal=False, **kwargs):
3191 res = int_or_none(v, **kwargs)
3192 if 'get_attr' in kwargs:
3193 print(getattr(v, kwargs['get_attr']))
3194 if res is None:
3195 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
3196 if fatal:
3197 raise ExtractorError(msg)
3198 else:
3199 self._downloader.report_warning(msg)
3200 return res
3201
3202 def _float(self, v, name, fatal=False, **kwargs):
3203 res = float_or_none(v, **kwargs)
3204 if res is None:
3205 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
3206 if fatal:
3207 raise ExtractorError(msg)
3208 else:
3209 self._downloader.report_warning(msg)
3210 return res
3211
40e41780
TF
3212 def _set_cookie(self, domain, name, value, expire_time=None, port=None,
3213 path='/', secure=False, discard=False, rest={}, **kwargs):
6c22cee6 3214 cookie = compat_cookiejar_Cookie(
4ed2d7b7 3215 0, name, value, port, port is not None, domain, True,
40e41780
TF
3216 domain.startswith('.'), path, True, secure, expire_time,
3217 discard, None, None, rest)
42939b61
JMF
3218 self._downloader.cookiejar.set_cookie(cookie)
3219
799207e8 3220 def _get_cookies(self, url):
3221 """ Return a compat_cookies.SimpleCookie with the cookies for the url """
5c2266df 3222 req = sanitized_Request(url)
799207e8 3223 self._downloader.cookiejar.add_cookie_header(req)
3224 return compat_cookies.SimpleCookie(req.get_header('Cookie'))
3225
e3c1266f 3226 def _apply_first_set_cookie_header(self, url_handle, cookie):
ce2fe4c0
S
3227 """
3228 Apply first Set-Cookie header instead of the last. Experimental.
3229
3230 Some sites (e.g. [1-3]) may serve two cookies under the same name
3231 in Set-Cookie header and expect the first (old) one to be set rather
3232 than second (new). However, as of RFC6265 the newer one cookie
3233 should be set into cookie store what actually happens.
3234 We will workaround this issue by resetting the cookie to
3235 the first one manually.
3236 1. https://new.vk.com/
3237 2. https://github.com/ytdl-org/youtube-dl/issues/9841#issuecomment-227871201
3238 3. https://learning.oreilly.com/
3239 """
e3c1266f
S
3240 for header, cookies in url_handle.headers.items():
3241 if header.lower() != 'set-cookie':
3242 continue
3243 if sys.version_info[0] >= 3:
3244 cookies = cookies.encode('iso-8859-1')
3245 cookies = cookies.decode('utf-8')
3246 cookie_value = re.search(
3247 r'%s=(.+?);.*?\b[Dd]omain=(.+?)(?:[,;]|$)' % cookie, cookies)
3248 if cookie_value:
3249 value, domain = cookie_value.groups()
3250 self._set_cookie(domain, cookie, value)
3251 break
3252
05900629
PH
3253 def get_testcases(self, include_onlymatching=False):
3254 t = getattr(self, '_TEST', None)
3255 if t:
3256 assert not hasattr(self, '_TESTS'), \
3257 '%s has _TEST and _TESTS' % type(self).__name__
3258 tests = [t]
3259 else:
3260 tests = getattr(self, '_TESTS', [])
3261 for t in tests:
3262 if not include_onlymatching and t.get('only_matching', False):
3263 continue
3264 t['name'] = type(self).__name__[:-len('IE')]
3265 yield t
3266
3267 def is_suitable(self, age_limit):
3268 """ Test whether the extractor is generally suitable for the given
3269 age limit (i.e. pornographic sites are not, all others usually are) """
3270
3271 any_restricted = False
3272 for tc in self.get_testcases(include_onlymatching=False):
40090e8d 3273 if tc.get('playlist', []):
05900629
PH
3274 tc = tc['playlist'][0]
3275 is_restricted = age_restricted(
3276 tc.get('info_dict', {}).get('age_limit'), age_limit)
3277 if not is_restricted:
3278 return True
3279 any_restricted = any_restricted or is_restricted
3280 return not any_restricted
3281
a504ced0 3282 def extract_subtitles(self, *args, **kwargs):
3089bc74
S
3283 if (self._downloader.params.get('writesubtitles', False)
3284 or self._downloader.params.get('listsubtitles')):
9868ea49
JMF
3285 return self._get_subtitles(*args, **kwargs)
3286 return {}
a504ced0
JMF
3287
3288 def _get_subtitles(self, *args, **kwargs):
611c1dd9 3289 raise NotImplementedError('This method must be implemented by subclasses')
a504ced0 3290
912e0b7e
YCH
3291 @staticmethod
3292 def _merge_subtitle_items(subtitle_list1, subtitle_list2):
3293 """ Merge subtitle items for one language. Items with duplicated URLs
3294 will be dropped. """
3295 list1_urls = set([item['url'] for item in subtitle_list1])
3296 ret = list(subtitle_list1)
3297 ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
3298 return ret
3299
3300 @classmethod
8c97f819 3301 def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2):
912e0b7e 3302 """ Merge two subtitle dictionaries, language by language. """
912e0b7e
YCH
3303 ret = dict(subtitle_dict1)
3304 for lang in subtitle_dict2:
8c97f819 3305 ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang])
912e0b7e
YCH
3306 return ret
3307
360e1ca5 3308 def extract_automatic_captions(self, *args, **kwargs):
3089bc74
S
3309 if (self._downloader.params.get('writeautomaticsub', False)
3310 or self._downloader.params.get('listsubtitles')):
9868ea49
JMF
3311 return self._get_automatic_captions(*args, **kwargs)
3312 return {}
360e1ca5
JMF
3313
3314 def _get_automatic_captions(self, *args, **kwargs):
611c1dd9 3315 raise NotImplementedError('This method must be implemented by subclasses')
360e1ca5 3316
d77ab8e2 3317 def mark_watched(self, *args, **kwargs):
3089bc74
S
3318 if (self._downloader.params.get('mark_watched', False)
3319 and (self._get_login_info()[0] is not None
3320 or self._downloader.params.get('cookiefile') is not None)):
d77ab8e2
S
3321 self._mark_watched(*args, **kwargs)
3322
3323 def _mark_watched(self, *args, **kwargs):
3324 raise NotImplementedError('This method must be implemented by subclasses')
3325
38cce791
YCH
3326 def geo_verification_headers(self):
3327 headers = {}
3328 geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
3329 if geo_verification_proxy:
3330 headers['Ytdl-request-proxy'] = geo_verification_proxy
3331 return headers
3332
98763ee3
YCH
3333 def _generic_id(self, url):
3334 return compat_urllib_parse_unquote(os.path.splitext(url.rstrip('/').split('/')[-1])[0])
3335
3336 def _generic_title(self, url):
3337 return compat_urllib_parse_unquote(os.path.splitext(url_basename(url))[0])
3338
c224251a
M
3339 @staticmethod
3340 def _availability(is_private, needs_premium, needs_subscription, needs_auth, is_unlisted):
3341 all_known = all(map(
3342 lambda x: x is not None,
3343 (is_private, needs_premium, needs_subscription, needs_auth, is_unlisted)))
3344 return (
3345 'private' if is_private
3346 else 'premium_only' if needs_premium
3347 else 'subscriber_only' if needs_subscription
3348 else 'needs_auth' if needs_auth
3349 else 'unlisted' if is_unlisted
3350 else 'public' if all_known
3351 else None)
3352
8dbe9899 3353
d6983cb4
PH
3354class SearchInfoExtractor(InfoExtractor):
3355 """
3356 Base class for paged search queries extractors.
10952eb2 3357 They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
d6983cb4
PH
3358 Instances should define _SEARCH_KEY and _MAX_RESULTS.
3359 """
3360
3361 @classmethod
3362 def _make_valid_url(cls):
3363 return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
3364
3365 @classmethod
3366 def suitable(cls, url):
3367 return re.match(cls._make_valid_url(), url) is not None
3368
3369 def _real_extract(self, query):
3370 mobj = re.match(self._make_valid_url(), query)
3371 if mobj is None:
f1a9d64e 3372 raise ExtractorError('Invalid search query "%s"' % query)
d6983cb4
PH
3373
3374 prefix = mobj.group('prefix')
3375 query = mobj.group('query')
3376 if prefix == '':
3377 return self._get_n_results(query, 1)
3378 elif prefix == 'all':
3379 return self._get_n_results(query, self._MAX_RESULTS)
3380 else:
3381 n = int(prefix)
3382 if n <= 0:
f1a9d64e 3383 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
d6983cb4 3384 elif n > self._MAX_RESULTS:
f1a9d64e 3385 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
d6983cb4
PH
3386 n = self._MAX_RESULTS
3387 return self._get_n_results(query, n)
3388
3389 def _get_n_results(self, query, n):
3390 """Get a specified number of results for a query"""
611c1dd9 3391 raise NotImplementedError('This method must be implemented by subclasses')
0f818663
PH
3392
3393 @property
3394 def SEARCH_KEY(self):
3395 return self._SEARCH_KEY