]> jfr.im git - yt-dlp.git/blame - yt_dlp/extractor/common.py
[whowatch] Add extractor #292
[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,
f7ad7160 20 compat_cookies_SimpleCookie,
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.
0fa9a1e2 160 "http", "https", "rtsp", "rtmp", "rtmp_ffmpeg", "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:
6a39ee13 686 self.report_warning(errmsg)
7cc3570e 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
b7da73eb 971 def raise_login_required(
972 self, msg='This video is only available for registered users', metadata_available=False):
973 if metadata_available and self._downloader.params.get('ignore_no_formats_error'):
974 self.report_warning(msg)
43e7d3c9 975 raise ExtractorError(
b7da73eb 976 '%s. Use --cookies, --username and --password or --netrc to provide account credentials' % msg,
43e7d3c9
S
977 expected=True)
978
b7da73eb 979 def raise_geo_restricted(
980 self, msg='This video is not available from your location due to geo restriction',
981 countries=None, metadata_available=False):
982 if metadata_available and self._downloader.params.get('ignore_no_formats_error'):
983 self.report_warning(msg)
984 else:
985 raise GeoRestrictedError(msg, countries=countries)
986
987 def raise_no_formats(self, msg, expected=False, video_id=None):
988 if expected and self._downloader.params.get('ignore_no_formats_error'):
989 self.report_warning(msg, video_id)
990 else:
991 raise ExtractorError(msg, expected=expected, video_id=video_id)
c430802e 992
5f6a1245 993 # Methods for following #608
c0d0b01f 994 @staticmethod
830d53bf 995 def url_result(url, ie=None, video_id=None, video_title=None):
10952eb2 996 """Returns a URL that points to a page that should be processed"""
5f6a1245 997 # TODO: ie should be the class used for getting the info
d6983cb4
PH
998 video_info = {'_type': 'url',
999 'url': url,
1000 'ie_key': ie}
7012b23c
PH
1001 if video_id is not None:
1002 video_info['id'] = video_id
830d53bf
S
1003 if video_title is not None:
1004 video_info['title'] = video_title
d6983cb4 1005 return video_info
5f6a1245 1006
749ca5ec
S
1007 def playlist_from_matches(self, matches, playlist_id=None, playlist_title=None, getter=None, ie=None):
1008 urls = orderedSet(
46b18f23
JH
1009 self.url_result(self._proto_relative_url(getter(m) if getter else m), ie)
1010 for m in matches)
1011 return self.playlist_result(
749ca5ec 1012 urls, playlist_id=playlist_id, playlist_title=playlist_title)
46b18f23 1013
c0d0b01f 1014 @staticmethod
b60419c5 1015 def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None, **kwargs):
d6983cb4
PH
1016 """Returns a playlist"""
1017 video_info = {'_type': 'playlist',
1018 'entries': entries}
b60419c5 1019 video_info.update(kwargs)
d6983cb4
PH
1020 if playlist_id:
1021 video_info['id'] = playlist_id
1022 if playlist_title:
1023 video_info['title'] = playlist_title
ecc97af3 1024 if playlist_description is not None:
acf5cbfe 1025 video_info['description'] = playlist_description
d6983cb4
PH
1026 return video_info
1027
c342041f 1028 def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
1029 """
1030 Perform a regex search on the given string, using a single or a list of
1031 patterns returning the first matching group.
1032 In case of failure return a default value or raise a WARNING or a
55b3e45b 1033 RegexNotFoundError, depending on fatal, specifying the field name.
d6983cb4
PH
1034 """
1035 if isinstance(pattern, (str, compat_str, compiled_regex_type)):
1036 mobj = re.search(pattern, string, flags)
1037 else:
1038 for p in pattern:
1039 mobj = re.search(p, string, flags)
c3415d1b
PH
1040 if mobj:
1041 break
d6983cb4 1042
e9c0cdd3 1043 if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
f1a9d64e 1044 _name = '\033[0;34m%s\033[0m' % name
d6983cb4
PH
1045 else:
1046 _name = name
1047
1048 if mobj:
711ede6e
PH
1049 if group is None:
1050 # return the first matching group
1051 return next(g for g in mobj.groups() if g is not None)
1052 else:
1053 return mobj.group(group)
c342041f 1054 elif default is not NO_DEFAULT:
d6983cb4
PH
1055 return default
1056 elif fatal:
f1a9d64e 1057 raise RegexNotFoundError('Unable to extract %s' % _name)
d6983cb4 1058 else:
6a39ee13 1059 self.report_warning('unable to extract %s' % _name + bug_reports_message())
d6983cb4
PH
1060 return None
1061
c342041f 1062 def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
1063 """
1064 Like _search_regex, but strips HTML tags and unescapes entities.
1065 """
711ede6e 1066 res = self._search_regex(pattern, string, name, default, fatal, flags, group)
d6983cb4
PH
1067 if res:
1068 return clean_html(res).strip()
1069 else:
1070 return res
1071
2118fdd1
RA
1072 def _get_netrc_login_info(self, netrc_machine=None):
1073 username = None
1074 password = None
1075 netrc_machine = netrc_machine or self._NETRC_MACHINE
1076
1077 if self._downloader.params.get('usenetrc', False):
1078 try:
1079 info = netrc.netrc().authenticators(netrc_machine)
1080 if info is not None:
1081 username = info[0]
1082 password = info[2]
1083 else:
dcce092e
S
1084 raise netrc.NetrcParseError(
1085 'No authenticators for %s' % netrc_machine)
2118fdd1 1086 except (IOError, netrc.NetrcParseError) as err:
6a39ee13 1087 self.report_warning(
dcce092e 1088 'parsing .netrc: %s' % error_to_compat_str(err))
2118fdd1 1089
dcce092e 1090 return username, password
2118fdd1 1091
1b6712ab 1092 def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
fc79158d 1093 """
cf0649f8 1094 Get the login info as (username, password)
32443dd3
S
1095 First look for the manually specified credentials using username_option
1096 and password_option as keys in params dictionary. If no such credentials
1097 available look in the netrc file using the netrc_machine or _NETRC_MACHINE
1098 value.
fc79158d
JMF
1099 If there's no info available, return (None, None)
1100 """
1101 if self._downloader is None:
1102 return (None, None)
1103
fc79158d
JMF
1104 downloader_params = self._downloader.params
1105
1106 # Attempt to use provided username and password or .netrc data
1b6712ab
RA
1107 if downloader_params.get(username_option) is not None:
1108 username = downloader_params[username_option]
1109 password = downloader_params[password_option]
2118fdd1 1110 else:
1b6712ab 1111 username, password = self._get_netrc_login_info(netrc_machine)
5f6a1245 1112
2133565c 1113 return username, password
fc79158d 1114
e64b7569 1115 def _get_tfa_info(self, note='two-factor verification code'):
83317f69 1116 """
1117 Get the two-factor authentication info
1118 TODO - asking the user will be required for sms/phone verify
1119 currently just uses the command line option
1120 If there's no info available, return None
1121 """
1122 if self._downloader is None:
83317f69 1123 return None
1124 downloader_params = self._downloader.params
1125
d800609c 1126 if downloader_params.get('twofactor') is not None:
83317f69 1127 return downloader_params['twofactor']
1128
e64b7569 1129 return compat_getpass('Type %s and press [Return]: ' % note)
83317f69 1130
46720279
JMF
1131 # Helper functions for extracting OpenGraph info
1132 @staticmethod
ab2d5247 1133 def _og_regexes(prop):
448ef1f3 1134 content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
22f5f5c6 1135 property_re = (r'(?:name|property)=(?:\'og[:-]%(prop)s\'|"og[:-]%(prop)s"|\s*og[:-]%(prop)s\b)'
7a6d76a6 1136 % {'prop': re.escape(prop)})
78fb87b2 1137 template = r'<meta[^>]+?%s[^>]+?%s'
ab2d5247 1138 return [
78fb87b2
JMF
1139 template % (property_re, content_re),
1140 template % (content_re, property_re),
ab2d5247 1141 ]
46720279 1142
864f24bd
S
1143 @staticmethod
1144 def _meta_regex(prop):
1145 return r'''(?isx)<meta
8b9848ac 1146 (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
864f24bd
S
1147 [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
1148
3c4e6d83 1149 def _og_search_property(self, prop, html, name=None, **kargs):
b070564e
S
1150 if not isinstance(prop, (list, tuple)):
1151 prop = [prop]
46720279 1152 if name is None:
b070564e
S
1153 name = 'OpenGraph %s' % prop[0]
1154 og_regexes = []
1155 for p in prop:
1156 og_regexes.extend(self._og_regexes(p))
1157 escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
eb0a8398
PH
1158 if escaped is None:
1159 return None
1160 return unescapeHTML(escaped)
46720279
JMF
1161
1162 def _og_search_thumbnail(self, html, **kargs):
10952eb2 1163 return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
46720279
JMF
1164
1165 def _og_search_description(self, html, **kargs):
1166 return self._og_search_property('description', html, fatal=False, **kargs)
1167
1168 def _og_search_title(self, html, **kargs):
1169 return self._og_search_property('title', html, **kargs)
1170
8ffa13e0 1171 def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
a3681973
PH
1172 regexes = self._og_regexes('video') + self._og_regexes('video:url')
1173 if secure:
1174 regexes = self._og_regexes('video:secure_url') + regexes
8ffa13e0 1175 return self._html_search_regex(regexes, html, name, **kargs)
46720279 1176
78338f71
JMF
1177 def _og_search_url(self, html, **kargs):
1178 return self._og_search_property('url', html, **kargs)
1179
40c696e5 1180 def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
88d9f6c0
S
1181 if not isinstance(name, (list, tuple)):
1182 name = [name]
59040888 1183 if display_name is None:
88d9f6c0 1184 display_name = name[0]
59040888 1185 return self._html_search_regex(
88d9f6c0 1186 [self._meta_regex(n) for n in name],
711ede6e 1187 html, display_name, fatal=fatal, group='content', **kwargs)
59040888
PH
1188
1189 def _dc_search_uploader(self, html):
1190 return self._html_search_meta('dc.creator', html, 'uploader')
1191
8dbe9899
PH
1192 def _rta_search(self, html):
1193 # See http://www.rtalabel.org/index.php?content=howtofaq#single
1194 if re.search(r'(?ix)<meta\s+name="rating"\s+'
1195 r' content="RTA-5042-1996-1400-1577-RTA"',
1196 html):
1197 return 18
1198 return 0
1199
59040888
PH
1200 def _media_rating_search(self, html):
1201 # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
1202 rating = self._html_search_meta('rating', html)
1203
1204 if not rating:
1205 return None
1206
1207 RATING_TABLE = {
1208 'safe for kids': 0,
1209 'general': 8,
1210 '14 years': 14,
1211 'mature': 17,
1212 'restricted': 19,
1213 }
d800609c 1214 return RATING_TABLE.get(rating.lower())
59040888 1215
69319969 1216 def _family_friendly_search(self, html):
6ca7732d 1217 # See http://schema.org/VideoObject
ac8491fc
S
1218 family_friendly = self._html_search_meta(
1219 'isFamilyFriendly', html, default=None)
69319969
NJ
1220
1221 if not family_friendly:
1222 return None
1223
1224 RATING_TABLE = {
1225 '1': 0,
1226 'true': 0,
1227 '0': 18,
1228 'false': 18,
1229 }
d800609c 1230 return RATING_TABLE.get(family_friendly.lower())
69319969 1231
0c708f11
JMF
1232 def _twitter_search_player(self, html):
1233 return self._html_search_meta('twitter:player', html,
9e1a5b84 1234 'twitter card player')
0c708f11 1235
95b31e26 1236 def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
4433bb02 1237 json_ld_list = list(re.finditer(JSON_LD_RE, html))
321b5e08 1238 default = kwargs.get('default', NO_DEFAULT)
321b5e08
S
1239 # JSON-LD may be malformed and thus `fatal` should be respected.
1240 # At the same time `default` may be passed that assumes `fatal=False`
1241 # for _search_regex. Let's simulate the same behavior here as well.
1242 fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
4433bb02
S
1243 json_ld = []
1244 for mobj in json_ld_list:
1245 json_ld_item = self._parse_json(
1246 mobj.group('json_ld'), video_id, fatal=fatal)
1247 if not json_ld_item:
1248 continue
1249 if isinstance(json_ld_item, dict):
1250 json_ld.append(json_ld_item)
1251 elif isinstance(json_ld_item, (list, tuple)):
1252 json_ld.extend(json_ld_item)
1253 if json_ld:
1254 json_ld = self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
1255 if json_ld:
1256 return json_ld
1257 if default is not NO_DEFAULT:
1258 return default
1259 elif fatal:
1260 raise RegexNotFoundError('Unable to extract JSON-LD')
1261 else:
6a39ee13 1262 self.report_warning('unable to extract JSON-LD %s' % bug_reports_message())
4433bb02 1263 return {}
4ca2a3cf 1264
95b31e26 1265 def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
4ca2a3cf
S
1266 if isinstance(json_ld, compat_str):
1267 json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
1268 if not json_ld:
1269 return {}
1270 info = {}
46933a15
S
1271 if not isinstance(json_ld, (list, tuple, dict)):
1272 return info
1273 if isinstance(json_ld, dict):
1274 json_ld = [json_ld]
bae14048 1275
e7e4a6e0
S
1276 INTERACTION_TYPE_MAP = {
1277 'CommentAction': 'comment',
1278 'AgreeAction': 'like',
1279 'DisagreeAction': 'dislike',
1280 'LikeAction': 'like',
1281 'DislikeAction': 'dislike',
1282 'ListenAction': 'view',
1283 'WatchAction': 'view',
1284 'ViewAction': 'view',
1285 }
1286
29f7c58a 1287 def extract_interaction_type(e):
1288 interaction_type = e.get('interactionType')
1289 if isinstance(interaction_type, dict):
1290 interaction_type = interaction_type.get('@type')
1291 return str_or_none(interaction_type)
1292
e7e4a6e0
S
1293 def extract_interaction_statistic(e):
1294 interaction_statistic = e.get('interactionStatistic')
29f7c58a 1295 if isinstance(interaction_statistic, dict):
1296 interaction_statistic = [interaction_statistic]
e7e4a6e0
S
1297 if not isinstance(interaction_statistic, list):
1298 return
1299 for is_e in interaction_statistic:
1300 if not isinstance(is_e, dict):
1301 continue
1302 if is_e.get('@type') != 'InteractionCounter':
1303 continue
29f7c58a 1304 interaction_type = extract_interaction_type(is_e)
1305 if not interaction_type:
e7e4a6e0 1306 continue
ce5b9040
S
1307 # For interaction count some sites provide string instead of
1308 # an integer (as per spec) with non digit characters (e.g. ",")
1309 # so extracting count with more relaxed str_to_int
1310 interaction_count = str_to_int(is_e.get('userInteractionCount'))
e7e4a6e0
S
1311 if interaction_count is None:
1312 continue
1313 count_kind = INTERACTION_TYPE_MAP.get(interaction_type.split('/')[-1])
1314 if not count_kind:
1315 continue
1316 count_key = '%s_count' % count_kind
1317 if info.get(count_key) is not None:
1318 continue
1319 info[count_key] = interaction_count
1320
bae14048
S
1321 def extract_video_object(e):
1322 assert e['@type'] == 'VideoObject'
f7ad7160 1323 author = e.get('author')
bae14048 1324 info.update({
bebef109 1325 'url': url_or_none(e.get('contentUrl')),
bae14048
S
1326 'title': unescapeHTML(e.get('name')),
1327 'description': unescapeHTML(e.get('description')),
bebef109 1328 'thumbnail': url_or_none(e.get('thumbnailUrl') or e.get('thumbnailURL')),
bae14048
S
1329 'duration': parse_duration(e.get('duration')),
1330 'timestamp': unified_timestamp(e.get('uploadDate')),
f7ad7160 1331 # author can be an instance of 'Organization' or 'Person' types.
1332 # both types can have 'name' property(inherited from 'Thing' type). [1]
1333 # however some websites are using 'Text' type instead.
1334 # 1. https://schema.org/VideoObject
1335 'uploader': author.get('name') if isinstance(author, dict) else author if isinstance(author, compat_str) else None,
bae14048
S
1336 'filesize': float_or_none(e.get('contentSize')),
1337 'tbr': int_or_none(e.get('bitrate')),
1338 'width': int_or_none(e.get('width')),
1339 'height': int_or_none(e.get('height')),
33a81c2c 1340 'view_count': int_or_none(e.get('interactionCount')),
bae14048 1341 })
e7e4a6e0 1342 extract_interaction_statistic(e)
bae14048 1343
46933a15 1344 for e in json_ld:
4433bb02 1345 if '@context' in e:
46933a15
S
1346 item_type = e.get('@type')
1347 if expected_type is not None and expected_type != item_type:
4433bb02 1348 continue
c69701c6 1349 if item_type in ('TVEpisode', 'Episode'):
440863ad 1350 episode_name = unescapeHTML(e.get('name'))
46933a15 1351 info.update({
440863ad 1352 'episode': episode_name,
46933a15
S
1353 'episode_number': int_or_none(e.get('episodeNumber')),
1354 'description': unescapeHTML(e.get('description')),
1355 })
440863ad
S
1356 if not info.get('title') and episode_name:
1357 info['title'] = episode_name
46933a15 1358 part_of_season = e.get('partOfSeason')
c69701c6 1359 if isinstance(part_of_season, dict) and part_of_season.get('@type') in ('TVSeason', 'Season', 'CreativeWorkSeason'):
458fd30f
S
1360 info.update({
1361 'season': unescapeHTML(part_of_season.get('name')),
1362 'season_number': int_or_none(part_of_season.get('seasonNumber')),
1363 })
d16b3c66 1364 part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
c69701c6 1365 if isinstance(part_of_series, dict) and part_of_series.get('@type') in ('TVSeries', 'Series', 'CreativeWorkSeries'):
46933a15 1366 info['series'] = unescapeHTML(part_of_series.get('name'))
391256dc
S
1367 elif item_type == 'Movie':
1368 info.update({
1369 'title': unescapeHTML(e.get('name')),
1370 'description': unescapeHTML(e.get('description')),
1371 'duration': parse_duration(e.get('duration')),
1372 'timestamp': unified_timestamp(e.get('dateCreated')),
1373 })
3931b845 1374 elif item_type in ('Article', 'NewsArticle'):
46933a15
S
1375 info.update({
1376 'timestamp': parse_iso8601(e.get('datePublished')),
1377 'title': unescapeHTML(e.get('headline')),
1378 'description': unescapeHTML(e.get('articleBody')),
1379 })
1380 elif item_type == 'VideoObject':
bae14048 1381 extract_video_object(e)
4433bb02
S
1382 if expected_type is None:
1383 continue
1384 else:
1385 break
c69701c6
S
1386 video = e.get('video')
1387 if isinstance(video, dict) and video.get('@type') == 'VideoObject':
1388 extract_video_object(video)
4433bb02
S
1389 if expected_type is None:
1390 continue
1391 else:
1392 break
4ca2a3cf
S
1393 return dict((k, v) for k, v in info.items() if v is not None)
1394
27713812 1395 @staticmethod
f8da79f8 1396 def _hidden_inputs(html):
586f1cc5 1397 html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
201ea3ee 1398 hidden_inputs = {}
c8498368
S
1399 for input in re.findall(r'(?i)(<input[^>]+>)', html):
1400 attrs = extract_attributes(input)
1401 if not input:
201ea3ee 1402 continue
c8498368 1403 if attrs.get('type') not in ('hidden', 'submit'):
201ea3ee 1404 continue
c8498368
S
1405 name = attrs.get('name') or attrs.get('id')
1406 value = attrs.get('value')
1407 if name and value is not None:
1408 hidden_inputs[name] = value
201ea3ee 1409 return hidden_inputs
27713812 1410
cf61d96d
S
1411 def _form_hidden_inputs(self, form_id, html):
1412 form = self._search_regex(
73eb13df 1413 r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
cf61d96d
S
1414 html, '%s form' % form_id, group='form')
1415 return self._hidden_inputs(form)
1416
eb8a4433 1417 class FormatSort:
b050d210 1418 regex = r' *((?P<reverse>\+)?(?P<field>[a-zA-Z0-9_]+)((?P<separator>[~:])(?P<limit>.*?))?)? *$'
eb8a4433 1419
c10d0213 1420 default = ('hidden', 'hasvid', 'ie_pref', 'lang', 'quality',
155d2b48 1421 'res', 'fps', 'codec:vp9.2', 'size', 'br', 'asr',
c10d0213 1422 'proto', 'ext', 'has_audio', 'source', 'format_id') # These must not be aliases
eb8a4433 1423
1424 settings = {
1425 'vcodec': {'type': 'ordered', 'regex': True,
155d2b48 1426 'order': ['av0?1', 'vp0?9.2', 'vp0?9', '[hx]265|he?vc?', '[hx]264|avc', 'vp0?8', 'mp4v|h263', 'theora', '', None, 'none']},
eb8a4433 1427 'acodec': {'type': 'ordered', 'regex': True,
1428 'order': ['opus', 'vorbis', 'aac', 'mp?4a?', 'mp3', 'e?a?c-?3', 'dts', '', None, 'none']},
f137c99e 1429 'proto': {'type': 'ordered', 'regex': True, 'field': 'protocol',
63be1aab 1430 'order': ['(ht|f)tps', '(ht|f)tp$', 'm3u8.+', 'm3u8', '.*dash', '', 'mms|rtsp', 'none', 'f4']},
eb8a4433 1431 'vext': {'type': 'ordered', 'field': 'video_ext',
91ebc640 1432 'order': ('mp4', 'webm', 'flv', '', 'none'),
eb8a4433 1433 'order_free': ('webm', 'mp4', 'flv', '', 'none')},
1434 'aext': {'type': 'ordered', 'field': 'audio_ext',
1435 'order': ('m4a', 'aac', 'mp3', 'ogg', 'opus', 'webm', '', 'none'),
1436 'order_free': ('opus', 'ogg', 'webm', 'm4a', 'mp3', 'aac', '', 'none')},
1437 'hidden': {'visible': False, 'forced': True, 'type': 'extractor', 'max': -1000},
f983b875 1438 'ie_pref': {'priority': True, 'type': 'extractor'},
63be1aab 1439 'hasvid': {'priority': True, 'field': 'vcodec', 'type': 'boolean', 'not_in_list': ('none',)},
1440 'hasaud': {'field': 'acodec', 'type': 'boolean', 'not_in_list': ('none',)},
e4beae70 1441 'lang': {'priority': True, 'convert': 'ignore', 'field': 'language_preference'},
6a04a74e 1442 'quality': {'convert': 'float_none', 'default': -1},
eb8a4433 1443 'filesize': {'convert': 'bytes'},
f137c99e 1444 'fs_approx': {'convert': 'bytes', 'field': 'filesize_approx'},
1445 'id': {'convert': 'string', 'field': 'format_id'},
eb8a4433 1446 'height': {'convert': 'float_none'},
1447 'width': {'convert': 'float_none'},
1448 'fps': {'convert': 'float_none'},
1449 'tbr': {'convert': 'float_none'},
1450 'vbr': {'convert': 'float_none'},
1451 'abr': {'convert': 'float_none'},
1452 'asr': {'convert': 'float_none'},
e4beae70 1453 'source': {'convert': 'ignore', 'field': 'source_preference'},
63be1aab 1454
eb8a4433 1455 'codec': {'type': 'combined', 'field': ('vcodec', 'acodec')},
63be1aab 1456 'br': {'type': 'combined', 'field': ('tbr', 'vbr', 'abr'), 'same_limit': True},
1457 'size': {'type': 'combined', 'same_limit': True, 'field': ('filesize', 'fs_approx')},
1458 'ext': {'type': 'combined', 'field': ('vext', 'aext')},
1459 'res': {'type': 'multiple', 'field': ('height', 'width'), 'function': min},
1460
1461 # Most of these exist only for compatibility reasons
1462 'dimension': {'type': 'alias', 'field': 'res'},
1463 'resolution': {'type': 'alias', 'field': 'res'},
1464 'extension': {'type': 'alias', 'field': 'ext'},
1465 'bitrate': {'type': 'alias', 'field': 'br'},
eb8a4433 1466 'total_bitrate': {'type': 'alias', 'field': 'tbr'},
1467 'video_bitrate': {'type': 'alias', 'field': 'vbr'},
1468 'audio_bitrate': {'type': 'alias', 'field': 'abr'},
1469 'framerate': {'type': 'alias', 'field': 'fps'},
63be1aab 1470 'language_preference': {'type': 'alias', 'field': 'lang'}, # not named as 'language' because such a field exists
1471 'protocol': {'type': 'alias', 'field': 'proto'},
1472 'source_preference': {'type': 'alias', 'field': 'source'},
1473 'filesize_approx': {'type': 'alias', 'field': 'fs_approx'},
1474 'filesize_estimate': {'type': 'alias', 'field': 'size'},
eb8a4433 1475 'samplerate': {'type': 'alias', 'field': 'asr'},
1476 'video_ext': {'type': 'alias', 'field': 'vext'},
1477 'audio_ext': {'type': 'alias', 'field': 'aext'},
1478 'video_codec': {'type': 'alias', 'field': 'vcodec'},
1479 'audio_codec': {'type': 'alias', 'field': 'acodec'},
63be1aab 1480 'video': {'type': 'alias', 'field': 'hasvid'},
1481 'has_video': {'type': 'alias', 'field': 'hasvid'},
1482 'audio': {'type': 'alias', 'field': 'hasaud'},
1483 'has_audio': {'type': 'alias', 'field': 'hasaud'},
1484 'extractor': {'type': 'alias', 'field': 'ie_pref'},
1485 'preference': {'type': 'alias', 'field': 'ie_pref'},
1486 'extractor_preference': {'type': 'alias', 'field': 'ie_pref'},
1487 'format_id': {'type': 'alias', 'field': 'id'},
1488 }
eb8a4433 1489
1490 _order = []
1491
1492 def _get_field_setting(self, field, key):
1493 if field not in self.settings:
1494 self.settings[field] = {}
1495 propObj = self.settings[field]
1496 if key not in propObj:
1497 type = propObj.get('type')
1498 if key == 'field':
1499 default = 'preference' if type == 'extractor' else (field,) if type in ('combined', 'multiple') else field
1500 elif key == 'convert':
1501 default = 'order' if type == 'ordered' else 'float_string' if field else 'ignore'
4bcc7bd1 1502 else:
eb8a4433 1503 default = {'type': 'field', 'visible': True, 'order': [], 'not_in_list': (None,), 'function': max}.get(key, None)
1504 propObj[key] = default
1505 return propObj[key]
1506
1507 def _resolve_field_value(self, field, value, convertNone=False):
1508 if value is None:
1509 if not convertNone:
1510 return None
4bcc7bd1 1511 else:
eb8a4433 1512 value = value.lower()
1513 conversion = self._get_field_setting(field, 'convert')
1514 if conversion == 'ignore':
1515 return None
1516 if conversion == 'string':
1517 return value
1518 elif conversion == 'float_none':
1519 return float_or_none(value)
1520 elif conversion == 'bytes':
1521 return FileDownloader.parse_bytes(value)
1522 elif conversion == 'order':
da9be05e 1523 order_list = (self._use_free_order and self._get_field_setting(field, 'order_free')) or self._get_field_setting(field, 'order')
eb8a4433 1524 use_regex = self._get_field_setting(field, 'regex')
1525 list_length = len(order_list)
1526 empty_pos = order_list.index('') if '' in order_list else list_length + 1
1527 if use_regex and value is not None:
da9be05e 1528 for i, regex in enumerate(order_list):
eb8a4433 1529 if regex and re.match(regex, value):
1530 return list_length - i
1531 return list_length - empty_pos # not in list
1532 else: # not regex or value = None
1533 return list_length - (order_list.index(value) if value in order_list else empty_pos)
1534 else:
1535 if value.isnumeric():
1536 return float(value)
4bcc7bd1 1537 else:
eb8a4433 1538 self.settings[field]['convert'] = 'string'
1539 return value
1540
1541 def evaluate_params(self, params, sort_extractor):
1542 self._use_free_order = params.get('prefer_free_formats', False)
1543 self._sort_user = params.get('format_sort', [])
1544 self._sort_extractor = sort_extractor
1545
1546 def add_item(field, reverse, closest, limit_text):
1547 field = field.lower()
1548 if field in self._order:
1549 return
1550 self._order.append(field)
1551 limit = self._resolve_field_value(field, limit_text)
1552 data = {
1553 'reverse': reverse,
1554 'closest': False if limit is None else closest,
1555 'limit_text': limit_text,
1556 'limit': limit}
1557 if field in self.settings:
1558 self.settings[field].update(data)
1559 else:
1560 self.settings[field] = data
1561
1562 sort_list = (
1563 tuple(field for field in self.default if self._get_field_setting(field, 'forced'))
1564 + (tuple() if params.get('format_sort_force', False)
1565 else tuple(field for field in self.default if self._get_field_setting(field, 'priority')))
1566 + tuple(self._sort_user) + tuple(sort_extractor) + self.default)
1567
1568 for item in sort_list:
1569 match = re.match(self.regex, item)
1570 if match is None:
1571 raise ExtractorError('Invalid format sort string "%s" given by extractor' % item)
1572 field = match.group('field')
1573 if field is None:
1574 continue
1575 if self._get_field_setting(field, 'type') == 'alias':
1576 field = self._get_field_setting(field, 'field')
1577 reverse = match.group('reverse') is not None
b050d210 1578 closest = match.group('separator') == '~'
eb8a4433 1579 limit_text = match.group('limit')
1580
1581 has_limit = limit_text is not None
1582 has_multiple_fields = self._get_field_setting(field, 'type') == 'combined'
1583 has_multiple_limits = has_limit and has_multiple_fields and not self._get_field_setting(field, 'same_limit')
1584
1585 fields = self._get_field_setting(field, 'field') if has_multiple_fields else (field,)
1586 limits = limit_text.split(":") if has_multiple_limits else (limit_text,) if has_limit else tuple()
1587 limit_count = len(limits)
1588 for (i, f) in enumerate(fields):
1589 add_item(f, reverse, closest,
1590 limits[i] if i < limit_count
1591 else limits[0] if has_limit and not has_multiple_limits
1592 else None)
1593
1594 def print_verbose_info(self, to_screen):
b31fdeed 1595 if self._sort_user:
1596 to_screen('[debug] Sort order given by user: %s' % ','.join(self._sort_user))
eb8a4433 1597 if self._sort_extractor:
f983b875 1598 to_screen('[debug] Sort order given by extractor: %s' % ', '.join(self._sort_extractor))
eb8a4433 1599 to_screen('[debug] Formats sorted by: %s' % ', '.join(['%s%s%s' % (
1600 '+' if self._get_field_setting(field, 'reverse') else '', field,
1601 '%s%s(%s)' % ('~' if self._get_field_setting(field, 'closest') else ':',
1602 self._get_field_setting(field, 'limit_text'),
1603 self._get_field_setting(field, 'limit'))
1604 if self._get_field_setting(field, 'limit_text') is not None else '')
1605 for field in self._order if self._get_field_setting(field, 'visible')]))
1606
1607 def _calculate_field_preference_from_value(self, format, field, type, value):
1608 reverse = self._get_field_setting(field, 'reverse')
1609 closest = self._get_field_setting(field, 'closest')
1610 limit = self._get_field_setting(field, 'limit')
1611
1612 if type == 'extractor':
1613 maximum = self._get_field_setting(field, 'max')
1614 if value is None or (maximum is not None and value >= maximum):
f983b875 1615 value = -1
eb8a4433 1616 elif type == 'boolean':
1617 in_list = self._get_field_setting(field, 'in_list')
1618 not_in_list = self._get_field_setting(field, 'not_in_list')
1619 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
1620 elif type == 'ordered':
1621 value = self._resolve_field_value(field, value, True)
1622
1623 # try to convert to number
6a04a74e 1624 val_num = float_or_none(value, default=self._get_field_setting(field, 'default'))
eb8a4433 1625 is_num = self._get_field_setting(field, 'convert') != 'string' and val_num is not None
1626 if is_num:
1627 value = val_num
1628
1629 return ((-10, 0) if value is None
1630 else (1, value, 0) if not is_num # if a field has mixed strings and numbers, strings are sorted higher
1631 else (0, -abs(value - limit), value - limit if reverse else limit - value) if closest
1632 else (0, value, 0) if not reverse and (limit is None or value <= limit)
1633 else (0, -value, 0) if limit is None or (reverse and value == limit) or value > limit
1634 else (-1, value, 0))
1635
1636 def _calculate_field_preference(self, format, field):
1637 type = self._get_field_setting(field, 'type') # extractor, boolean, ordered, field, multiple
1638 get_value = lambda f: format.get(self._get_field_setting(f, 'field'))
1639 if type == 'multiple':
1640 type = 'field' # Only 'field' is allowed in multiple for now
1641 actual_fields = self._get_field_setting(field, 'field')
1642
1643 def wrapped_function(values):
1644 values = tuple(filter(lambda x: x is not None, values))
1645 return (self._get_field_setting(field, 'function')(*values) if len(values) > 1
1646 else values[0] if values
1647 else None)
1648
1649 value = wrapped_function((get_value(f) for f in actual_fields))
1650 else:
1651 value = get_value(field)
1652 return self._calculate_field_preference_from_value(format, field, type, value)
1653
1654 def calculate_preference(self, format):
1655 # Determine missing protocol
1656 if not format.get('protocol'):
1657 format['protocol'] = determine_protocol(format)
1658
1659 # Determine missing ext
1660 if not format.get('ext') and 'url' in format:
1661 format['ext'] = determine_ext(format['url'])
1662 if format.get('vcodec') == 'none':
1663 format['audio_ext'] = format['ext']
1664 format['video_ext'] = 'none'
1665 else:
1666 format['video_ext'] = format['ext']
1667 format['audio_ext'] = 'none'
1668 # if format.get('preference') is None and format.get('ext') in ('f4f', 'f4m'): # Not supported?
1669 # format['preference'] = -1000
1670
1671 # Determine missing bitrates
1672 if format.get('tbr') is None:
1673 if format.get('vbr') is not None and format.get('abr') is not None:
1674 format['tbr'] = format.get('vbr', 0) + format.get('abr', 0)
1675 else:
1676 if format.get('vcodec') != "none" and format.get('vbr') is None:
1677 format['vbr'] = format.get('tbr') - format.get('abr', 0)
1678 if format.get('acodec') != "none" and format.get('abr') is None:
1679 format['abr'] = format.get('tbr') - format.get('vbr', 0)
1680
1681 return tuple(self._calculate_field_preference(format, field) for field in self._order)
1682
1683 def _sort_formats(self, formats, field_preference=[]):
1684 if not formats:
b7da73eb 1685 if self._downloader.params.get('ignore_no_formats_error'):
1686 return
eb8a4433 1687 raise ExtractorError('No video formats found')
1688 format_sort = self.FormatSort() # params and to_screen are taken from the downloader
1689 format_sort.evaluate_params(self._downloader.params, field_preference)
1690 if self._downloader.params.get('verbose', False):
1691 format_sort.print_verbose_info(self._downloader.to_screen)
1692 formats.sort(key=lambda f: format_sort.calculate_preference(f))
59040888 1693
96a53167
S
1694 def _check_formats(self, formats, video_id):
1695 if formats:
1696 formats[:] = filter(
1697 lambda f: self._is_valid_url(
1698 f['url'], video_id,
1699 item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
1700 formats)
1701
f5bdb444
S
1702 @staticmethod
1703 def _remove_duplicate_formats(formats):
1704 format_urls = set()
1705 unique_formats = []
1706 for f in formats:
1707 if f['url'] not in format_urls:
1708 format_urls.add(f['url'])
1709 unique_formats.append(f)
1710 formats[:] = unique_formats
1711
45024183 1712 def _is_valid_url(self, url, video_id, item='video', headers={}):
2f0f6578
S
1713 url = self._proto_relative_url(url, scheme='http:')
1714 # For now assume non HTTP(S) URLs always valid
1715 if not (url.startswith('http://') or url.startswith('https://')):
1716 return True
96a53167 1717 try:
45024183 1718 self._request_webpage(url, video_id, 'Checking %s URL' % item, headers=headers)
96a53167 1719 return True
8bdd16b4 1720 except ExtractorError as e:
25e911a9 1721 self.to_screen(
8bdd16b4 1722 '%s: %s URL is invalid, skipping: %s'
1723 % (video_id, item, error_to_compat_str(e.cause)))
25e911a9 1724 return False
96a53167 1725
20991253 1726 def http_scheme(self):
1ede5b24 1727 """ Either "http:" or "https:", depending on the user's preferences """
20991253
PH
1728 return (
1729 'http:'
1730 if self._downloader.params.get('prefer_insecure', False)
1731 else 'https:')
1732
57c7411f
PH
1733 def _proto_relative_url(self, url, scheme=None):
1734 if url is None:
1735 return url
1736 if url.startswith('//'):
1737 if scheme is None:
1738 scheme = self.http_scheme()
1739 return scheme + url
1740 else:
1741 return url
1742
4094b6e3
PH
1743 def _sleep(self, timeout, video_id, msg_template=None):
1744 if msg_template is None:
f1a9d64e 1745 msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
4094b6e3
PH
1746 msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1747 self.to_screen(msg)
1748 time.sleep(timeout)
1749
f983b875 1750 def _extract_f4m_formats(self, manifest_url, video_id, preference=None, quality=None, f4m_id=None,
4de61310 1751 transform_source=lambda s: fix_xml_ampersands(s).strip(),
7360c06f 1752 fatal=True, m3u8_id=None, data=None, headers={}, query={}):
f036a632
JMF
1753 manifest = self._download_xml(
1754 manifest_url, video_id, 'Downloading f4m manifest',
97f4aecf
S
1755 'Unable to download f4m manifest',
1756 # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
067aa17e 1757 # (see https://github.com/ytdl-org/youtube-dl/issues/6215#issuecomment-121704244)
4de61310 1758 transform_source=transform_source,
7360c06f 1759 fatal=fatal, data=data, headers=headers, query=query)
4de61310
S
1760
1761 if manifest is False:
8d29e47f 1762 return []
31bb8d3f 1763
0fdbb332 1764 return self._parse_f4m_formats(
f983b875 1765 manifest, manifest_url, video_id, preference=preference, quality=quality, f4m_id=f4m_id,
448bb5f3 1766 transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
0fdbb332 1767
f983b875 1768 def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, quality=None, f4m_id=None,
0fdbb332 1769 transform_source=lambda s: fix_xml_ampersands(s).strip(),
448bb5f3 1770 fatal=True, m3u8_id=None):
ee0ba927 1771 if not isinstance(manifest, compat_etree_Element) and not fatal:
d9eb580a
S
1772 return []
1773
7a5c1cfe 1774 # currently yt-dlp cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
fb72ec58 1775 akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1776 if akamai_pv is not None and ';' in akamai_pv.text:
1777 playerVerificationChallenge = akamai_pv.text.split(';')[0]
1778 if playerVerificationChallenge.strip() != '':
1779 return []
1780
31bb8d3f 1781 formats = []
7a47d07c 1782 manifest_version = '1.0'
b2527359 1783 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
34e48bed 1784 if not media_nodes:
7a47d07c 1785 manifest_version = '2.0'
34e48bed 1786 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
b22ca762 1787 # Remove unsupported DRM protected media from final formats
067aa17e 1788 # rendition (see https://github.com/ytdl-org/youtube-dl/issues/8573).
b22ca762
S
1789 media_nodes = remove_encrypted_media(media_nodes)
1790 if not media_nodes:
1791 return formats
48107c19
S
1792
1793 manifest_base_url = get_base_url(manifest)
0a5685b2 1794
a6571f10 1795 bootstrap_info = xpath_element(
0a5685b2
YCH
1796 manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1797 'bootstrap info', default=None)
1798
edd6074c
RA
1799 vcodec = None
1800 mime_type = xpath_text(
1801 manifest, ['{http://ns.adobe.com/f4m/1.0}mimeType', '{http://ns.adobe.com/f4m/2.0}mimeType'],
1802 'base URL', default=None)
1803 if mime_type and mime_type.startswith('audio/'):
1804 vcodec = 'none'
1805
b2527359 1806 for i, media_el in enumerate(media_nodes):
77b8b4e6
S
1807 tbr = int_or_none(media_el.attrib.get('bitrate'))
1808 width = int_or_none(media_el.attrib.get('width'))
1809 height = int_or_none(media_el.attrib.get('height'))
1810 format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
448bb5f3
YCH
1811 # If <bootstrapInfo> is present, the specified f4m is a
1812 # stream-level manifest, and only set-level manifests may refer to
1813 # external resources. See section 11.4 and section 4 of F4M spec
1814 if bootstrap_info is None:
1815 media_url = None
1816 # @href is introduced in 2.0, see section 11.6 of F4M spec
1817 if manifest_version == '2.0':
1818 media_url = media_el.attrib.get('href')
1819 if media_url is None:
1820 media_url = media_el.attrib.get('url')
31c746e5
S
1821 if not media_url:
1822 continue
cc357c4d
S
1823 manifest_url = (
1824 media_url if media_url.startswith('http://') or media_url.startswith('https://')
48107c19 1825 else ((manifest_base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
70f0f5a8
S
1826 # If media_url is itself a f4m manifest do the recursive extraction
1827 # since bitrates in parent manifest (this one) and media_url manifest
1828 # may differ leading to inability to resolve the format by requested
1829 # bitrate in f4m downloader
240b6045
YCH
1830 ext = determine_ext(manifest_url)
1831 if ext == 'f4m':
77b8b4e6 1832 f4m_formats = self._extract_f4m_formats(
f983b875 1833 manifest_url, video_id, preference=preference, quality=quality, f4m_id=f4m_id,
77b8b4e6
S
1834 transform_source=transform_source, fatal=fatal)
1835 # Sometimes stream-level manifest contains single media entry that
1836 # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1837 # At the same time parent's media entry in set-level manifest may
1838 # contain it. We will copy it from parent in such cases.
1839 if len(f4m_formats) == 1:
1840 f = f4m_formats[0]
1841 f.update({
1842 'tbr': f.get('tbr') or tbr,
1843 'width': f.get('width') or width,
1844 'height': f.get('height') or height,
1845 'format_id': f.get('format_id') if not tbr else format_id,
edd6074c 1846 'vcodec': vcodec,
77b8b4e6
S
1847 })
1848 formats.extend(f4m_formats)
70f0f5a8 1849 continue
240b6045
YCH
1850 elif ext == 'm3u8':
1851 formats.extend(self._extract_m3u8_formats(
1852 manifest_url, video_id, 'mp4', preference=preference,
f983b875 1853 quality=quality, m3u8_id=m3u8_id, fatal=fatal))
240b6045 1854 continue
31bb8d3f 1855 formats.append({
77b8b4e6 1856 'format_id': format_id,
31bb8d3f 1857 'url': manifest_url,
30d0b549 1858 'manifest_url': manifest_url,
a6571f10 1859 'ext': 'flv' if bootstrap_info is not None else None,
187ee66c 1860 'protocol': 'f4m',
b2527359 1861 'tbr': tbr,
77b8b4e6
S
1862 'width': width,
1863 'height': height,
edd6074c 1864 'vcodec': vcodec,
60ca389c 1865 'preference': preference,
f983b875 1866 'quality': quality,
31bb8d3f 1867 })
31bb8d3f
JMF
1868 return formats
1869
f983b875 1870 def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, quality=None, m3u8_id=None):
16da9bbc 1871 return {
f207019c 1872 'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
704df56d
PH
1873 'url': m3u8_url,
1874 'ext': ext,
1875 'protocol': 'm3u8',
37768f92 1876 'preference': preference - 100 if preference else -100,
f983b875 1877 'quality': quality,
704df56d
PH
1878 'resolution': 'multiple',
1879 'format_note': 'Quality selection URL',
16da9bbc
YCH
1880 }
1881
a0c3b2d5
F
1882 def _extract_m3u8_formats(self, *args, **kwargs):
1883 fmts, subs = self._extract_m3u8_formats_and_subtitles(*args, **kwargs)
1884 if subs:
1885 self.report_warning(bug_reports_message(
1886 "Ignoring subtitle tracks found in the HLS manifest; "
1887 "if any subtitle tracks are missing,"
1888 ))
1889 return fmts
1890
1891 def _extract_m3u8_formats_and_subtitles(
1892 self, m3u8_url, video_id, ext=None, entry_protocol='m3u8',
1893 preference=None, quality=None, m3u8_id=None, note=None,
1894 errnote=None, fatal=True, live=False, data=None, headers={},
1895 query={}):
1896
dbd82a1d 1897 res = self._download_webpage_handle(
81515ad9 1898 m3u8_url, video_id,
621ed9f5 1899 note=note or 'Downloading m3u8 information',
13af92fd 1900 errnote=errnote or 'Failed to download m3u8 information',
7360c06f 1901 fatal=fatal, data=data, headers=headers, query=query)
cb252080 1902
dbd82a1d 1903 if res is False:
a0c3b2d5 1904 return [], {}
cb252080 1905
dbd82a1d 1906 m3u8_doc, urlh = res
37113045 1907 m3u8_url = urlh.geturl()
9cdffeeb 1908
a0c3b2d5 1909 return self._parse_m3u8_formats_and_subtitles(
cb252080 1910 m3u8_doc, m3u8_url, ext=ext, entry_protocol=entry_protocol,
310c2ed2 1911 preference=preference, quality=quality, m3u8_id=m3u8_id,
1912 note=note, errnote=errnote, fatal=fatal, live=live, data=data,
1913 headers=headers, query=query, video_id=video_id)
cb252080 1914
a0c3b2d5
F
1915 def _parse_m3u8_formats_and_subtitles(
1916 self, m3u8_doc, m3u8_url, ext=None, entry_protocol='m3u8',
1917 preference=None, quality=None, m3u8_id=None, live=False, note=None,
1918 errnote=None, fatal=True, data=None, headers={}, query={},
1919 video_id=None):
1920
08a00eef 1921 if '#EXT-X-FAXS-CM:' in m3u8_doc: # Adobe Flash Access
a0c3b2d5 1922 return [], {}
08a00eef 1923
73d4343e 1924 if (not self._downloader.params.get('allow_unplayable_formats')
1925 and re.search(r'#EXT-X-SESSION-KEY:.*?URI="skd://', m3u8_doc)): # Apple FairPlay
a0c3b2d5 1926 return [], {}
ea229584 1927
ff99fe52 1928 formats = []
0def7587 1929
a0c3b2d5
F
1930 subtitles = {}
1931
0def7587
RA
1932 format_url = lambda u: (
1933 u
1934 if re.match(r'^https?://', u)
1935 else compat_urlparse.urljoin(m3u8_url, u))
1936
310c2ed2 1937 split_discontinuity = self._downloader.params.get('hls_split_discontinuity', False)
1938
cb252080
S
1939 # References:
1940 # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-21
067aa17e
S
1941 # 2. https://github.com/ytdl-org/youtube-dl/issues/12211
1942 # 3. https://github.com/ytdl-org/youtube-dl/issues/18923
cb252080
S
1943
1944 # We should try extracting formats only from master playlists [1, 4.3.4],
1945 # i.e. playlists that describe available qualities. On the other hand
1946 # media playlists [1, 4.3.3] should be returned as is since they contain
1947 # just the media without qualities renditions.
9cdffeeb 1948 # Fortunately, master playlist can be easily distinguished from media
cb252080 1949 # playlist based on particular tags availability. As of [1, 4.3.3, 4.3.4]
a0566bbf 1950 # master playlist tags MUST NOT appear in a media playlist and vice versa.
cb252080
S
1951 # As of [1, 4.3.3.1] #EXT-X-TARGETDURATION tag is REQUIRED for every
1952 # media playlist and MUST NOT appear in master playlist thus we can
1953 # clearly detect media playlist with this criterion.
1954
b3b30a4b 1955 def _extract_m3u8_playlist_formats(format_url=None, m3u8_doc=None, video_id=None,
1956 fatal=True, data=None, headers={}):
310c2ed2 1957 if not m3u8_doc:
ed9b7e3d 1958 if not format_url:
1959 return []
310c2ed2 1960 res = self._download_webpage_handle(
1961 format_url, video_id,
1962 note=False,
b3b30a4b 1963 errnote='Failed to download m3u8 playlist information',
1964 fatal=fatal, data=data, headers=headers)
310c2ed2 1965
1966 if res is False:
1967 return []
1968
1969 m3u8_doc, urlh = res
1970 format_url = urlh.geturl()
1971
1972 playlist_formats = []
1973 i = (
1974 0
1975 if split_discontinuity
1976 else None)
1977 format_info = {
1978 'index': i,
1979 'key_data': None,
1980 'files': [],
1981 }
1982 for line in m3u8_doc.splitlines():
1983 if not line.startswith('#'):
1984 format_info['files'].append(line)
1985 elif split_discontinuity and line.startswith('#EXT-X-DISCONTINUITY'):
1986 i += 1
1987 playlist_formats.append(format_info)
1988 format_info = {
1989 'index': i,
1990 'url': format_url,
1991 'files': [],
1992 }
1993 playlist_formats.append(format_info)
1994 return playlist_formats
1995
9cdffeeb 1996 if '#EXT-X-TARGETDURATION' in m3u8_doc: # media playlist, return as is
310c2ed2 1997
ed9b7e3d 1998 playlist_formats = _extract_m3u8_playlist_formats(m3u8_doc=m3u8_doc)
310c2ed2 1999
2000 for format in playlist_formats:
2001 format_id = []
2002 if m3u8_id:
2003 format_id.append(m3u8_id)
2004 format_index = format.get('index')
2005 if format_index:
2006 format_id.append(str(format_index))
2007 f = {
2008 'format_id': '-'.join(format_id),
2009 'format_index': format_index,
2010 'url': m3u8_url,
2011 'ext': ext,
2012 'protocol': entry_protocol,
2013 'preference': preference,
2014 'quality': quality,
2015 }
2016 formats.append(f)
2017
a0c3b2d5 2018 return formats, subtitles
cb252080
S
2019
2020 groups = {}
2021 last_stream_inf = {}
2022
2023 def extract_media(x_media_line):
2024 media = parse_m3u8_attributes(x_media_line)
2025 # As per [1, 4.3.4.1] TYPE, GROUP-ID and NAME are REQUIRED
2026 media_type, group_id, name = media.get('TYPE'), media.get('GROUP-ID'), media.get('NAME')
2027 if not (media_type and group_id and name):
2028 return
2029 groups.setdefault(group_id, []).append(media)
a0c3b2d5
F
2030 # <https://tools.ietf.org/html/rfc8216#section-4.3.4.1>
2031 if media_type == 'SUBTITLES':
2032 lang = media['LANGUAGE'] # XXX: normalise?
2033 url = format_url(media['URI'])
2034 sub_info = {
2035 'url': url,
2036 'ext': determine_ext(url),
2037 }
4a2f19ab
F
2038 if sub_info['ext'] == 'm3u8':
2039 # Per RFC 8216 §3.1, the only possible subtitle format m3u8
2040 # files may contain is WebVTT:
2041 # <https://tools.ietf.org/html/rfc8216#section-3.1>
2042 sub_info['ext'] = 'vtt'
2043 sub_info['protocol'] = 'm3u8_native'
a0c3b2d5 2044 subtitles.setdefault(lang, []).append(sub_info)
cb252080
S
2045 if media_type not in ('VIDEO', 'AUDIO'):
2046 return
2047 media_url = media.get('URI')
2048 if media_url:
310c2ed2 2049 manifest_url = format_url(media_url)
cb252080 2050 format_id = []
b3b30a4b 2051 playlist_formats = _extract_m3u8_playlist_formats(manifest_url, video_id=video_id,
2052 fatal=fatal, data=data, headers=headers)
310c2ed2 2053
2054 for format in playlist_formats:
2055 format_index = format.get('index')
2056 for v in (m3u8_id, group_id, name):
2057 if v:
2058 format_id.append(v)
2059 if format_index:
2060 format_id.append(str(format_index))
2061 f = {
2062 'format_id': '-'.join(format_id),
2063 'format_index': format_index,
2064 'url': manifest_url,
2065 'manifest_url': m3u8_url,
2066 'language': media.get('LANGUAGE'),
2067 'ext': ext,
2068 'protocol': entry_protocol,
2069 'preference': preference,
2070 'quality': quality,
2071 }
2072 if media_type == 'AUDIO':
2073 f['vcodec'] = 'none'
2074 formats.append(f)
cb252080
S
2075
2076 def build_stream_name():
2077 # Despite specification does not mention NAME attribute for
3019cb0c
S
2078 # EXT-X-STREAM-INF tag it still sometimes may be present (see [1]
2079 # or vidio test in TestInfoExtractor.test_parse_m3u8_formats)
ddd258f9 2080 # 1. http://www.vidio.com/watch/165683-dj_ambred-booyah-live-2015
cb252080
S
2081 stream_name = last_stream_inf.get('NAME')
2082 if stream_name:
2083 return stream_name
2084 # If there is no NAME in EXT-X-STREAM-INF it will be obtained
2085 # from corresponding rendition group
2086 stream_group_id = last_stream_inf.get('VIDEO')
2087 if not stream_group_id:
2088 return
2089 stream_group = groups.get(stream_group_id)
2090 if not stream_group:
2091 return stream_group_id
2092 rendition = stream_group[0]
2093 return rendition.get('NAME') or stream_group_id
2094
379306ef 2095 # parse EXT-X-MEDIA tags before EXT-X-STREAM-INF in order to have the
2bfc1d9d
RA
2096 # chance to detect video only formats when EXT-X-STREAM-INF tags
2097 # precede EXT-X-MEDIA tags in HLS manifest such as [3].
2098 for line in m3u8_doc.splitlines():
2099 if line.startswith('#EXT-X-MEDIA:'):
2100 extract_media(line)
2101
704df56d
PH
2102 for line in m3u8_doc.splitlines():
2103 if line.startswith('#EXT-X-STREAM-INF:'):
cb252080 2104 last_stream_inf = parse_m3u8_attributes(line)
704df56d
PH
2105 elif line.startswith('#') or not line.strip():
2106 continue
2107 else:
9c99bef7 2108 tbr = float_or_none(
3089bc74
S
2109 last_stream_inf.get('AVERAGE-BANDWIDTH')
2110 or last_stream_inf.get('BANDWIDTH'), scale=1000)
30d0b549 2111 manifest_url = format_url(line.strip())
5ef62fc4 2112
b3b30a4b 2113 playlist_formats = _extract_m3u8_playlist_formats(manifest_url, video_id=video_id,
2114 fatal=fatal, data=data, headers=headers)
310c2ed2 2115
fc21af50 2116 for frmt in playlist_formats:
310c2ed2 2117 format_id = []
2118 if m3u8_id:
2119 format_id.append(m3u8_id)
fc21af50 2120 format_index = frmt.get('index')
310c2ed2 2121 stream_name = build_stream_name()
2122 # Bandwidth of live streams may differ over time thus making
2123 # format_id unpredictable. So it's better to keep provided
2124 # format_id intact.
2125 if not live:
2126 format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
2127 if format_index:
2128 format_id.append(str(format_index))
2129 f = {
2130 'format_id': '-'.join(format_id),
2131 'format_index': format_index,
2132 'url': manifest_url,
2133 'manifest_url': m3u8_url,
2134 'tbr': tbr,
2135 'ext': ext,
2136 'fps': float_or_none(last_stream_inf.get('FRAME-RATE')),
2137 'protocol': entry_protocol,
2138 'preference': preference,
2139 'quality': quality,
2140 }
2141 resolution = last_stream_inf.get('RESOLUTION')
2142 if resolution:
2143 mobj = re.search(r'(?P<width>\d+)[xX](?P<height>\d+)', resolution)
2144 if mobj:
2145 f['width'] = int(mobj.group('width'))
2146 f['height'] = int(mobj.group('height'))
2147 # Unified Streaming Platform
2148 mobj = re.search(
2149 r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
2150 if mobj:
2151 abr, vbr = mobj.groups()
2152 abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
2153 f.update({
2154 'vbr': vbr,
2155 'abr': abr,
2156 })
2157 codecs = parse_codecs(last_stream_inf.get('CODECS'))
2158 f.update(codecs)
2159 audio_group_id = last_stream_inf.get('AUDIO')
2160 # As per [1, 4.3.4.1.1] any EXT-X-STREAM-INF tag which
2161 # references a rendition group MUST have a CODECS attribute.
2162 # However, this is not always respected, for example, [2]
2163 # contains EXT-X-STREAM-INF tag which references AUDIO
2164 # rendition group but does not have CODECS and despite
2165 # referencing an audio group it represents a complete
2166 # (with audio and video) format. So, for such cases we will
2167 # ignore references to rendition groups and treat them
2168 # as complete formats.
2169 if audio_group_id and codecs and f.get('vcodec') != 'none':
2170 audio_group = groups.get(audio_group_id)
2171 if audio_group and audio_group[0].get('URI'):
2172 # TODO: update acodec for audio only formats with
2173 # the same GROUP-ID
2174 f['acodec'] = 'none'
fc21af50 2175 if not f.get('ext'):
2176 f['ext'] = 'm4a' if f.get('vcodec') == 'none' else 'mp4'
310c2ed2 2177 formats.append(f)
2178
2179 # for DailyMotion
2180 progressive_uri = last_stream_inf.get('PROGRESSIVE-URI')
2181 if progressive_uri:
2182 http_f = f.copy()
2183 del http_f['manifest_url']
2184 http_f.update({
2185 'format_id': f['format_id'].replace('hls-', 'http-'),
2186 'protocol': 'http',
2187 'url': progressive_uri,
2188 })
2189 formats.append(http_f)
5ef62fc4 2190
cb252080 2191 last_stream_inf = {}
a0c3b2d5 2192 return formats, subtitles
704df56d 2193
a107193e
S
2194 @staticmethod
2195 def _xpath_ns(path, namespace=None):
2196 if not namespace:
2197 return path
2198 out = []
2199 for c in path.split('/'):
2200 if not c or c == '.':
2201 out.append(c)
2202 else:
2203 out.append('{%s}%s' % (namespace, c))
2204 return '/'.join(out)
2205
09f572fb 2206 def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
2207 smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
a107193e 2208
995029a1
PH
2209 if smil is False:
2210 assert not fatal
2211 return []
e89a2aab 2212
17712eeb 2213 namespace = self._parse_smil_namespace(smil)
a107193e
S
2214
2215 return self._parse_smil_formats(
2216 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
2217
2218 def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
2219 smil = self._download_smil(smil_url, video_id, fatal=fatal)
2220 if smil is False:
2221 return {}
2222 return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
2223
09f572fb 2224 def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
a107193e
S
2225 return self._download_xml(
2226 smil_url, video_id, 'Downloading SMIL file',
09f572fb 2227 'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
a107193e
S
2228
2229 def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
17712eeb 2230 namespace = self._parse_smil_namespace(smil)
a107193e
S
2231
2232 formats = self._parse_smil_formats(
2233 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
2234 subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
2235
2236 video_id = os.path.splitext(url_basename(smil_url))[0]
2237 title = None
2238 description = None
647eab45 2239 upload_date = None
a107193e
S
2240 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
2241 name = meta.attrib.get('name')
2242 content = meta.attrib.get('content')
2243 if not name or not content:
2244 continue
2245 if not title and name == 'title':
2246 title = content
2247 elif not description and name in ('description', 'abstract'):
2248 description = content
647eab45
S
2249 elif not upload_date and name == 'date':
2250 upload_date = unified_strdate(content)
a107193e 2251
1e5bcdec
S
2252 thumbnails = [{
2253 'id': image.get('type'),
2254 'url': image.get('src'),
2255 'width': int_or_none(image.get('width')),
2256 'height': int_or_none(image.get('height')),
2257 } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
2258
a107193e
S
2259 return {
2260 'id': video_id,
2261 'title': title or video_id,
2262 'description': description,
647eab45 2263 'upload_date': upload_date,
1e5bcdec 2264 'thumbnails': thumbnails,
a107193e
S
2265 'formats': formats,
2266 'subtitles': subtitles,
2267 }
2268
17712eeb
S
2269 def _parse_smil_namespace(self, smil):
2270 return self._search_regex(
2271 r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
2272
f877c6ae 2273 def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
a107193e
S
2274 base = smil_url
2275 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
2276 b = meta.get('base') or meta.get('httpBase')
2277 if b:
2278 base = b
2279 break
e89a2aab
S
2280
2281 formats = []
2282 rtmp_count = 0
a107193e 2283 http_count = 0
7f32e5dc 2284 m3u8_count = 0
a107193e 2285
81e1c4e2 2286 srcs = []
ad96b4c8
YCH
2287 media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
2288 for medium in media:
2289 src = medium.get('src')
81e1c4e2 2290 if not src or src in srcs:
a107193e 2291 continue
81e1c4e2 2292 srcs.append(src)
a107193e 2293
ad96b4c8
YCH
2294 bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
2295 filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
2296 width = int_or_none(medium.get('width'))
2297 height = int_or_none(medium.get('height'))
2298 proto = medium.get('proto')
2299 ext = medium.get('ext')
a107193e 2300 src_ext = determine_ext(src)
ad96b4c8 2301 streamer = medium.get('streamer') or base
a107193e
S
2302
2303 if proto == 'rtmp' or streamer.startswith('rtmp'):
2304 rtmp_count += 1
2305 formats.append({
2306 'url': streamer,
2307 'play_path': src,
2308 'ext': 'flv',
2309 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
2310 'tbr': bitrate,
2311 'filesize': filesize,
2312 'width': width,
2313 'height': height,
2314 })
f877c6ae
YCH
2315 if transform_rtmp_url:
2316 streamer, src = transform_rtmp_url(streamer, src)
2317 formats[-1].update({
2318 'url': streamer,
2319 'play_path': src,
2320 })
a107193e
S
2321 continue
2322
2323 src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
c349456e 2324 src_url = src_url.strip()
a107193e
S
2325
2326 if proto == 'm3u8' or src_ext == 'm3u8':
7f32e5dc 2327 m3u8_formats = self._extract_m3u8_formats(
2328 src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
2329 if len(m3u8_formats) == 1:
2330 m3u8_count += 1
2331 m3u8_formats[0].update({
2332 'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
2333 'tbr': bitrate,
2334 'width': width,
2335 'height': height,
2336 })
2337 formats.extend(m3u8_formats)
bd21ead2 2338 elif src_ext == 'f4m':
a107193e
S
2339 f4m_url = src_url
2340 if not f4m_params:
2341 f4m_params = {
2342 'hdcore': '3.2.0',
2343 'plugin': 'flowplayer-3.2.0.1',
2344 }
2345 f4m_url += '&' if '?' in f4m_url else '?'
15707c7e 2346 f4m_url += compat_urllib_parse_urlencode(f4m_params)
7e5edcfd 2347 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
bd21ead2
RA
2348 elif src_ext == 'mpd':
2349 formats.extend(self._extract_mpd_formats(
2350 src_url, video_id, mpd_id='dash', fatal=False))
2351 elif re.search(r'\.ism/[Mm]anifest', src_url):
2352 formats.extend(self._extract_ism_formats(
2353 src_url, video_id, ism_id='mss', fatal=False))
2354 elif src_url.startswith('http') and self._is_valid_url(src, video_id):
a107193e
S
2355 http_count += 1
2356 formats.append({
2357 'url': src_url,
2358 'ext': ext or src_ext or 'flv',
2359 'format_id': 'http-%d' % (bitrate or http_count),
2360 'tbr': bitrate,
2361 'filesize': filesize,
2362 'width': width,
2363 'height': height,
2364 })
63757032 2365
e89a2aab
S
2366 return formats
2367
ce00af87 2368 def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
d413095f 2369 urls = []
a107193e
S
2370 subtitles = {}
2371 for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
2372 src = textstream.get('src')
d413095f 2373 if not src or src in urls:
a107193e 2374 continue
d413095f 2375 urls.append(src)
df634be2 2376 ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
03bc7237 2377 lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
a107193e
S
2378 subtitles.setdefault(lang, []).append({
2379 'url': src,
2380 'ext': ext,
2381 })
2382 return subtitles
63757032 2383
47a5cb77 2384 def _extract_xspf_playlist(self, xspf_url, playlist_id, fatal=True):
942acef5 2385 xspf = self._download_xml(
47a5cb77 2386 xspf_url, playlist_id, 'Downloading xpsf playlist',
942acef5
S
2387 'Unable to download xspf manifest', fatal=fatal)
2388 if xspf is False:
2389 return []
47a5cb77
S
2390 return self._parse_xspf(
2391 xspf, playlist_id, xspf_url=xspf_url,
2392 xspf_base_url=base_url(xspf_url))
8d6765cf 2393
47a5cb77 2394 def _parse_xspf(self, xspf_doc, playlist_id, xspf_url=None, xspf_base_url=None):
8d6765cf
S
2395 NS_MAP = {
2396 'xspf': 'http://xspf.org/ns/0/',
2397 's1': 'http://static.streamone.nl/player/ns/0',
2398 }
2399
2400 entries = []
47a5cb77 2401 for track in xspf_doc.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
8d6765cf 2402 title = xpath_text(
98044462 2403 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
8d6765cf
S
2404 description = xpath_text(
2405 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
2406 thumbnail = xpath_text(
2407 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
2408 duration = float_or_none(
2409 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
2410
47a5cb77
S
2411 formats = []
2412 for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP)):
2413 format_url = urljoin(xspf_base_url, location.text)
2414 if not format_url:
2415 continue
2416 formats.append({
2417 'url': format_url,
2418 'manifest_url': xspf_url,
2419 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
2420 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
2421 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
2422 })
8d6765cf
S
2423 self._sort_formats(formats)
2424
2425 entries.append({
2426 'id': playlist_id,
2427 'title': title,
2428 'description': description,
2429 'thumbnail': thumbnail,
2430 'duration': duration,
2431 'formats': formats,
2432 })
2433 return entries
2434
171e59ed
F
2435 def _extract_mpd_formats(self, *args, **kwargs):
2436 fmts, subs = self._extract_mpd_formats_and_subtitles(*args, **kwargs)
2437 if subs:
2438 self.report_warning(bug_reports_message(
2439 "Ignoring subtitle tracks found in the DASH manifest; "
2440 "if any subtitle tracks are missing,"
2441 ))
2442 return fmts
2443
2444 def _extract_mpd_formats_and_subtitles(
2445 self, mpd_url, video_id, mpd_id=None, note=None, errnote=None,
2446 fatal=True, data=None, headers={}, query={}):
47a5cb77 2447 res = self._download_xml_handle(
1bac3455 2448 mpd_url, video_id,
2449 note=note or 'Downloading MPD manifest',
2450 errnote=errnote or 'Failed to download MPD manifest',
7360c06f 2451 fatal=fatal, data=data, headers=headers, query=query)
1bac3455 2452 if res is False:
171e59ed 2453 return [], {}
47a5cb77 2454 mpd_doc, urlh = res
c25720ef 2455 if mpd_doc is None:
171e59ed 2456 return [], {}
02dc0a36 2457 mpd_base_url = base_url(urlh.geturl())
1bac3455 2458
171e59ed 2459 return self._parse_mpd_formats_and_subtitles(
545cc85d 2460 mpd_doc, mpd_id, mpd_base_url, mpd_url)
2d2fa82d 2461
171e59ed
F
2462 def _parse_mpd_formats(self, *args, **kwargs):
2463 fmts, subs = self._parse_mpd_formats_and_subtitles(*args, **kwargs)
2464 if subs:
2465 self.report_warning(bug_reports_message(
2466 "Ignoring subtitle tracks found in the DASH manifest; "
2467 "if any subtitle tracks are missing,"
2468 ))
2469 return fmts
2470
2471 def _parse_mpd_formats_and_subtitles(
2472 self, mpd_doc, mpd_id=None, mpd_base_url='', mpd_url=None):
f0948348
S
2473 """
2474 Parse formats from MPD manifest.
2475 References:
2476 1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
2477 http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
2478 2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
2479 """
f37468c4 2480 if not self._downloader.params.get('dynamic_mpd', True):
78895bd3 2481 if mpd_doc.get('type') == 'dynamic':
171e59ed 2482 return [], {}
2d2fa82d 2483
91cb6b50 2484 namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
f14be228 2485
2486 def _add_ns(path):
2487 return self._xpath_ns(path, namespace)
2488
675d0016 2489 def is_drm_protected(element):
2490 return element.find(_add_ns('ContentProtection')) is not None
2491
1bac3455 2492 def extract_multisegment_info(element, ms_parent_info):
2493 ms_info = ms_parent_info.copy()
b4c1d6e8
S
2494
2495 # As per [1, 5.3.9.2.2] SegmentList and SegmentTemplate share some
2496 # common attributes and elements. We will only extract relevant
2497 # for us.
2498 def extract_common(source):
2499 segment_timeline = source.find(_add_ns('SegmentTimeline'))
2500 if segment_timeline is not None:
2501 s_e = segment_timeline.findall(_add_ns('S'))
2502 if s_e:
2503 ms_info['total_number'] = 0
2504 ms_info['s'] = []
2505 for s in s_e:
2506 r = int(s.get('r', 0))
2507 ms_info['total_number'] += 1 + r
2508 ms_info['s'].append({
2509 't': int(s.get('t', 0)),
2510 # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
2511 'd': int(s.attrib['d']),
2512 'r': r,
2513 })
2514 start_number = source.get('startNumber')
2515 if start_number:
2516 ms_info['start_number'] = int(start_number)
2517 timescale = source.get('timescale')
2518 if timescale:
2519 ms_info['timescale'] = int(timescale)
2520 segment_duration = source.get('duration')
2521 if segment_duration:
48504785 2522 ms_info['segment_duration'] = float(segment_duration)
b4c1d6e8
S
2523
2524 def extract_Initialization(source):
2525 initialization = source.find(_add_ns('Initialization'))
2526 if initialization is not None:
2527 ms_info['initialization_url'] = initialization.attrib['sourceURL']
2528
f14be228 2529 segment_list = element.find(_add_ns('SegmentList'))
1bac3455 2530 if segment_list is not None:
b4c1d6e8
S
2531 extract_common(segment_list)
2532 extract_Initialization(segment_list)
f14be228 2533 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
1bac3455 2534 if segment_urls_e:
2535 ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
1bac3455 2536 else:
f14be228 2537 segment_template = element.find(_add_ns('SegmentTemplate'))
1bac3455 2538 if segment_template is not None:
b4c1d6e8 2539 extract_common(segment_template)
e228616c
S
2540 media = segment_template.get('media')
2541 if media:
2542 ms_info['media'] = media
1bac3455 2543 initialization = segment_template.get('initialization')
2544 if initialization:
e228616c 2545 ms_info['initialization'] = initialization
1bac3455 2546 else:
b4c1d6e8 2547 extract_Initialization(segment_template)
1bac3455 2548 return ms_info
b323e170 2549
06869367 2550 skip_unplayable = not self._downloader.params.get('allow_unplayable_formats')
63ad4d43 2551
1bac3455 2552 mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
17b598d3 2553 formats = []
171e59ed 2554 subtitles = {}
f14be228 2555 for period in mpd_doc.findall(_add_ns('Period')):
1bac3455 2556 period_duration = parse_duration(period.get('duration')) or mpd_duration
2557 period_ms_info = extract_multisegment_info(period, {
2558 'start_number': 1,
2559 'timescale': 1,
2560 })
f14be228 2561 for adaptation_set in period.findall(_add_ns('AdaptationSet')):
06869367 2562 if skip_unplayable and is_drm_protected(adaptation_set):
675d0016 2563 continue
1bac3455 2564 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
f14be228 2565 for representation in adaptation_set.findall(_add_ns('Representation')):
06869367 2566 if skip_unplayable and is_drm_protected(representation):
675d0016 2567 continue
1bac3455 2568 representation_attrib = adaptation_set.attrib.copy()
2569 representation_attrib.update(representation.attrib)
f0948348 2570 # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
a6c8b759 2571 mime_type = representation_attrib['mimeType']
171e59ed
F
2572 content_type = representation_attrib.get('contentType', mime_type.split('/')[0])
2573
2574 if content_type in ('video', 'audio', 'text'):
1bac3455 2575 base_url = ''
2576 for element in (representation, adaptation_set, period, mpd_doc):
f14be228 2577 base_url_e = element.find(_add_ns('BaseURL'))
1bac3455 2578 if base_url_e is not None:
2579 base_url = base_url_e.text + base_url
2580 if re.match(r'^https?://', base_url):
2581 break
bb20526b
S
2582 if mpd_base_url and not re.match(r'^https?://', base_url):
2583 if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
2584 mpd_base_url += '/'
1bac3455 2585 base_url = mpd_base_url + base_url
2586 representation_id = representation_attrib.get('id')
d577c796 2587 lang = representation_attrib.get('lang')
51e9094f 2588 url_el = representation.find(_add_ns('BaseURL'))
2589 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 2590 bandwidth = int_or_none(representation_attrib.get('bandwidth'))
171e59ed
F
2591 if content_type in ('video', 'audio'):
2592 f = {
2593 'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
2594 'manifest_url': mpd_url,
2595 'ext': mimetype2ext(mime_type),
2596 'width': int_or_none(representation_attrib.get('width')),
2597 'height': int_or_none(representation_attrib.get('height')),
2598 'tbr': float_or_none(bandwidth, 1000),
2599 'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
2600 'fps': int_or_none(representation_attrib.get('frameRate')),
2601 'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
2602 'format_note': 'DASH %s' % content_type,
2603 'filesize': filesize,
2604 'container': mimetype2ext(mime_type) + '_dash',
2605 }
2606 f.update(parse_codecs(representation_attrib.get('codecs')))
2607 elif content_type == 'text':
2608 f = {
2609 'ext': mimetype2ext(mime_type),
2610 'manifest_url': mpd_url,
2611 'filesize': filesize,
2612 }
1bac3455 2613 representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
b4c1d6e8 2614
e228616c 2615 def prepare_template(template_name, identifiers):
eca1f0d1
S
2616 tmpl = representation_ms_info[template_name]
2617 # First of, % characters outside $...$ templates
2618 # must be escaped by doubling for proper processing
2619 # by % operator string formatting used further (see
067aa17e 2620 # https://github.com/ytdl-org/youtube-dl/issues/16867).
eca1f0d1
S
2621 t = ''
2622 in_template = False
2623 for c in tmpl:
2624 t += c
2625 if c == '$':
2626 in_template = not in_template
2627 elif c == '%' and not in_template:
2628 t += c
2629 # Next, $...$ templates are translated to their
2630 # %(...) counterparts to be used with % operator
e228616c
S
2631 t = t.replace('$RepresentationID$', representation_id)
2632 t = re.sub(r'\$(%s)\$' % '|'.join(identifiers), r'%(\1)d', t)
2633 t = re.sub(r'\$(%s)%%([^$]+)\$' % '|'.join(identifiers), r'%(\1)\2', t)
2634 t.replace('$$', '$')
2635 return t
2636
2637 # @initialization is a regular template like @media one
2638 # so it should be handled just the same way (see
067aa17e 2639 # https://github.com/ytdl-org/youtube-dl/issues/11605)
e228616c
S
2640 if 'initialization' in representation_ms_info:
2641 initialization_template = prepare_template(
2642 'initialization',
2643 # As per [1, 5.3.9.4.2, Table 15, page 54] $Number$ and
2644 # $Time$ shall not be included for @initialization thus
2645 # only $Bandwidth$ remains
2646 ('Bandwidth', ))
2647 representation_ms_info['initialization_url'] = initialization_template % {
2648 'Bandwidth': bandwidth,
2649 }
2650
1141e910
S
2651 def location_key(location):
2652 return 'url' if re.match(r'^https?://', location) else 'path'
2653
e228616c
S
2654 if 'segment_urls' not in representation_ms_info and 'media' in representation_ms_info:
2655
2656 media_template = prepare_template('media', ('Number', 'Bandwidth', 'Time'))
1141e910 2657 media_location_key = location_key(media_template)
f0948348
S
2658
2659 # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
2660 # can't be used at the same time
b4c1d6e8
S
2661 if '%(Number' in media_template and 's' not in representation_ms_info:
2662 segment_duration = None
c110944f 2663 if 'total_number' not in representation_ms_info and 'segment_duration' in representation_ms_info:
b4c1d6e8
S
2664 segment_duration = float_or_none(representation_ms_info['segment_duration'], representation_ms_info['timescale'])
2665 representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
b4c1d6e8 2666 representation_ms_info['fragments'] = [{
1141e910 2667 media_location_key: media_template % {
b4c1d6e8 2668 'Number': segment_number,
e228616c 2669 'Bandwidth': bandwidth,
b4c1d6e8
S
2670 },
2671 'duration': segment_duration,
2672 } for segment_number in range(
2673 representation_ms_info['start_number'],
2674 representation_ms_info['total_number'] + representation_ms_info['start_number'])]
f0948348 2675 else:
b4c1d6e8
S
2676 # $Number*$ or $Time$ in media template with S list available
2677 # Example $Number*$: http://www.svtplay.se/klipp/9023742/stopptid-om-bjorn-borg
2678 # Example $Time$: https://play.arkena.com/embed/avp/v2/player/media/b41dda37-d8e7-4d3f-b1b5-9a9db578bdfe/1/129411
b4c1d6e8 2679 representation_ms_info['fragments'] = []
f0948348 2680 segment_time = 0
b4c1d6e8
S
2681 segment_d = None
2682 segment_number = representation_ms_info['start_number']
f0948348
S
2683
2684 def add_segment_url():
b4c1d6e8
S
2685 segment_url = media_template % {
2686 'Time': segment_time,
e228616c 2687 'Bandwidth': bandwidth,
b4c1d6e8
S
2688 'Number': segment_number,
2689 }
b4c1d6e8 2690 representation_ms_info['fragments'].append({
1141e910 2691 media_location_key: segment_url,
b4c1d6e8
S
2692 'duration': float_or_none(segment_d, representation_ms_info['timescale']),
2693 })
f0948348
S
2694
2695 for num, s in enumerate(representation_ms_info['s']):
2696 segment_time = s.get('t') or segment_time
b4c1d6e8 2697 segment_d = s['d']
f0948348 2698 add_segment_url()
b4c1d6e8 2699 segment_number += 1
f0948348 2700 for r in range(s.get('r', 0)):
b4c1d6e8 2701 segment_time += segment_d
f0948348 2702 add_segment_url()
b4c1d6e8
S
2703 segment_number += 1
2704 segment_time += segment_d
2705 elif 'segment_urls' in representation_ms_info and 's' in representation_ms_info:
2706 # No media template
2707 # Example: https://www.youtube.com/watch?v=iXZV5uAYMJI
2708 # or any YouTube dashsegments video
2709 fragments = []
d04621da
S
2710 segment_index = 0
2711 timescale = representation_ms_info['timescale']
2712 for s in representation_ms_info['s']:
2713 duration = float_or_none(s['d'], timescale)
b4c1d6e8 2714 for r in range(s.get('r', 0) + 1):
1141e910 2715 segment_uri = representation_ms_info['segment_urls'][segment_index]
b4c1d6e8 2716 fragments.append({
1141e910 2717 location_key(segment_uri): segment_uri,
d04621da 2718 'duration': duration,
b4c1d6e8 2719 })
d04621da 2720 segment_index += 1
b4c1d6e8 2721 representation_ms_info['fragments'] = fragments
41bf647e
PN
2722 elif 'segment_urls' in representation_ms_info:
2723 # Segment URLs with no SegmentTimeline
2724 # Example: https://www.seznam.cz/zpravy/clanek/cesko-zasahne-vitr-o-sile-vichrice-muze-byt-i-zivotu-nebezpecny-39091
067aa17e 2725 # https://github.com/ytdl-org/youtube-dl/pull/14844
41bf647e 2726 fragments = []
603fc4e0
S
2727 segment_duration = float_or_none(
2728 representation_ms_info['segment_duration'],
2729 representation_ms_info['timescale']) if 'segment_duration' in representation_ms_info else None
41bf647e 2730 for segment_url in representation_ms_info['segment_urls']:
603fc4e0 2731 fragment = {
41bf647e 2732 location_key(segment_url): segment_url,
603fc4e0
S
2733 }
2734 if segment_duration:
2735 fragment['duration'] = segment_duration
2736 fragments.append(fragment)
41bf647e 2737 representation_ms_info['fragments'] = fragments
79d2077e
S
2738 # If there is a fragments key available then we correctly recognized fragmented media.
2739 # Otherwise we will assume unfragmented media with direct access. Technically, such
2740 # assumption is not necessarily correct since we may simply have no support for
2741 # some forms of fragmented media renditions yet, but for now we'll use this fallback.
86f4d14f 2742 if 'fragments' in representation_ms_info:
1bac3455 2743 f.update({
79d2077e
S
2744 # NB: mpd_url may be empty when MPD manifest is parsed from a string
2745 'url': mpd_url or base_url,
1141e910 2746 'fragment_base_url': base_url,
b4c1d6e8 2747 'fragments': [],
1bac3455 2748 'protocol': 'http_dash_segments',
df374b52 2749 })
1bac3455 2750 if 'initialization_url' in representation_ms_info:
e228616c 2751 initialization_url = representation_ms_info['initialization_url']
1bac3455 2752 if not f.get('url'):
2753 f['url'] = initialization_url
1141e910 2754 f['fragments'].append({location_key(initialization_url): initialization_url})
b4c1d6e8 2755 f['fragments'].extend(representation_ms_info['fragments'])
79d2077e
S
2756 else:
2757 # Assuming direct URL to unfragmented media.
2758 f['url'] = base_url
fd76a142
F
2759 if content_type in ('video', 'audio'):
2760 formats.append(f)
2761 elif content_type == 'text':
2762 subtitles.setdefault(lang or 'und', []).append(f)
17b598d3 2763 else:
1bac3455 2764 self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
171e59ed 2765 return formats, subtitles
17b598d3 2766
fd76a142
F
2767 def _extract_ism_formats(self, *args, **kwargs):
2768 fmts, subs = self._extract_ism_formats_and_subtitles(*args, **kwargs)
2769 if subs:
2770 self.report_warning(bug_reports_message(
2771 "Ignoring subtitle tracks found in the ISM manifest; "
2772 "if any subtitle tracks are missing,"
2773 ))
2774 return fmts
2775
2776 def _extract_ism_formats_and_subtitles(self, ism_url, video_id, ism_id=None, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
47a5cb77 2777 res = self._download_xml_handle(
b2758123
RA
2778 ism_url, video_id,
2779 note=note or 'Downloading ISM manifest',
2780 errnote=errnote or 'Failed to download ISM manifest',
7360c06f 2781 fatal=fatal, data=data, headers=headers, query=query)
b2758123 2782 if res is False:
fd76a142 2783 return [], {}
47a5cb77 2784 ism_doc, urlh = res
13b08034 2785 if ism_doc is None:
fd76a142 2786 return [], {}
b2758123 2787
fd76a142 2788 return self._parse_ism_formats_and_subtitles(ism_doc, urlh.geturl(), ism_id)
b2758123 2789
fd76a142 2790 def _parse_ism_formats_and_subtitles(self, ism_doc, ism_url, ism_id=None):
76d5a363
S
2791 """
2792 Parse formats from ISM manifest.
2793 References:
2794 1. [MS-SSTR]: Smooth Streaming Protocol,
2795 https://msdn.microsoft.com/en-us/library/ff469518.aspx
2796 """
06869367 2797 if ism_doc.get('IsLive') == 'TRUE':
fd76a142 2798 return [], {}
06869367 2799 if (not self._downloader.params.get('allow_unplayable_formats')
2800 and ism_doc.find('Protection') is not None):
fd76a142 2801 return [], {}
b2758123 2802
b2758123
RA
2803 duration = int(ism_doc.attrib['Duration'])
2804 timescale = int_or_none(ism_doc.get('TimeScale')) or 10000000
2805
2806 formats = []
fd76a142 2807 subtitles = {}
b2758123
RA
2808 for stream in ism_doc.findall('StreamIndex'):
2809 stream_type = stream.get('Type')
fd76a142 2810 if stream_type not in ('video', 'audio', 'text'):
b2758123
RA
2811 continue
2812 url_pattern = stream.attrib['Url']
2813 stream_timescale = int_or_none(stream.get('TimeScale')) or timescale
2814 stream_name = stream.get('Name')
fd76a142 2815 stream_language = stream.get('Language', 'und')
b2758123 2816 for track in stream.findall('QualityLevel'):
2501d41e 2817 fourcc = track.get('FourCC', 'AACL' if track.get('AudioTag') == '255' else None)
b2758123 2818 # TODO: add support for WVC1 and WMAP
66a1b864 2819 if fourcc not in ('H264', 'AVC1', 'AACL', 'TTML'):
b2758123
RA
2820 self.report_warning('%s is not a supported codec' % fourcc)
2821 continue
2822 tbr = int(track.attrib['Bitrate']) // 1000
76d5a363
S
2823 # [1] does not mention Width and Height attributes. However,
2824 # they're often present while MaxWidth and MaxHeight are
2825 # missing, so should be used as fallbacks
2826 width = int_or_none(track.get('MaxWidth') or track.get('Width'))
2827 height = int_or_none(track.get('MaxHeight') or track.get('Height'))
b2758123
RA
2828 sampling_rate = int_or_none(track.get('SamplingRate'))
2829
2830 track_url_pattern = re.sub(r'{[Bb]itrate}', track.attrib['Bitrate'], url_pattern)
2831 track_url_pattern = compat_urlparse.urljoin(ism_url, track_url_pattern)
2832
2833 fragments = []
2834 fragment_ctx = {
2835 'time': 0,
2836 }
2837 stream_fragments = stream.findall('c')
2838 for stream_fragment_index, stream_fragment in enumerate(stream_fragments):
2839 fragment_ctx['time'] = int_or_none(stream_fragment.get('t')) or fragment_ctx['time']
2840 fragment_repeat = int_or_none(stream_fragment.get('r')) or 1
2841 fragment_ctx['duration'] = int_or_none(stream_fragment.get('d'))
2842 if not fragment_ctx['duration']:
2843 try:
2844 next_fragment_time = int(stream_fragment[stream_fragment_index + 1].attrib['t'])
2845 except IndexError:
2846 next_fragment_time = duration
1616f9b4 2847 fragment_ctx['duration'] = (next_fragment_time - fragment_ctx['time']) / fragment_repeat
b2758123
RA
2848 for _ in range(fragment_repeat):
2849 fragments.append({
1616f9b4 2850 'url': re.sub(r'{start[ _]time}', compat_str(fragment_ctx['time']), track_url_pattern),
b2758123
RA
2851 'duration': fragment_ctx['duration'] / stream_timescale,
2852 })
2853 fragment_ctx['time'] += fragment_ctx['duration']
2854
2855 format_id = []
2856 if ism_id:
2857 format_id.append(ism_id)
2858 if stream_name:
2859 format_id.append(stream_name)
2860 format_id.append(compat_str(tbr))
2861
fd76a142
F
2862 if stream_type == 'text':
2863 subtitles.setdefault(stream_language, []).append({
2864 'ext': 'ismt',
2865 'protocol': 'ism',
2866 'url': ism_url,
2867 'manifest_url': ism_url,
2868 'fragments': fragments,
2869 '_download_params': {
2870 'stream_type': stream_type,
2871 'duration': duration,
2872 'timescale': stream_timescale,
2873 'fourcc': fourcc,
2874 'language': stream_language,
2875 'codec_private_data': track.get('CodecPrivateData'),
2876 }
2877 })
2878 elif stream_type in ('video', 'audio'):
2879 formats.append({
2880 'format_id': '-'.join(format_id),
2881 'url': ism_url,
2882 'manifest_url': ism_url,
2883 'ext': 'ismv' if stream_type == 'video' else 'isma',
2884 'width': width,
2885 'height': height,
2886 'tbr': tbr,
2887 'asr': sampling_rate,
2888 'vcodec': 'none' if stream_type == 'audio' else fourcc,
2889 'acodec': 'none' if stream_type == 'video' else fourcc,
2890 'protocol': 'ism',
2891 'fragments': fragments,
2892 '_download_params': {
2893 'stream_type': stream_type,
2894 'duration': duration,
2895 'timescale': stream_timescale,
2896 'width': width or 0,
2897 'height': height or 0,
2898 'fourcc': fourcc,
2899 'language': stream_language,
2900 'codec_private_data': track.get('CodecPrivateData'),
2901 'sampling_rate': sampling_rate,
2902 'channels': int_or_none(track.get('Channels', 2)),
2903 'bits_per_sample': int_or_none(track.get('BitsPerSample', 16)),
2904 'nal_unit_length_field': int_or_none(track.get('NALUnitLengthField', 4)),
2905 },
2906 })
2907 return formats, subtitles
b2758123 2908
f983b875 2909 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
2910 def absolute_url(item_url):
2911 return urljoin(base_url, item_url)
59bbe491 2912
2913 def parse_content_type(content_type):
2914 if not content_type:
2915 return {}
2916 ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
2917 if ctr:
2918 mimetype, codecs = ctr.groups()
2919 f = parse_codecs(codecs)
2920 f['ext'] = mimetype2ext(mimetype)
2921 return f
2922 return {}
2923
868f79db 2924 def _media_formats(src, cur_media_type, type_info={}):
520251c0 2925 full_url = absolute_url(src)
82889d4a 2926 ext = type_info.get('ext') or determine_ext(full_url)
87a449c1 2927 if ext == 'm3u8':
520251c0
YCH
2928 is_plain_url = False
2929 formats = self._extract_m3u8_formats(
ad120ae1 2930 full_url, video_id, ext='mp4',
eeb0a956 2931 entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id,
f983b875 2932 preference=preference, quality=quality, fatal=False)
87a449c1
S
2933 elif ext == 'mpd':
2934 is_plain_url = False
2935 formats = self._extract_mpd_formats(
b359e977 2936 full_url, video_id, mpd_id=mpd_id, fatal=False)
520251c0
YCH
2937 else:
2938 is_plain_url = True
2939 formats = [{
2940 'url': full_url,
2941 'vcodec': 'none' if cur_media_type == 'audio' else None,
2942 }]
2943 return is_plain_url, formats
2944
59bbe491 2945 entries = []
4328ddf8
S
2946 # amp-video and amp-audio are very similar to their HTML5 counterparts
2947 # so we wll include them right here (see
2948 # https://www.ampproject.org/docs/reference/components/amp-video)
29f7c58a 2949 # For dl8-* tags see https://delight-vr.com/documentation/dl8-video/
2950 _MEDIA_TAG_NAME_RE = r'(?:(?:amp|dl8(?:-live)?)-)?(video|audio)'
2951 media_tags = [(media_tag, media_tag_name, media_type, '')
2952 for media_tag, media_tag_name, media_type
2953 in re.findall(r'(?s)(<(%s)[^>]*/>)' % _MEDIA_TAG_NAME_RE, webpage)]
2aec7256
S
2954 media_tags.extend(re.findall(
2955 # We only allow video|audio followed by a whitespace or '>'.
2956 # Allowing more characters may end up in significant slow down (see
067aa17e 2957 # https://github.com/ytdl-org/youtube-dl/issues/11979, example URL:
2aec7256 2958 # http://www.porntrex.com/maps/videositemap.xml).
29f7c58a 2959 r'(?s)(<(?P<tag>%s)(?:\s+[^>]*)?>)(.*?)</(?P=tag)>' % _MEDIA_TAG_NAME_RE, webpage))
2960 for media_tag, _, media_type, media_content in media_tags:
59bbe491 2961 media_info = {
2962 'formats': [],
2963 'subtitles': {},
2964 }
2965 media_attributes = extract_attributes(media_tag)
f856816b 2966 src = strip_or_none(media_attributes.get('src'))
59bbe491 2967 if src:
dedb1770 2968 _, formats = _media_formats(src, media_type)
520251c0 2969 media_info['formats'].extend(formats)
6780154e 2970 media_info['thumbnail'] = absolute_url(media_attributes.get('poster'))
59bbe491 2971 if media_content:
2972 for source_tag in re.findall(r'<source[^>]+>', media_content):
d493f15c
S
2973 s_attr = extract_attributes(source_tag)
2974 # data-video-src and data-src are non standard but seen
2975 # several times in the wild
f856816b 2976 src = strip_or_none(dict_get(s_attr, ('src', 'data-video-src', 'data-src')))
59bbe491 2977 if not src:
2978 continue
d493f15c 2979 f = parse_content_type(s_attr.get('type'))
868f79db 2980 is_plain_url, formats = _media_formats(src, media_type, f)
520251c0 2981 if is_plain_url:
d493f15c
S
2982 # width, height, res, label and title attributes are
2983 # all not standard but seen several times in the wild
2984 labels = [
2985 s_attr.get(lbl)
2986 for lbl in ('label', 'title')
2987 if str_or_none(s_attr.get(lbl))
2988 ]
2989 width = int_or_none(s_attr.get('width'))
3089bc74
S
2990 height = (int_or_none(s_attr.get('height'))
2991 or int_or_none(s_attr.get('res')))
d493f15c
S
2992 if not width or not height:
2993 for lbl in labels:
2994 resolution = parse_resolution(lbl)
2995 if not resolution:
2996 continue
2997 width = width or resolution.get('width')
2998 height = height or resolution.get('height')
2999 for lbl in labels:
3000 tbr = parse_bitrate(lbl)
3001 if tbr:
3002 break
3003 else:
3004 tbr = None
1ed45499 3005 f.update({
d493f15c
S
3006 'width': width,
3007 'height': height,
3008 'tbr': tbr,
3009 'format_id': s_attr.get('label') or s_attr.get('title'),
1ed45499 3010 })
520251c0
YCH
3011 f.update(formats[0])
3012 media_info['formats'].append(f)
3013 else:
3014 media_info['formats'].extend(formats)
59bbe491 3015 for track_tag in re.findall(r'<track[^>]+>', media_content):
3016 track_attributes = extract_attributes(track_tag)
3017 kind = track_attributes.get('kind')
5968d7d2 3018 if not kind or kind in ('subtitles', 'captions'):
f856816b 3019 src = strip_or_none(track_attributes.get('src'))
59bbe491 3020 if not src:
3021 continue
3022 lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
3023 media_info['subtitles'].setdefault(lang, []).append({
3024 'url': absolute_url(src),
3025 })
5e8e2fa5
S
3026 for f in media_info['formats']:
3027 f.setdefault('http_headers', {})['Referer'] = base_url
5968d7d2 3028 if media_info['formats'] or media_info['subtitles']:
59bbe491 3029 entries.append(media_info)
3030 return entries
3031
f6a1d69a
F
3032 def _extract_akamai_formats(self, *args, **kwargs):
3033 fmts, subs = self._extract_akamai_formats_and_subtitles(*args, **kwargs)
3034 if subs:
3035 self.report_warning(bug_reports_message(
3036 "Ignoring subtitle tracks found in the manifests; "
3037 "if any subtitle tracks are missing,"
3038 ))
3039 return fmts
3040
3041 def _extract_akamai_formats_and_subtitles(self, manifest_url, video_id, hosts={}):
29f7c58a 3042 signed = 'hdnea=' in manifest_url
3043 if not signed:
3044 # https://learn.akamai.com/en-us/webhelp/media-services-on-demand/stream-packaging-user-guide/GUID-BE6C0F73-1E06-483B-B0EA-57984B91B7F9.html
3045 manifest_url = re.sub(
3046 r'(?:b=[\d,-]+|(?:__a__|attributes)=off|__b__=\d+)&?',
3047 '', manifest_url).strip('?')
3048
c7c43a93 3049 formats = []
f6a1d69a 3050 subtitles = {}
70c5802b 3051
e71a4509 3052 hdcore_sign = 'hdcore=3.7.0'
ff6f9a67 3053 f4m_url = re.sub(r'(https?://[^/]+)/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
c4251b9a
RA
3054 hds_host = hosts.get('hds')
3055 if hds_host:
3056 f4m_url = re.sub(r'(https?://)[^/]+', r'\1' + hds_host, f4m_url)
e71a4509
RA
3057 if 'hdcore=' not in f4m_url:
3058 f4m_url += ('&' if '?' in f4m_url else '?') + hdcore_sign
3059 f4m_formats = self._extract_f4m_formats(
3060 f4m_url, video_id, f4m_id='hds', fatal=False)
3061 for entry in f4m_formats:
3062 entry.update({'extra_param_to_segment_url': hdcore_sign})
3063 formats.extend(f4m_formats)
70c5802b 3064
c4251b9a
RA
3065 m3u8_url = re.sub(r'(https?://[^/]+)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
3066 hls_host = hosts.get('hls')
3067 if hls_host:
3068 m3u8_url = re.sub(r'(https?://)[^/]+', r'\1' + hls_host, m3u8_url)
f6a1d69a 3069 m3u8_formats, m3u8_subtitles = self._extract_m3u8_formats_and_subtitles(
c7c43a93 3070 m3u8_url, video_id, 'mp4', 'm3u8_native',
29f7c58a 3071 m3u8_id='hls', fatal=False)
3072 formats.extend(m3u8_formats)
f6a1d69a 3073 subtitles = self._merge_subtitles(subtitles, m3u8_subtitles)
70c5802b 3074
3075 http_host = hosts.get('http')
29f7c58a 3076 if http_host and m3u8_formats and not signed:
3077 REPL_REGEX = r'https?://[^/]+/i/([^,]+),([^/]+),([^/]+)\.csmil/.+'
70c5802b 3078 qualities = re.match(REPL_REGEX, m3u8_url).group(2).split(',')
3079 qualities_length = len(qualities)
29f7c58a 3080 if len(m3u8_formats) in (qualities_length, qualities_length + 1):
70c5802b 3081 i = 0
29f7c58a 3082 for f in m3u8_formats:
3083 if f['vcodec'] != 'none':
70c5802b 3084 for protocol in ('http', 'https'):
3085 http_f = f.copy()
3086 del http_f['manifest_url']
3087 http_url = re.sub(
29f7c58a 3088 REPL_REGEX, protocol + r'://%s/\g<1>%s\3' % (http_host, qualities[i]), f['url'])
70c5802b 3089 http_f.update({
3090 'format_id': http_f['format_id'].replace('hls-', protocol + '-'),
3091 'url': http_url,
3092 'protocol': protocol,
3093 })
29f7c58a 3094 formats.append(http_f)
70c5802b 3095 i += 1
70c5802b 3096
f6a1d69a 3097 return formats, subtitles
c7c43a93 3098
6ad02195 3099 def _extract_wowza_formats(self, url, video_id, m3u8_entry_protocol='m3u8_native', skip_protocols=[]):
044eeb14 3100 query = compat_urlparse.urlparse(url).query
6ad02195 3101 url = re.sub(r'/(?:manifest|playlist|jwplayer)\.(?:m3u8|f4m|mpd|smil)', '', url)
240f2622
S
3102 mobj = re.search(
3103 r'(?:(?:http|rtmp|rtsp)(?P<s>s)?:)?(?P<url>//[^?]+)', url)
3104 url_base = mobj.group('url')
3105 http_base_url = '%s%s:%s' % ('http', mobj.group('s') or '', url_base)
6ad02195 3106 formats = []
044eeb14
S
3107
3108 def manifest_url(manifest):
3109 m_url = '%s/%s' % (http_base_url, manifest)
3110 if query:
3111 m_url += '?%s' % query
3112 return m_url
3113
6ad02195
RA
3114 if 'm3u8' not in skip_protocols:
3115 formats.extend(self._extract_m3u8_formats(
044eeb14 3116 manifest_url('playlist.m3u8'), video_id, 'mp4',
6ad02195
RA
3117 m3u8_entry_protocol, m3u8_id='hls', fatal=False))
3118 if 'f4m' not in skip_protocols:
3119 formats.extend(self._extract_f4m_formats(
044eeb14 3120 manifest_url('manifest.f4m'),
6ad02195 3121 video_id, f4m_id='hds', fatal=False))
0384932e
RA
3122 if 'dash' not in skip_protocols:
3123 formats.extend(self._extract_mpd_formats(
044eeb14 3124 manifest_url('manifest.mpd'),
0384932e 3125 video_id, mpd_id='dash', fatal=False))
6ad02195 3126 if re.search(r'(?:/smil:|\.smil)', url_base):
6ad02195
RA
3127 if 'smil' not in skip_protocols:
3128 rtmp_formats = self._extract_smil_formats(
044eeb14 3129 manifest_url('jwplayer.smil'),
6ad02195
RA
3130 video_id, fatal=False)
3131 for rtmp_format in rtmp_formats:
3132 rtsp_format = rtmp_format.copy()
3133 rtsp_format['url'] = '%s/%s' % (rtmp_format['url'], rtmp_format['play_path'])
3134 del rtsp_format['play_path']
3135 del rtsp_format['ext']
3136 rtsp_format.update({
3137 'url': rtsp_format['url'].replace('rtmp://', 'rtsp://'),
3138 'format_id': rtmp_format['format_id'].replace('rtmp', 'rtsp'),
3139 'protocol': 'rtsp',
3140 })
3141 formats.extend([rtmp_format, rtsp_format])
3142 else:
3143 for protocol in ('rtmp', 'rtsp'):
3144 if protocol not in skip_protocols:
3145 formats.append({
f2e2f0c7 3146 'url': '%s:%s' % (protocol, url_base),
6ad02195
RA
3147 'format_id': protocol,
3148 'protocol': protocol,
3149 })
3150 return formats
3151
c73e330e 3152 def _find_jwplayer_data(self, webpage, video_id=None, transform_source=js_to_json):
a4a554a7 3153 mobj = re.search(
ac9c69ac 3154 r'(?s)jwplayer\((?P<quote>[\'"])[^\'" ]+(?P=quote)\)(?!</script>).*?\.setup\s*\((?P<options>[^)]+)\)',
a4a554a7
YCH
3155 webpage)
3156 if mobj:
c73e330e
RU
3157 try:
3158 jwplayer_data = self._parse_json(mobj.group('options'),
3159 video_id=video_id,
3160 transform_source=transform_source)
3161 except ExtractorError:
3162 pass
3163 else:
3164 if isinstance(jwplayer_data, dict):
3165 return jwplayer_data
a4a554a7
YCH
3166
3167 def _extract_jwplayer_data(self, webpage, video_id, *args, **kwargs):
c73e330e
RU
3168 jwplayer_data = self._find_jwplayer_data(
3169 webpage, video_id, transform_source=js_to_json)
a4a554a7
YCH
3170 return self._parse_jwplayer_data(
3171 jwplayer_data, video_id, *args, **kwargs)
3172
3173 def _parse_jwplayer_data(self, jwplayer_data, video_id=None, require_title=True,
3174 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
3175 # JWPlayer backward compatibility: flattened playlists
3176 # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/api/config.js#L81-L96
3177 if 'playlist' not in jwplayer_data:
3178 jwplayer_data = {'playlist': [jwplayer_data]}
3179
3180 entries = []
3181
3182 # JWPlayer backward compatibility: single playlist item
3183 # https://github.com/jwplayer/jwplayer/blob/v7.7.0/src/js/playlist/playlist.js#L10
3184 if not isinstance(jwplayer_data['playlist'], list):
3185 jwplayer_data['playlist'] = [jwplayer_data['playlist']]
3186
3187 for video_data in jwplayer_data['playlist']:
3188 # JWPlayer backward compatibility: flattened sources
3189 # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/playlist/item.js#L29-L35
3190 if 'sources' not in video_data:
3191 video_data['sources'] = [video_data]
3192
3193 this_video_id = video_id or video_data['mediaid']
3194
1a2192cb
S
3195 formats = self._parse_jwplayer_formats(
3196 video_data['sources'], video_id=this_video_id, m3u8_id=m3u8_id,
3197 mpd_id=mpd_id, rtmp_params=rtmp_params, base_url=base_url)
a4a554a7
YCH
3198
3199 subtitles = {}
3200 tracks = video_data.get('tracks')
3201 if tracks and isinstance(tracks, list):
3202 for track in tracks:
96a2daa1
S
3203 if not isinstance(track, dict):
3204 continue
f4b74272
S
3205 track_kind = track.get('kind')
3206 if not track_kind or not isinstance(track_kind, compat_str):
3207 continue
3208 if track_kind.lower() not in ('captions', 'subtitles'):
a4a554a7
YCH
3209 continue
3210 track_url = urljoin(base_url, track.get('file'))
3211 if not track_url:
3212 continue
3213 subtitles.setdefault(track.get('label') or 'en', []).append({
3214 'url': self._proto_relative_url(track_url)
3215 })
3216
50d808f5 3217 entry = {
a4a554a7 3218 'id': this_video_id,
50d808f5 3219 'title': unescapeHTML(video_data['title'] if require_title else video_data.get('title')),
f81dd65b 3220 'description': clean_html(video_data.get('description')),
6945b9e7 3221 'thumbnail': urljoin(base_url, self._proto_relative_url(video_data.get('image'))),
a4a554a7
YCH
3222 'timestamp': int_or_none(video_data.get('pubdate')),
3223 'duration': float_or_none(jwplayer_data.get('duration') or video_data.get('duration')),
3224 'subtitles': subtitles,
50d808f5
RA
3225 }
3226 # https://github.com/jwplayer/jwplayer/blob/master/src/js/utils/validator.js#L32
3227 if len(formats) == 1 and re.search(r'^(?:http|//).*(?:youtube\.com|youtu\.be)/.+', formats[0]['url']):
3228 entry.update({
3229 '_type': 'url_transparent',
3230 'url': formats[0]['url'],
3231 })
3232 else:
3233 self._sort_formats(formats)
3234 entry['formats'] = formats
3235 entries.append(entry)
a4a554a7
YCH
3236 if len(entries) == 1:
3237 return entries[0]
3238 else:
3239 return self.playlist_result(entries)
3240
ed0cf9b3
S
3241 def _parse_jwplayer_formats(self, jwplayer_sources_data, video_id=None,
3242 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
bf1b87cd 3243 urls = []
ed0cf9b3 3244 formats = []
1a2192cb 3245 for source in jwplayer_sources_data:
0a268c6e
S
3246 if not isinstance(source, dict):
3247 continue
6945b9e7
RA
3248 source_url = urljoin(
3249 base_url, self._proto_relative_url(source.get('file')))
3250 if not source_url or source_url in urls:
bf1b87cd
RA
3251 continue
3252 urls.append(source_url)
ed0cf9b3
S
3253 source_type = source.get('type') or ''
3254 ext = mimetype2ext(source_type) or determine_ext(source_url)
3255 if source_type == 'hls' or ext == 'm3u8':
3256 formats.extend(self._extract_m3u8_formats(
0236cd0d
S
3257 source_url, video_id, 'mp4', entry_protocol='m3u8_native',
3258 m3u8_id=m3u8_id, fatal=False))
0d9c48de 3259 elif source_type == 'dash' or ext == 'mpd':
ed0cf9b3
S
3260 formats.extend(self._extract_mpd_formats(
3261 source_url, video_id, mpd_id=mpd_id, fatal=False))
b51dc9db
S
3262 elif ext == 'smil':
3263 formats.extend(self._extract_smil_formats(
3264 source_url, video_id, fatal=False))
ed0cf9b3 3265 # https://github.com/jwplayer/jwplayer/blob/master/src/js/providers/default.js#L67
0236cd0d
S
3266 elif source_type.startswith('audio') or ext in (
3267 'oga', 'aac', 'mp3', 'mpeg', 'vorbis'):
ed0cf9b3
S
3268 formats.append({
3269 'url': source_url,
3270 'vcodec': 'none',
3271 'ext': ext,
3272 })
3273 else:
3274 height = int_or_none(source.get('height'))
3275 if height is None:
3276 # Often no height is provided but there is a label in
0236cd0d 3277 # format like "1080p", "720p SD", or 1080.
ed0cf9b3 3278 height = int_or_none(self._search_regex(
0236cd0d 3279 r'^(\d{3,4})[pP]?(?:\b|$)', compat_str(source.get('label') or ''),
ed0cf9b3
S
3280 'height', default=None))
3281 a_format = {
3282 'url': source_url,
3283 'width': int_or_none(source.get('width')),
3284 'height': height,
0236cd0d 3285 'tbr': int_or_none(source.get('bitrate')),
ed0cf9b3
S
3286 'ext': ext,
3287 }
3288 if source_url.startswith('rtmp'):
3289 a_format['ext'] = 'flv'
ed0cf9b3
S
3290 # See com/longtailvideo/jwplayer/media/RTMPMediaProvider.as
3291 # of jwplayer.flash.swf
3292 rtmp_url_parts = re.split(
3293 r'((?:mp4|mp3|flv):)', source_url, 1)
3294 if len(rtmp_url_parts) == 3:
3295 rtmp_url, prefix, play_path = rtmp_url_parts
3296 a_format.update({
3297 'url': rtmp_url,
3298 'play_path': prefix + play_path,
3299 })
3300 if rtmp_params:
3301 a_format.update(rtmp_params)
3302 formats.append(a_format)
3303 return formats
3304
f4b1c7ad
PH
3305 def _live_title(self, name):
3306 """ Generate the title for a live video """
3307 now = datetime.datetime.now()
611c1dd9 3308 now_str = now.strftime('%Y-%m-%d %H:%M')
f4b1c7ad
PH
3309 return name + ' ' + now_str
3310
b14f3a4c
PH
3311 def _int(self, v, name, fatal=False, **kwargs):
3312 res = int_or_none(v, **kwargs)
3313 if 'get_attr' in kwargs:
3314 print(getattr(v, kwargs['get_attr']))
3315 if res is None:
3316 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
3317 if fatal:
3318 raise ExtractorError(msg)
3319 else:
6a39ee13 3320 self.report_warning(msg)
b14f3a4c
PH
3321 return res
3322
3323 def _float(self, v, name, fatal=False, **kwargs):
3324 res = float_or_none(v, **kwargs)
3325 if res is None:
3326 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
3327 if fatal:
3328 raise ExtractorError(msg)
3329 else:
6a39ee13 3330 self.report_warning(msg)
b14f3a4c
PH
3331 return res
3332
40e41780
TF
3333 def _set_cookie(self, domain, name, value, expire_time=None, port=None,
3334 path='/', secure=False, discard=False, rest={}, **kwargs):
6c22cee6 3335 cookie = compat_cookiejar_Cookie(
4ed2d7b7 3336 0, name, value, port, port is not None, domain, True,
40e41780
TF
3337 domain.startswith('.'), path, True, secure, expire_time,
3338 discard, None, None, rest)
42939b61
JMF
3339 self._downloader.cookiejar.set_cookie(cookie)
3340
799207e8 3341 def _get_cookies(self, url):
f7ad7160 3342 """ Return a compat_cookies_SimpleCookie with the cookies for the url """
5c2266df 3343 req = sanitized_Request(url)
799207e8 3344 self._downloader.cookiejar.add_cookie_header(req)
f7ad7160 3345 return compat_cookies_SimpleCookie(req.get_header('Cookie'))
799207e8 3346
e3c1266f 3347 def _apply_first_set_cookie_header(self, url_handle, cookie):
ce2fe4c0
S
3348 """
3349 Apply first Set-Cookie header instead of the last. Experimental.
3350
3351 Some sites (e.g. [1-3]) may serve two cookies under the same name
3352 in Set-Cookie header and expect the first (old) one to be set rather
3353 than second (new). However, as of RFC6265 the newer one cookie
3354 should be set into cookie store what actually happens.
3355 We will workaround this issue by resetting the cookie to
3356 the first one manually.
3357 1. https://new.vk.com/
3358 2. https://github.com/ytdl-org/youtube-dl/issues/9841#issuecomment-227871201
3359 3. https://learning.oreilly.com/
3360 """
e3c1266f
S
3361 for header, cookies in url_handle.headers.items():
3362 if header.lower() != 'set-cookie':
3363 continue
3364 if sys.version_info[0] >= 3:
3365 cookies = cookies.encode('iso-8859-1')
3366 cookies = cookies.decode('utf-8')
3367 cookie_value = re.search(
3368 r'%s=(.+?);.*?\b[Dd]omain=(.+?)(?:[,;]|$)' % cookie, cookies)
3369 if cookie_value:
3370 value, domain = cookie_value.groups()
3371 self._set_cookie(domain, cookie, value)
3372 break
3373
05900629
PH
3374 def get_testcases(self, include_onlymatching=False):
3375 t = getattr(self, '_TEST', None)
3376 if t:
3377 assert not hasattr(self, '_TESTS'), \
3378 '%s has _TEST and _TESTS' % type(self).__name__
3379 tests = [t]
3380 else:
3381 tests = getattr(self, '_TESTS', [])
3382 for t in tests:
3383 if not include_onlymatching and t.get('only_matching', False):
3384 continue
3385 t['name'] = type(self).__name__[:-len('IE')]
3386 yield t
3387
3388 def is_suitable(self, age_limit):
3389 """ Test whether the extractor is generally suitable for the given
3390 age limit (i.e. pornographic sites are not, all others usually are) """
3391
3392 any_restricted = False
3393 for tc in self.get_testcases(include_onlymatching=False):
40090e8d 3394 if tc.get('playlist', []):
05900629
PH
3395 tc = tc['playlist'][0]
3396 is_restricted = age_restricted(
3397 tc.get('info_dict', {}).get('age_limit'), age_limit)
3398 if not is_restricted:
3399 return True
3400 any_restricted = any_restricted or is_restricted
3401 return not any_restricted
3402
a504ced0 3403 def extract_subtitles(self, *args, **kwargs):
3089bc74
S
3404 if (self._downloader.params.get('writesubtitles', False)
3405 or self._downloader.params.get('listsubtitles')):
9868ea49
JMF
3406 return self._get_subtitles(*args, **kwargs)
3407 return {}
a504ced0
JMF
3408
3409 def _get_subtitles(self, *args, **kwargs):
611c1dd9 3410 raise NotImplementedError('This method must be implemented by subclasses')
a504ced0 3411
912e0b7e
YCH
3412 @staticmethod
3413 def _merge_subtitle_items(subtitle_list1, subtitle_list2):
3414 """ Merge subtitle items for one language. Items with duplicated URLs
3415 will be dropped. """
3416 list1_urls = set([item['url'] for item in subtitle_list1])
3417 ret = list(subtitle_list1)
3418 ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
3419 return ret
3420
3421 @classmethod
19bb3920
F
3422 def _merge_subtitles(cls, *dicts, **kwargs):
3423 """ Merge subtitle dictionaries, language by language. """
3424
3425 target = (lambda target=None: target)(**kwargs)
3426 # The above lambda extracts the keyword argument 'target' from kwargs
3427 # while ensuring there are no stray ones. When Python 2 support
3428 # is dropped, remove it and change the function signature to:
3429 #
3430 # def _merge_subtitles(cls, *dicts, target=None):
3431
3432 if target is None:
3433 target = {}
3434 for d in dicts:
3435 for lang, subs in d.items():
3436 target[lang] = cls._merge_subtitle_items(target.get(lang, []), subs)
3437 return target
912e0b7e 3438
360e1ca5 3439 def extract_automatic_captions(self, *args, **kwargs):
3089bc74
S
3440 if (self._downloader.params.get('writeautomaticsub', False)
3441 or self._downloader.params.get('listsubtitles')):
9868ea49
JMF
3442 return self._get_automatic_captions(*args, **kwargs)
3443 return {}
360e1ca5
JMF
3444
3445 def _get_automatic_captions(self, *args, **kwargs):
611c1dd9 3446 raise NotImplementedError('This method must be implemented by subclasses')
360e1ca5 3447
d77ab8e2 3448 def mark_watched(self, *args, **kwargs):
3089bc74
S
3449 if (self._downloader.params.get('mark_watched', False)
3450 and (self._get_login_info()[0] is not None
3451 or self._downloader.params.get('cookiefile') is not None)):
d77ab8e2
S
3452 self._mark_watched(*args, **kwargs)
3453
3454 def _mark_watched(self, *args, **kwargs):
3455 raise NotImplementedError('This method must be implemented by subclasses')
3456
38cce791
YCH
3457 def geo_verification_headers(self):
3458 headers = {}
3459 geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
3460 if geo_verification_proxy:
3461 headers['Ytdl-request-proxy'] = geo_verification_proxy
3462 return headers
3463
98763ee3
YCH
3464 def _generic_id(self, url):
3465 return compat_urllib_parse_unquote(os.path.splitext(url.rstrip('/').split('/')[-1])[0])
3466
3467 def _generic_title(self, url):
3468 return compat_urllib_parse_unquote(os.path.splitext(url_basename(url))[0])
3469
c224251a
M
3470 @staticmethod
3471 def _availability(is_private, needs_premium, needs_subscription, needs_auth, is_unlisted):
3472 all_known = all(map(
3473 lambda x: x is not None,
3474 (is_private, needs_premium, needs_subscription, needs_auth, is_unlisted)))
3475 return (
3476 'private' if is_private
3477 else 'premium_only' if needs_premium
3478 else 'subscriber_only' if needs_subscription
3479 else 'needs_auth' if needs_auth
3480 else 'unlisted' if is_unlisted
3481 else 'public' if all_known
3482 else None)
3483
8dbe9899 3484
d6983cb4
PH
3485class SearchInfoExtractor(InfoExtractor):
3486 """
3487 Base class for paged search queries extractors.
10952eb2 3488 They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
d6983cb4
PH
3489 Instances should define _SEARCH_KEY and _MAX_RESULTS.
3490 """
3491
3492 @classmethod
3493 def _make_valid_url(cls):
3494 return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
3495
3496 @classmethod
3497 def suitable(cls, url):
3498 return re.match(cls._make_valid_url(), url) is not None
3499
3500 def _real_extract(self, query):
3501 mobj = re.match(self._make_valid_url(), query)
3502 if mobj is None:
f1a9d64e 3503 raise ExtractorError('Invalid search query "%s"' % query)
d6983cb4
PH
3504
3505 prefix = mobj.group('prefix')
3506 query = mobj.group('query')
3507 if prefix == '':
3508 return self._get_n_results(query, 1)
3509 elif prefix == 'all':
3510 return self._get_n_results(query, self._MAX_RESULTS)
3511 else:
3512 n = int(prefix)
3513 if n <= 0:
f1a9d64e 3514 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
d6983cb4 3515 elif n > self._MAX_RESULTS:
6a39ee13 3516 self.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
d6983cb4
PH
3517 n = self._MAX_RESULTS
3518 return self._get_n_results(query, n)
3519
3520 def _get_n_results(self, query, n):
3521 """Get a specified number of results for a query"""
611c1dd9 3522 raise NotImplementedError('This method must be implemented by subclasses')
0f818663
PH
3523
3524 @property
3525 def SEARCH_KEY(self):
3526 return self._SEARCH_KEY