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