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