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