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