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