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