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