]> jfr.im git - yt-dlp.git/blame - youtube_dl/extractor/common.py
[pluralsight] Detect blocked account error message (#12070)
[yt-dlp.git] / youtube_dl / extractor / common.py
CommitLineData
6a3828fd 1from __future__ import unicode_literals
f1a9d64e 2
d6983cb4 3import base64
f4b1c7ad 4import datetime
3ec05685 5import hashlib
3d3538e4 6import json
4094b6e3 7import netrc
d6983cb4
PH
8import os
9import re
10import socket
11import sys
4094b6e3 12import time
1bac3455 13import math
d6983cb4 14
8c25f81b 15from ..compat import (
42939b61 16 compat_cookiejar,
799207e8 17 compat_cookies,
e9c0cdd3 18 compat_etree_fromstring,
e64b7569 19 compat_getpass,
d6983cb4 20 compat_http_client,
e9c0cdd3
YCH
21 compat_os_name,
22 compat_str,
d6983cb4 23 compat_urllib_error,
98763ee3 24 compat_urllib_parse_unquote,
15707c7e 25 compat_urllib_parse_urlencode,
41d06b04 26 compat_urllib_request,
f0b5d6af 27 compat_urlparse,
8c25f81b 28)
b22ca762 29from ..downloader.f4m import remove_encrypted_media
8c25f81b 30from ..utils import (
c342041f 31 NO_DEFAULT,
05900629 32 age_restricted,
02dc0a36 33 base_url,
08f2a92c 34 bug_reports_message,
d6983cb4
PH
35 clean_html,
36 compiled_regex_type,
70f0f5a8 37 determine_ext,
9b9c5355 38 error_to_compat_str,
d6983cb4 39 ExtractorError,
97f4aecf 40 fix_xml_ampersands,
b14f3a4c 41 float_or_none,
31bb8d3f 42 int_or_none,
4ca2a3cf 43 parse_iso8601,
55b3e45b 44 RegexNotFoundError,
d41e6efc 45 sanitize_filename,
5c2266df 46 sanitized_Request,
f38de77f 47 unescapeHTML,
647eab45 48 unified_strdate,
6b3a3098 49 unified_timestamp,
a107193e 50 url_basename,
a6571f10 51 xpath_element,
8d6765cf
S
52 xpath_text,
53 xpath_with_ns,
d497a201 54 determine_protocol,
1bac3455 55 parse_duration,
cafcf657 56 mimetype2ext,
41d06b04 57 update_Request,
cdfee168 58 update_url_query,
e154c651 59 parse_m3u8_attributes,
59bbe491 60 extract_attributes,
61 parse_codecs,
7fe15920 62 urljoin,
d6983cb4 63)
c342041f 64
d6983cb4
PH
65
66class InfoExtractor(object):
67 """Information Extractor class.
68
69 Information extractors are the classes that, given a URL, extract
70 information about the video (or videos) the URL refers to. This
71 information includes the real video URL, the video title, author and
72 others. The information is stored in a dictionary which is then
5d380852 73 passed to the YoutubeDL. The YoutubeDL processes this
d6983cb4
PH
74 information possibly downloading the video to the file system, among
75 other possible outcomes.
76
cf0649f8 77 The type field determines the type of the result.
fed5d032
PH
78 By far the most common value (and the default if _type is missing) is
79 "video", which indicates a single video.
80
81 For a video, the dictionaries must include the following fields:
d6983cb4
PH
82
83 id: Video identifier.
d6983cb4 84 title: Video title, unescaped.
d67b0b15 85
f49d89ee 86 Additionally, it must contain either a formats entry or a url one:
d67b0b15 87
f49d89ee
PH
88 formats: A list of dictionaries for each format available, ordered
89 from worst to best quality.
90
91 Potential fields:
86f4d14f
S
92 * url Mandatory. The URL of the video file
93 * manifest_url
94 The URL of the manifest file in case of
95 fragmented media (DASH, hls, hds)
10952eb2 96 * ext Will be calculated from URL if missing
d67b0b15
PH
97 * format A human-readable description of the format
98 ("mp4 container with h264/opus").
99 Calculated from the format_id, width, height.
100 and format_note fields if missing.
101 * format_id A short description of the format
5d4f3985
PH
102 ("mp4_h264_opus" or "19").
103 Technically optional, but strongly recommended.
d67b0b15
PH
104 * format_note Additional info about the format
105 ("3D" or "DASH video")
106 * width Width of the video, if known
107 * height Height of the video, if known
f49d89ee 108 * resolution Textual description of width and height
7217e148 109 * tbr Average bitrate of audio and video in KBit/s
d67b0b15
PH
110 * abr Average audio bitrate in KBit/s
111 * acodec Name of the audio codec in use
dd27fd17 112 * asr Audio sampling rate in Hertz
d67b0b15 113 * vbr Average video bitrate in KBit/s
fbb21cf5 114 * fps Frame rate
d67b0b15 115 * vcodec Name of the video codec in use
1394ce65 116 * container Name of the container format
d67b0b15 117 * filesize The number of bytes, if known in advance
9732d77e 118 * filesize_approx An estimate for the number of bytes
d67b0b15 119 * player_url SWF Player URL (used for rtmpdump).
c7deaa4c
PH
120 * protocol The protocol that will be used for the actual
121 download, lower-case.
b04b8852 122 "http", "https", "rtsp", "rtmp", "rtmpe",
af7d5a63 123 "m3u8", "m3u8_native" or "http_dash_segments".
c58c2d63
S
124 * fragment_base_url
125 Base URL for fragments. Each fragment's path
126 value (if present) will be relative to
127 this URL.
128 * fragments A list of fragments of a fragmented media.
129 Each fragment entry must contain either an url
130 or a path. If an url is present it should be
131 considered by a client. Otherwise both path and
132 fragment_base_url must be present. Here is
133 the list of all potential fields:
134 * "url" - fragment's URL
135 * "path" - fragment's path relative to
136 fragment_base_url
a0d5077c
S
137 * "duration" (optional, int or float)
138 * "filesize" (optional, int)
f49d89ee 139 * preference Order number of this format. If this field is
08d13955 140 present and not None, the formats get sorted
38d63d84 141 by this field, regardless of all other values.
f49d89ee
PH
142 -1 for default (order by other properties),
143 -2 or smaller for less than default.
e65566a9
PH
144 < -1000 to hide the format (if there is
145 another one which is strictly better)
32f90364
PH
146 * language Language code, e.g. "de" or "en-US".
147 * language_preference Is this in the language mentioned in
148 the URL?
aff2f4f4
PH
149 10 if it's what the URL is about,
150 -1 for default (don't know),
151 -10 otherwise, other values reserved for now.
5d73273f
PH
152 * quality Order number of the video quality of this
153 format, irrespective of the file format.
154 -1 for default (order by other properties),
155 -2 or smaller for less than default.
c64ed2a3
PH
156 * source_preference Order number for this video source
157 (quality takes higher priority)
158 -1 for default (order by other properties),
159 -2 or smaller for less than default.
d769be6c
PH
160 * http_headers A dictionary of additional HTTP headers
161 to add to the request.
6271f1ca 162 * stretched_ratio If given and not 1, indicates that the
3dee7826
PH
163 video's pixels are not square.
164 width : height ratio as float.
165 * no_resume The server does not support resuming the
166 (HTTP or RTMP) download. Boolean.
167
c0ba0f48 168 url: Final video URL.
d6983cb4 169 ext: Video filename extension.
d67b0b15
PH
170 format: The video format, defaults to ext (used for --get-format)
171 player_url: SWF Player URL (used for rtmpdump).
2f5865cc 172
d6983cb4
PH
173 The following fields are optional:
174
f5e43bc6 175 alt_title: A secondary title of the video.
0afef30b
PH
176 display_id An alternative identifier for the video, not necessarily
177 unique, but available before title. Typically, id is
178 something like "4234987", title "Dancing naked mole rats",
179 and display_id "dancing-naked-mole-rats"
d5519808 180 thumbnails: A list of dictionaries, with the following entries:
cfb56d1a 181 * "id" (optional, string) - Thumbnail format ID
d5519808 182 * "url"
cfb56d1a 183 * "preference" (optional, int) - quality of the image
d5519808
PH
184 * "width" (optional, int)
185 * "height" (optional, int)
186 * "resolution" (optional, string "{width}x{height"},
187 deprecated)
2de624fd 188 * "filesize" (optional, int)
d6983cb4 189 thumbnail: Full URL to a video thumbnail image.
f5e43bc6 190 description: Full video description.
d6983cb4 191 uploader: Full name of the video uploader.
2bc0c46f 192 license: License name the video is licensed under.
8a92e51c 193 creator: The creator of the video.
8aab976b 194 release_date: The date (YYYYMMDD) when the video was released.
955c4514 195 timestamp: UNIX timestamp of the moment the video became available.
d6983cb4 196 upload_date: Video upload date (YYYYMMDD).
955c4514 197 If not explicitly set, calculated from timestamp.
d6983cb4 198 uploader_id: Nickname or id of the video uploader.
7bcd2830 199 uploader_url: Full URL to a personal webpage of the video uploader.
da9ec3b9 200 location: Physical location where the video was filmed.
a504ced0 201 subtitles: The available subtitles as a dictionary in the format
4606c34e
YCH
202 {tag: subformats}. "tag" is usually a language code, and
203 "subformats" is a list sorted from lower to higher
204 preference, each element is a dictionary with the "ext"
205 entry and one of:
a504ced0 206 * "data": The subtitles file contents
10952eb2 207 * "url": A URL pointing to the subtitles file
4bba3716 208 "ext" will be calculated from URL if missing
360e1ca5
JMF
209 automatic_captions: Like 'subtitles', used by the YoutubeIE for
210 automatically generated captions
62d231c0 211 duration: Length of the video in seconds, as an integer or float.
f3d29461 212 view_count: How many users have watched the video on the platform.
19e3dfc9
PH
213 like_count: Number of positive ratings of the video
214 dislike_count: Number of negative ratings of the video
02835c6b 215 repost_count: Number of reposts of the video
2d30521a 216 average_rating: Average rating give by users, the scale used depends on the webpage
19e3dfc9 217 comment_count: Number of comments on the video
dd622d7c
PH
218 comments: A list of comments, each with one or more of the following
219 properties (all but one of text or html optional):
220 * "author" - human-readable name of the comment author
221 * "author_id" - user ID of the comment author
222 * "id" - Comment ID
223 * "html" - Comment as HTML
224 * "text" - Plain text of the comment
225 * "timestamp" - UNIX timestamp of comment
226 * "parent" - ID of the comment this one is replying to.
227 Set to "root" to indicate that this is a
228 comment to the original video.
8dbe9899 229 age_limit: Age restriction for the video, as an integer (years)
10952eb2 230 webpage_url: The URL to the video webpage, if given to youtube-dl it
9103bbc5
JMF
231 should allow to get the same result again. (It will be set
232 by YoutubeDL if it's missing)
ad3bc6ac
PH
233 categories: A list of categories that the video falls in, for example
234 ["Sports", "Berlin"]
864f24bd 235 tags: A list of tags assigned to the video, e.g. ["sweden", "pop music"]
7267bd53
PH
236 is_live: True, False, or None (=unknown). Whether this video is a
237 live stream that goes on instead of a fixed-length video.
7c80519c 238 start_time: Time in seconds where the reproduction should start, as
10952eb2 239 specified in the URL.
297a564b 240 end_time: Time in seconds where the reproduction should end, as
10952eb2 241 specified in the URL.
d6983cb4 242
7109903e
S
243 The following fields should only be used when the video belongs to some logical
244 chapter or section:
245
246 chapter: Name or title of the chapter the video belongs to.
27bfd4e5
S
247 chapter_number: Number of the chapter the video belongs to, as an integer.
248 chapter_id: Id of the chapter the video belongs to, as a unicode string.
7109903e
S
249
250 The following fields should only be used when the video is an episode of some
8d76bdf1 251 series, programme or podcast:
7109903e
S
252
253 series: Title of the series or programme the video episode belongs to.
254 season: Title of the season the video episode belongs to.
27bfd4e5
S
255 season_number: Number of the season the video episode belongs to, as an integer.
256 season_id: Id of the season the video episode belongs to, as a unicode string.
7109903e
S
257 episode: Title of the video episode. Unlike mandatory video title field,
258 this field should denote the exact title of the video episode
259 without any kind of decoration.
27bfd4e5
S
260 episode_number: Number of the video episode within a season, as an integer.
261 episode_id: Id of the video episode, as a unicode string.
7109903e 262
7a93ab5f
S
263 The following fields should only be used when the media is a track or a part of
264 a music album:
265
266 track: Title of the track.
267 track_number: Number of the track within an album or a disc, as an integer.
268 track_id: Id of the track (useful in case of custom indexing, e.g. 6.iii),
269 as a unicode string.
270 artist: Artist(s) of the track.
271 genre: Genre(s) of the track.
272 album: Title of the album the track belongs to.
273 album_type: Type of the album (e.g. "Demo", "Full-length", "Split", "Compilation", etc).
274 album_artist: List of all artists appeared on the album (e.g.
275 "Ash Borer / Fell Voices" or "Various Artists", useful for splits
276 and compilations).
277 disc_number: Number of the disc or other physical medium the track belongs to,
278 as an integer.
279 release_year: Year (YYYY) when the album was released.
280
deefc05b 281 Unless mentioned otherwise, the fields should be Unicode strings.
d6983cb4 282
d838b1bd
PH
283 Unless mentioned otherwise, None is equivalent to absence of information.
284
fed5d032
PH
285
286 _type "playlist" indicates multiple videos.
b82f815f
PH
287 There must be a key "entries", which is a list, an iterable, or a PagedList
288 object, each element of which is a valid dictionary by this specification.
fed5d032 289
e0b9d78f
S
290 Additionally, playlists can have "title", "description" and "id" attributes
291 with the same semantics as videos (see above).
fed5d032
PH
292
293
294 _type "multi_video" indicates that there are multiple videos that
295 form a single show, for examples multiple acts of an opera or TV episode.
296 It must have an entries key like a playlist and contain all the keys
297 required for a video at the same time.
298
299
300 _type "url" indicates that the video must be extracted from another
301 location, possibly by a different extractor. Its only required key is:
302 "url" - the next URL to extract.
f58766ce
PH
303 The key "ie_key" can be set to the class name (minus the trailing "IE",
304 e.g. "Youtube") if the extractor class is known in advance.
305 Additionally, the dictionary may have any properties of the resolved entity
306 known in advance, for example "title" if the title of the referred video is
fed5d032
PH
307 known ahead of time.
308
309
310 _type "url_transparent" entities have the same specification as "url", but
311 indicate that the given additional information is more precise than the one
312 associated with the resolved URL.
313 This is useful when a site employs a video service that hosts the video and
314 its technical metadata, but that video service does not embed a useful
315 title, description etc.
316
317
d6983cb4
PH
318 Subclasses of this one should re-define the _real_initialize() and
319 _real_extract() methods and define a _VALID_URL regexp.
320 Probably, they should also be added to the list of extractors.
321
d6983cb4
PH
322 Finally, the _WORKING attribute should be set to False for broken IEs
323 in order to warn the users and skip the tests.
324 """
325
326 _ready = False
327 _downloader = None
328 _WORKING = True
329
330 def __init__(self, downloader=None):
331 """Constructor. Receives an optional downloader."""
332 self._ready = False
333 self.set_downloader(downloader)
334
335 @classmethod
336 def suitable(cls, url):
337 """Receives a URL and returns True if suitable for this IE."""
79cb2577
PH
338
339 # This does not use has/getattr intentionally - we want to know whether
340 # we have cached the regexp for *this* class, whereas getattr would also
341 # match the superclass
342 if '_VALID_URL_RE' not in cls.__dict__:
343 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
344 return cls._VALID_URL_RE.match(url) is not None
d6983cb4 345
ed9266db
PH
346 @classmethod
347 def _match_id(cls, url):
348 if '_VALID_URL_RE' not in cls.__dict__:
349 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
350 m = cls._VALID_URL_RE.match(url)
351 assert m
352 return m.group('id')
353
d6983cb4
PH
354 @classmethod
355 def working(cls):
356 """Getter method for _WORKING."""
357 return cls._WORKING
358
359 def initialize(self):
360 """Initializes an instance (authentication, etc)."""
361 if not self._ready:
362 self._real_initialize()
363 self._ready = True
364
365 def extract(self, url):
366 """Extracts URL information and returns it in list of dicts."""
3a5bcd03
PH
367 try:
368 self.initialize()
369 return self._real_extract(url)
370 except ExtractorError:
371 raise
372 except compat_http_client.IncompleteRead as e:
dfb1b146 373 raise ExtractorError('A network error has occurred.', cause=e, expected=True)
9650885b 374 except (KeyError, StopIteration) as e:
dfb1b146 375 raise ExtractorError('An extractor error has occurred.', cause=e)
d6983cb4
PH
376
377 def set_downloader(self, downloader):
378 """Sets the downloader for this IE."""
379 self._downloader = downloader
380
381 def _real_initialize(self):
382 """Real initialization process. Redefine in subclasses."""
383 pass
384
385 def _real_extract(self, url):
386 """Real extraction process. Redefine in subclasses."""
387 pass
388
56c73665
JMF
389 @classmethod
390 def ie_key(cls):
391 """A string for getting the InfoExtractor with get_info_extractor"""
dc519b54 392 return compat_str(cls.__name__[:-2])
56c73665 393
d6983cb4
PH
394 @property
395 def IE_NAME(self):
dc519b54 396 return compat_str(type(self).__name__[:-2])
d6983cb4 397
41d06b04 398 def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
d6983cb4
PH
399 """ Returns the response handle """
400 if note is None:
401 self.report_download_webpage(video_id)
402 elif note is not False:
7cc3570e 403 if video_id is None:
f1a9d64e 404 self.to_screen('%s' % (note,))
7cc3570e 405 else:
f1a9d64e 406 self.to_screen('%s: %s' % (video_id, note))
41d06b04
S
407 if isinstance(url_or_request, compat_urllib_request.Request):
408 url_or_request = update_Request(
409 url_or_request, data=data, headers=headers, query=query)
410 else:
cdfee168 411 if query:
412 url_or_request = update_url_query(url_or_request, query)
2c0d9c62 413 if data is not None or headers:
41d06b04 414 url_or_request = sanitized_Request(url_or_request, data, headers)
d6983cb4 415 try:
dca08720 416 return self._downloader.urlopen(url_or_request)
d6983cb4 417 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
aa94a6d3
PH
418 if errnote is False:
419 return False
d6983cb4 420 if errnote is None:
f1a9d64e 421 errnote = 'Unable to download webpage'
7f8b2714 422
9b9c5355 423 errmsg = '%s: %s' % (errnote, error_to_compat_str(err))
7cc3570e
PH
424 if fatal:
425 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
426 else:
427 self._downloader.report_warning(errmsg)
428 return False
d6983cb4 429
41d06b04 430 def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True, encoding=None, data=None, headers={}, query={}):
d6983cb4 431 """ Returns a tuple (page content as string, URL handle) """
b9d3e163
PH
432 # Strip hashes from the URL (#1038)
433 if isinstance(url_or_request, (compat_str, str)):
434 url_or_request = url_or_request.partition('#')[0]
435
cdfee168 436 urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal, data=data, headers=headers, query=query)
7cc3570e
PH
437 if urlh is False:
438 assert not fatal
439 return False
c9a77969 440 content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding)
23be51d8
PH
441 return (content, urlh)
442
c9a77969
YCH
443 @staticmethod
444 def _guess_encoding_from_content(content_type, webpage_bytes):
d6983cb4
PH
445 m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
446 if m:
447 encoding = m.group(1)
448 else:
0d75ae2c 449 m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
f143d86a
PH
450 webpage_bytes[:1024])
451 if m:
452 encoding = m.group(1).decode('ascii')
b60016e8
PH
453 elif webpage_bytes.startswith(b'\xff\xfe'):
454 encoding = 'utf-16'
f143d86a
PH
455 else:
456 encoding = 'utf-8'
c9a77969
YCH
457
458 return encoding
459
460 def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None):
461 content_type = urlh.headers.get('Content-Type', '')
462 webpage_bytes = urlh.read()
463 if prefix is not None:
464 webpage_bytes = prefix + webpage_bytes
465 if not encoding:
466 encoding = self._guess_encoding_from_content(content_type, webpage_bytes)
d6983cb4
PH
467 if self._downloader.params.get('dump_intermediate_pages', False):
468 try:
469 url = url_or_request.get_full_url()
470 except AttributeError:
471 url = url_or_request
f1a9d64e 472 self.to_screen('Dumping request to ' + url)
d6983cb4
PH
473 dump = base64.b64encode(webpage_bytes).decode('ascii')
474 self._downloader.to_screen(dump)
d41e6efc
PH
475 if self._downloader.params.get('write_pages', False):
476 try:
477 url = url_or_request.get_full_url()
478 except AttributeError:
479 url = url_or_request
5afa7f8b 480 basen = '%s_%s' % (video_id, url)
c1bce22f 481 if len(basen) > 240:
f1a9d64e 482 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
c1bce22f
PH
483 basen = basen[:240 - len(h)] + h
484 raw_filename = basen + '.dump'
d41e6efc 485 filename = sanitize_filename(raw_filename, restricted=True)
f1a9d64e 486 self.to_screen('Saving request to ' + filename)
5f58165d
S
487 # Working around MAX_PATH limitation on Windows (see
488 # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
e9c0cdd3 489 if compat_os_name == 'nt':
5f58165d
S
490 absfilepath = os.path.abspath(filename)
491 if len(absfilepath) > 259:
492 filename = '\\\\?\\' + absfilepath
d41e6efc
PH
493 with open(filename, 'wb') as outf:
494 outf.write(webpage_bytes)
495
ec0fafbb
AA
496 try:
497 content = webpage_bytes.decode(encoding, 'replace')
498 except LookupError:
499 content = webpage_bytes.decode('utf-8', 'replace')
2410c43d 500
f1a9d64e
PH
501 if ('<title>Access to this site is blocked</title>' in content and
502 'Websense' in content[:512]):
503 msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
2410c43d
PH
504 blocked_iframe = self._html_search_regex(
505 r'<iframe src="([^"]+)"', content,
f1a9d64e 506 'Websense information URL', default=None)
2410c43d 507 if blocked_iframe:
f1a9d64e 508 msg += ' Visit %s for more details' % blocked_iframe
2410c43d 509 raise ExtractorError(msg, expected=True)
77b2986b
PH
510 if '<title>The URL you requested has been blocked</title>' in content[:512]:
511 msg = (
512 'Access to this webpage has been blocked by Indian censorship. '
513 'Use a VPN or proxy server (with --proxy) to route around it.')
514 block_msg = self._html_search_regex(
515 r'</h1><p>(.*?)</p>',
516 content, 'block message', default=None)
517 if block_msg:
518 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
519 raise ExtractorError(msg, expected=True)
2410c43d 520
23be51d8 521 return content
d6983cb4 522
41d06b04 523 def _download_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, tries=1, timeout=5, encoding=None, data=None, headers={}, query={}):
d6983cb4 524 """ Returns the data of the page as a string """
995ad69c
TF
525 success = False
526 try_count = 0
527 while success is False:
528 try:
cdfee168 529 res = self._download_webpage_handle(url_or_request, video_id, note, errnote, fatal, encoding=encoding, data=data, headers=headers, query=query)
995ad69c
TF
530 success = True
531 except compat_http_client.IncompleteRead as e:
532 try_count += 1
533 if try_count >= tries:
534 raise e
535 self._sleep(timeout, video_id)
7cc3570e
PH
536 if res is False:
537 return res
538 else:
539 content, _ = res
540 return content
d6983cb4 541
2a275ab0 542 def _download_xml(self, url_or_request, video_id,
f1a9d64e 543 note='Downloading XML', errnote='Unable to download XML',
41d06b04 544 transform_source=None, fatal=True, encoding=None, data=None, headers={}, query={}):
267ed0c5 545 """Return the xml as an xml.etree.ElementTree.Element"""
28746fbd 546 xml_string = self._download_webpage(
cdfee168 547 url_or_request, video_id, note, errnote, fatal=fatal, encoding=encoding, data=data, headers=headers, query=query)
28746fbd
PH
548 if xml_string is False:
549 return xml_string
e2b38da9
PH
550 if transform_source:
551 xml_string = transform_source(xml_string)
36e6f62c 552 return compat_etree_fromstring(xml_string.encode('utf-8'))
267ed0c5 553
3d3538e4 554 def _download_json(self, url_or_request, video_id,
f1a9d64e
PH
555 note='Downloading JSON metadata',
556 errnote='Unable to download JSON metadata',
b090af59 557 transform_source=None,
41d06b04 558 fatal=True, encoding=None, data=None, headers={}, query={}):
b090af59 559 json_string = self._download_webpage(
c9a77969 560 url_or_request, video_id, note, errnote, fatal=fatal,
cdfee168 561 encoding=encoding, data=data, headers=headers, query=query)
b090af59
PH
562 if (not fatal) and json_string is False:
563 return None
ebb64199
TF
564 return self._parse_json(
565 json_string, video_id, transform_source=transform_source, fatal=fatal)
566
567 def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
81c2f20b
PH
568 if transform_source:
569 json_string = transform_source(json_string)
3d3538e4
PH
570 try:
571 return json.loads(json_string)
572 except ValueError as ve:
e7b6d122
PH
573 errmsg = '%s: Failed to parse JSON ' % video_id
574 if fatal:
575 raise ExtractorError(errmsg, cause=ve)
576 else:
577 self.report_warning(errmsg + str(ve))
3d3538e4 578
f45f96f8 579 def report_warning(self, msg, video_id=None):
f1a9d64e 580 idstr = '' if video_id is None else '%s: ' % video_id
f45f96f8 581 self._downloader.report_warning(
f1a9d64e 582 '[%s] %s%s' % (self.IE_NAME, idstr, msg))
f45f96f8 583
d6983cb4
PH
584 def to_screen(self, msg):
585 """Print msg to screen, prefixing it with '[ie_name]'"""
f1a9d64e 586 self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
d6983cb4
PH
587
588 def report_extraction(self, id_or_name):
589 """Report information extraction."""
f1a9d64e 590 self.to_screen('%s: Extracting information' % id_or_name)
d6983cb4
PH
591
592 def report_download_webpage(self, video_id):
593 """Report webpage download."""
f1a9d64e 594 self.to_screen('%s: Downloading webpage' % video_id)
d6983cb4
PH
595
596 def report_age_confirmation(self):
597 """Report attempt to confirm age."""
f1a9d64e 598 self.to_screen('Confirming age')
d6983cb4 599
fc79158d
JMF
600 def report_login(self):
601 """Report attempt to log in."""
f1a9d64e 602 self.to_screen('Logging in')
fc79158d 603
43e7d3c9
S
604 @staticmethod
605 def raise_login_required(msg='This video is only available for registered users'):
606 raise ExtractorError(
607 '%s. Use --username and --password or --netrc to provide account credentials.' % msg,
608 expected=True)
609
c430802e
S
610 @staticmethod
611 def raise_geo_restricted(msg='This video is not available from your location due to geo restriction'):
612 raise ExtractorError(
613 '%s. You might want to use --proxy to workaround.' % msg,
614 expected=True)
615
5f6a1245 616 # Methods for following #608
c0d0b01f 617 @staticmethod
830d53bf 618 def url_result(url, ie=None, video_id=None, video_title=None):
10952eb2 619 """Returns a URL that points to a page that should be processed"""
5f6a1245 620 # TODO: ie should be the class used for getting the info
d6983cb4
PH
621 video_info = {'_type': 'url',
622 'url': url,
623 'ie_key': ie}
7012b23c
PH
624 if video_id is not None:
625 video_info['id'] = video_id
830d53bf
S
626 if video_title is not None:
627 video_info['title'] = video_title
d6983cb4 628 return video_info
5f6a1245 629
c0d0b01f 630 @staticmethod
acf5cbfe 631 def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None):
d6983cb4
PH
632 """Returns a playlist"""
633 video_info = {'_type': 'playlist',
634 'entries': entries}
635 if playlist_id:
636 video_info['id'] = playlist_id
637 if playlist_title:
638 video_info['title'] = playlist_title
acf5cbfe
S
639 if playlist_description:
640 video_info['description'] = playlist_description
d6983cb4
PH
641 return video_info
642
c342041f 643 def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
644 """
645 Perform a regex search on the given string, using a single or a list of
646 patterns returning the first matching group.
647 In case of failure return a default value or raise a WARNING or a
55b3e45b 648 RegexNotFoundError, depending on fatal, specifying the field name.
d6983cb4
PH
649 """
650 if isinstance(pattern, (str, compat_str, compiled_regex_type)):
651 mobj = re.search(pattern, string, flags)
652 else:
653 for p in pattern:
654 mobj = re.search(p, string, flags)
c3415d1b
PH
655 if mobj:
656 break
d6983cb4 657
e9c0cdd3 658 if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
f1a9d64e 659 _name = '\033[0;34m%s\033[0m' % name
d6983cb4
PH
660 else:
661 _name = name
662
663 if mobj:
711ede6e
PH
664 if group is None:
665 # return the first matching group
666 return next(g for g in mobj.groups() if g is not None)
667 else:
668 return mobj.group(group)
c342041f 669 elif default is not NO_DEFAULT:
d6983cb4
PH
670 return default
671 elif fatal:
f1a9d64e 672 raise RegexNotFoundError('Unable to extract %s' % _name)
d6983cb4 673 else:
08f2a92c 674 self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message())
d6983cb4
PH
675 return None
676
c342041f 677 def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
678 """
679 Like _search_regex, but strips HTML tags and unescapes entities.
680 """
711ede6e 681 res = self._search_regex(pattern, string, name, default, fatal, flags, group)
d6983cb4
PH
682 if res:
683 return clean_html(res).strip()
684 else:
685 return res
686
2118fdd1
RA
687 def _get_netrc_login_info(self, netrc_machine=None):
688 username = None
689 password = None
690 netrc_machine = netrc_machine or self._NETRC_MACHINE
691
692 if self._downloader.params.get('usenetrc', False):
693 try:
694 info = netrc.netrc().authenticators(netrc_machine)
695 if info is not None:
696 username = info[0]
697 password = info[2]
698 else:
dcce092e
S
699 raise netrc.NetrcParseError(
700 'No authenticators for %s' % netrc_machine)
2118fdd1 701 except (IOError, netrc.NetrcParseError) as err:
dcce092e
S
702 self._downloader.report_warning(
703 'parsing .netrc: %s' % error_to_compat_str(err))
2118fdd1 704
dcce092e 705 return username, password
2118fdd1 706
1b6712ab 707 def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
fc79158d 708 """
cf0649f8 709 Get the login info as (username, password)
32443dd3
S
710 First look for the manually specified credentials using username_option
711 and password_option as keys in params dictionary. If no such credentials
712 available look in the netrc file using the netrc_machine or _NETRC_MACHINE
713 value.
fc79158d
JMF
714 If there's no info available, return (None, None)
715 """
716 if self._downloader is None:
717 return (None, None)
718
fc79158d
JMF
719 downloader_params = self._downloader.params
720
721 # Attempt to use provided username and password or .netrc data
1b6712ab
RA
722 if downloader_params.get(username_option) is not None:
723 username = downloader_params[username_option]
724 password = downloader_params[password_option]
2118fdd1 725 else:
1b6712ab 726 username, password = self._get_netrc_login_info(netrc_machine)
5f6a1245 727
2133565c 728 return username, password
fc79158d 729
e64b7569 730 def _get_tfa_info(self, note='two-factor verification code'):
83317f69 731 """
732 Get the two-factor authentication info
733 TODO - asking the user will be required for sms/phone verify
734 currently just uses the command line option
735 If there's no info available, return None
736 """
737 if self._downloader is None:
83317f69 738 return None
739 downloader_params = self._downloader.params
740
d800609c 741 if downloader_params.get('twofactor') is not None:
83317f69 742 return downloader_params['twofactor']
743
e64b7569 744 return compat_getpass('Type %s and press [Return]: ' % note)
83317f69 745
46720279
JMF
746 # Helper functions for extracting OpenGraph info
747 @staticmethod
ab2d5247 748 def _og_regexes(prop):
448ef1f3 749 content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
7a6d76a6
S
750 property_re = (r'(?:name|property)=(?:\'og:%(prop)s\'|"og:%(prop)s"|\s*og:%(prop)s\b)'
751 % {'prop': re.escape(prop)})
78fb87b2 752 template = r'<meta[^>]+?%s[^>]+?%s'
ab2d5247 753 return [
78fb87b2
JMF
754 template % (property_re, content_re),
755 template % (content_re, property_re),
ab2d5247 756 ]
46720279 757
864f24bd
S
758 @staticmethod
759 def _meta_regex(prop):
760 return r'''(?isx)<meta
8b9848ac 761 (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
864f24bd
S
762 [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
763
3c4e6d83 764 def _og_search_property(self, prop, html, name=None, **kargs):
b070564e
S
765 if not isinstance(prop, (list, tuple)):
766 prop = [prop]
46720279 767 if name is None:
b070564e
S
768 name = 'OpenGraph %s' % prop[0]
769 og_regexes = []
770 for p in prop:
771 og_regexes.extend(self._og_regexes(p))
772 escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
eb0a8398
PH
773 if escaped is None:
774 return None
775 return unescapeHTML(escaped)
46720279
JMF
776
777 def _og_search_thumbnail(self, html, **kargs):
10952eb2 778 return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
46720279
JMF
779
780 def _og_search_description(self, html, **kargs):
781 return self._og_search_property('description', html, fatal=False, **kargs)
782
783 def _og_search_title(self, html, **kargs):
784 return self._og_search_property('title', html, **kargs)
785
8ffa13e0 786 def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
a3681973
PH
787 regexes = self._og_regexes('video') + self._og_regexes('video:url')
788 if secure:
789 regexes = self._og_regexes('video:secure_url') + regexes
8ffa13e0 790 return self._html_search_regex(regexes, html, name, **kargs)
46720279 791
78338f71
JMF
792 def _og_search_url(self, html, **kargs):
793 return self._og_search_property('url', html, **kargs)
794
40c696e5 795 def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
88d9f6c0
S
796 if not isinstance(name, (list, tuple)):
797 name = [name]
59040888 798 if display_name is None:
88d9f6c0 799 display_name = name[0]
59040888 800 return self._html_search_regex(
88d9f6c0 801 [self._meta_regex(n) for n in name],
711ede6e 802 html, display_name, fatal=fatal, group='content', **kwargs)
59040888
PH
803
804 def _dc_search_uploader(self, html):
805 return self._html_search_meta('dc.creator', html, 'uploader')
806
8dbe9899
PH
807 def _rta_search(self, html):
808 # See http://www.rtalabel.org/index.php?content=howtofaq#single
809 if re.search(r'(?ix)<meta\s+name="rating"\s+'
810 r' content="RTA-5042-1996-1400-1577-RTA"',
811 html):
812 return 18
813 return 0
814
59040888
PH
815 def _media_rating_search(self, html):
816 # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
817 rating = self._html_search_meta('rating', html)
818
819 if not rating:
820 return None
821
822 RATING_TABLE = {
823 'safe for kids': 0,
824 'general': 8,
825 '14 years': 14,
826 'mature': 17,
827 'restricted': 19,
828 }
d800609c 829 return RATING_TABLE.get(rating.lower())
59040888 830
69319969 831 def _family_friendly_search(self, html):
6ca7732d 832 # See http://schema.org/VideoObject
69319969
NJ
833 family_friendly = self._html_search_meta('isFamilyFriendly', html)
834
835 if not family_friendly:
836 return None
837
838 RATING_TABLE = {
839 '1': 0,
840 'true': 0,
841 '0': 18,
842 'false': 18,
843 }
d800609c 844 return RATING_TABLE.get(family_friendly.lower())
69319969 845
0c708f11
JMF
846 def _twitter_search_player(self, html):
847 return self._html_search_meta('twitter:player', html,
9e1a5b84 848 'twitter card player')
0c708f11 849
95b31e26 850 def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
4ca2a3cf
S
851 json_ld = self._search_regex(
852 r'(?s)<script[^>]+type=(["\'])application/ld\+json\1[^>]*>(?P<json_ld>.+?)</script>',
0b26ba3f 853 html, 'JSON-LD', group='json_ld', **kwargs)
321b5e08 854 default = kwargs.get('default', NO_DEFAULT)
4ca2a3cf 855 if not json_ld:
321b5e08
S
856 return default if default is not NO_DEFAULT else {}
857 # JSON-LD may be malformed and thus `fatal` should be respected.
858 # At the same time `default` may be passed that assumes `fatal=False`
859 # for _search_regex. Let's simulate the same behavior here as well.
860 fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
861 return self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
4ca2a3cf 862
95b31e26 863 def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
4ca2a3cf
S
864 if isinstance(json_ld, compat_str):
865 json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
866 if not json_ld:
867 return {}
868 info = {}
46933a15
S
869 if not isinstance(json_ld, (list, tuple, dict)):
870 return info
871 if isinstance(json_ld, dict):
872 json_ld = [json_ld]
873 for e in json_ld:
874 if e.get('@context') == 'http://schema.org':
875 item_type = e.get('@type')
876 if expected_type is not None and expected_type != item_type:
877 return info
878 if item_type == 'TVEpisode':
879 info.update({
880 'episode': unescapeHTML(e.get('name')),
881 'episode_number': int_or_none(e.get('episodeNumber')),
882 'description': unescapeHTML(e.get('description')),
883 })
884 part_of_season = e.get('partOfSeason')
885 if isinstance(part_of_season, dict) and part_of_season.get('@type') == 'TVSeason':
886 info['season_number'] = int_or_none(part_of_season.get('seasonNumber'))
d16b3c66 887 part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
46933a15
S
888 if isinstance(part_of_series, dict) and part_of_series.get('@type') == 'TVSeries':
889 info['series'] = unescapeHTML(part_of_series.get('name'))
890 elif item_type == 'Article':
891 info.update({
892 'timestamp': parse_iso8601(e.get('datePublished')),
893 'title': unescapeHTML(e.get('headline')),
894 'description': unescapeHTML(e.get('articleBody')),
895 })
896 elif item_type == 'VideoObject':
897 info.update({
898 'url': e.get('contentUrl'),
899 'title': unescapeHTML(e.get('name')),
900 'description': unescapeHTML(e.get('description')),
f076d797 901 'thumbnail': e.get('thumbnailUrl') or e.get('thumbnailURL'),
46933a15
S
902 'duration': parse_duration(e.get('duration')),
903 'timestamp': unified_timestamp(e.get('uploadDate')),
904 'filesize': float_or_none(e.get('contentSize')),
905 'tbr': int_or_none(e.get('bitrate')),
906 'width': int_or_none(e.get('width')),
907 'height': int_or_none(e.get('height')),
908 })
909 break
4ca2a3cf
S
910 return dict((k, v) for k, v in info.items() if v is not None)
911
27713812 912 @staticmethod
f8da79f8 913 def _hidden_inputs(html):
586f1cc5 914 html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
201ea3ee 915 hidden_inputs = {}
c8498368
S
916 for input in re.findall(r'(?i)(<input[^>]+>)', html):
917 attrs = extract_attributes(input)
918 if not input:
201ea3ee 919 continue
c8498368 920 if attrs.get('type') not in ('hidden', 'submit'):
201ea3ee 921 continue
c8498368
S
922 name = attrs.get('name') or attrs.get('id')
923 value = attrs.get('value')
924 if name and value is not None:
925 hidden_inputs[name] = value
201ea3ee 926 return hidden_inputs
27713812 927
cf61d96d
S
928 def _form_hidden_inputs(self, form_id, html):
929 form = self._search_regex(
73eb13df 930 r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
cf61d96d
S
931 html, '%s form' % form_id, group='form')
932 return self._hidden_inputs(form)
933
3ded7bac 934 def _sort_formats(self, formats, field_preference=None):
7e8caf30 935 if not formats:
f1a9d64e 936 raise ExtractorError('No video formats found')
7e8caf30 937
b0d21ded
S
938 for f in formats:
939 # Automatically determine tbr when missing based on abr and vbr (improves
940 # formats sorting in some cases)
350cf045 941 if 'tbr' not in f and f.get('abr') is not None and f.get('vbr') is not None:
b0d21ded
S
942 f['tbr'] = f['abr'] + f['vbr']
943
4bcc7bd1 944 def _formats_key(f):
e6812ac9
PH
945 # TODO remove the following workaround
946 from ..utils import determine_ext
947 if not f.get('ext') and 'url' in f:
948 f['ext'] = determine_ext(f['url'])
949
3ded7bac 950 if isinstance(field_preference, (list, tuple)):
bf8dd790
S
951 return tuple(
952 f.get(field)
953 if f.get(field) is not None
954 else ('' if field == 'format_id' else -1)
955 for field in field_preference)
3ded7bac 956
4bcc7bd1
PH
957 preference = f.get('preference')
958 if preference is None:
d497a201 959 preference = 0
4bcc7bd1
PH
960 if f.get('ext') in ['f4f', 'f4m']: # Not yet supported
961 preference -= 0.5
962
8b408545
RA
963 protocol = f.get('protocol') or determine_protocol(f)
964 proto_preference = 0 if protocol in ['http', 'https'] else (-0.5 if protocol == 'rtsp' else -0.1)
d497a201 965
4bcc7bd1 966 if f.get('vcodec') == 'none': # audio only
dd867805 967 preference -= 50
4bcc7bd1 968 if self._downloader.params.get('prefer_free_formats'):
f1a9d64e 969 ORDER = ['aac', 'mp3', 'm4a', 'webm', 'ogg', 'opus']
4bcc7bd1 970 else:
f1a9d64e 971 ORDER = ['webm', 'opus', 'ogg', 'mp3', 'aac', 'm4a']
4bcc7bd1
PH
972 ext_preference = 0
973 try:
974 audio_ext_preference = ORDER.index(f['ext'])
975 except ValueError:
976 audio_ext_preference = -1
977 else:
dd867805 978 if f.get('acodec') == 'none': # video only
979 preference -= 40
4bcc7bd1 980 if self._downloader.params.get('prefer_free_formats'):
f1a9d64e 981 ORDER = ['flv', 'mp4', 'webm']
4bcc7bd1 982 else:
f1a9d64e 983 ORDER = ['webm', 'flv', 'mp4']
4bcc7bd1
PH
984 try:
985 ext_preference = ORDER.index(f['ext'])
986 except ValueError:
987 ext_preference = -1
988 audio_ext_preference = 0
989
990 return (
991 preference,
aff2f4f4 992 f.get('language_preference') if f.get('language_preference') is not None else -1,
5d73273f 993 f.get('quality') if f.get('quality') is not None else -1,
9933b574 994 f.get('tbr') if f.get('tbr') is not None else -1,
03cd72b0 995 f.get('filesize') if f.get('filesize') is not None else -1,
4bcc7bd1 996 f.get('vbr') if f.get('vbr') is not None else -1,
1a6373ef
PH
997 f.get('height') if f.get('height') is not None else -1,
998 f.get('width') if f.get('width') is not None else -1,
d497a201 999 proto_preference,
1e1896f2 1000 ext_preference,
4bcc7bd1
PH
1001 f.get('abr') if f.get('abr') is not None else -1,
1002 audio_ext_preference,
2c8e03d9 1003 f.get('fps') if f.get('fps') is not None else -1,
9732d77e 1004 f.get('filesize_approx') if f.get('filesize_approx') is not None else -1,
c64ed2a3 1005 f.get('source_preference') if f.get('source_preference') is not None else -1,
74f72824 1006 f.get('format_id') if f.get('format_id') is not None else '',
4bcc7bd1
PH
1007 )
1008 formats.sort(key=_formats_key)
59040888 1009
96a53167
S
1010 def _check_formats(self, formats, video_id):
1011 if formats:
1012 formats[:] = filter(
1013 lambda f: self._is_valid_url(
1014 f['url'], video_id,
1015 item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
1016 formats)
1017
f5bdb444
S
1018 @staticmethod
1019 def _remove_duplicate_formats(formats):
1020 format_urls = set()
1021 unique_formats = []
1022 for f in formats:
1023 if f['url'] not in format_urls:
1024 format_urls.add(f['url'])
1025 unique_formats.append(f)
1026 formats[:] = unique_formats
1027
45024183 1028 def _is_valid_url(self, url, video_id, item='video', headers={}):
2f0f6578
S
1029 url = self._proto_relative_url(url, scheme='http:')
1030 # For now assume non HTTP(S) URLs always valid
1031 if not (url.startswith('http://') or url.startswith('https://')):
1032 return True
96a53167 1033 try:
45024183 1034 self._request_webpage(url, video_id, 'Checking %s URL' % item, headers=headers)
96a53167
S
1035 return True
1036 except ExtractorError as e:
943a1e24 1037 if isinstance(e.cause, compat_urllib_error.URLError):
baa43cba
S
1038 self.to_screen(
1039 '%s: %s URL is invalid, skipping' % (video_id, item))
96a53167
S
1040 return False
1041 raise
1042
20991253 1043 def http_scheme(self):
1ede5b24 1044 """ Either "http:" or "https:", depending on the user's preferences """
20991253
PH
1045 return (
1046 'http:'
1047 if self._downloader.params.get('prefer_insecure', False)
1048 else 'https:')
1049
57c7411f
PH
1050 def _proto_relative_url(self, url, scheme=None):
1051 if url is None:
1052 return url
1053 if url.startswith('//'):
1054 if scheme is None:
1055 scheme = self.http_scheme()
1056 return scheme + url
1057 else:
1058 return url
1059
4094b6e3
PH
1060 def _sleep(self, timeout, video_id, msg_template=None):
1061 if msg_template is None:
f1a9d64e 1062 msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
4094b6e3
PH
1063 msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1064 self.to_screen(msg)
1065 time.sleep(timeout)
1066
a38436e8 1067 def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None,
4de61310 1068 transform_source=lambda s: fix_xml_ampersands(s).strip(),
448bb5f3 1069 fatal=True, m3u8_id=None):
f036a632
JMF
1070 manifest = self._download_xml(
1071 manifest_url, video_id, 'Downloading f4m manifest',
97f4aecf
S
1072 'Unable to download f4m manifest',
1073 # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
1074 # (see https://github.com/rg3/youtube-dl/issues/6215#issuecomment-121704244)
4de61310
S
1075 transform_source=transform_source,
1076 fatal=fatal)
1077
1078 if manifest is False:
8d29e47f 1079 return []
31bb8d3f 1080
0fdbb332
S
1081 return self._parse_f4m_formats(
1082 manifest, manifest_url, video_id, preference=preference, f4m_id=f4m_id,
448bb5f3 1083 transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
0fdbb332
S
1084
1085 def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, f4m_id=None,
1086 transform_source=lambda s: fix_xml_ampersands(s).strip(),
448bb5f3 1087 fatal=True, m3u8_id=None):
fb72ec58 1088 # currently youtube-dl cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
1089 akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1090 if akamai_pv is not None and ';' in akamai_pv.text:
1091 playerVerificationChallenge = akamai_pv.text.split(';')[0]
1092 if playerVerificationChallenge.strip() != '':
1093 return []
1094
31bb8d3f 1095 formats = []
7a47d07c 1096 manifest_version = '1.0'
b2527359 1097 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
34e48bed 1098 if not media_nodes:
7a47d07c 1099 manifest_version = '2.0'
34e48bed 1100 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
b22ca762
S
1101 # Remove unsupported DRM protected media from final formats
1102 # rendition (see https://github.com/rg3/youtube-dl/issues/8573).
1103 media_nodes = remove_encrypted_media(media_nodes)
1104 if not media_nodes:
1105 return formats
019839fa
S
1106 base_url = xpath_text(
1107 manifest, ['{http://ns.adobe.com/f4m/1.0}baseURL', '{http://ns.adobe.com/f4m/2.0}baseURL'],
1108 'base URL', default=None)
1109 if base_url:
1110 base_url = base_url.strip()
0a5685b2 1111
a6571f10 1112 bootstrap_info = xpath_element(
0a5685b2
YCH
1113 manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1114 'bootstrap info', default=None)
1115
edd6074c
RA
1116 vcodec = None
1117 mime_type = xpath_text(
1118 manifest, ['{http://ns.adobe.com/f4m/1.0}mimeType', '{http://ns.adobe.com/f4m/2.0}mimeType'],
1119 'base URL', default=None)
1120 if mime_type and mime_type.startswith('audio/'):
1121 vcodec = 'none'
1122
b2527359 1123 for i, media_el in enumerate(media_nodes):
77b8b4e6
S
1124 tbr = int_or_none(media_el.attrib.get('bitrate'))
1125 width = int_or_none(media_el.attrib.get('width'))
1126 height = int_or_none(media_el.attrib.get('height'))
1127 format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
448bb5f3
YCH
1128 # If <bootstrapInfo> is present, the specified f4m is a
1129 # stream-level manifest, and only set-level manifests may refer to
1130 # external resources. See section 11.4 and section 4 of F4M spec
1131 if bootstrap_info is None:
1132 media_url = None
1133 # @href is introduced in 2.0, see section 11.6 of F4M spec
1134 if manifest_version == '2.0':
1135 media_url = media_el.attrib.get('href')
1136 if media_url is None:
1137 media_url = media_el.attrib.get('url')
31c746e5
S
1138 if not media_url:
1139 continue
cc357c4d
S
1140 manifest_url = (
1141 media_url if media_url.startswith('http://') or media_url.startswith('https://')
019839fa 1142 else ((base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
70f0f5a8
S
1143 # If media_url is itself a f4m manifest do the recursive extraction
1144 # since bitrates in parent manifest (this one) and media_url manifest
1145 # may differ leading to inability to resolve the format by requested
1146 # bitrate in f4m downloader
240b6045
YCH
1147 ext = determine_ext(manifest_url)
1148 if ext == 'f4m':
77b8b4e6 1149 f4m_formats = self._extract_f4m_formats(
0fdbb332 1150 manifest_url, video_id, preference=preference, f4m_id=f4m_id,
77b8b4e6
S
1151 transform_source=transform_source, fatal=fatal)
1152 # Sometimes stream-level manifest contains single media entry that
1153 # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1154 # At the same time parent's media entry in set-level manifest may
1155 # contain it. We will copy it from parent in such cases.
1156 if len(f4m_formats) == 1:
1157 f = f4m_formats[0]
1158 f.update({
1159 'tbr': f.get('tbr') or tbr,
1160 'width': f.get('width') or width,
1161 'height': f.get('height') or height,
1162 'format_id': f.get('format_id') if not tbr else format_id,
edd6074c 1163 'vcodec': vcodec,
77b8b4e6
S
1164 })
1165 formats.extend(f4m_formats)
70f0f5a8 1166 continue
240b6045
YCH
1167 elif ext == 'm3u8':
1168 formats.extend(self._extract_m3u8_formats(
1169 manifest_url, video_id, 'mp4', preference=preference,
fac2af3c 1170 m3u8_id=m3u8_id, fatal=fatal))
240b6045 1171 continue
31bb8d3f 1172 formats.append({
77b8b4e6 1173 'format_id': format_id,
31bb8d3f 1174 'url': manifest_url,
30d0b549 1175 'manifest_url': manifest_url,
a6571f10 1176 'ext': 'flv' if bootstrap_info is not None else None,
b2527359 1177 'tbr': tbr,
77b8b4e6
S
1178 'width': width,
1179 'height': height,
edd6074c 1180 'vcodec': vcodec,
60ca389c 1181 'preference': preference,
31bb8d3f 1182 })
31bb8d3f
JMF
1183 return formats
1184
16da9bbc
YCH
1185 def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, m3u8_id=None):
1186 return {
f207019c 1187 'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
704df56d
PH
1188 'url': m3u8_url,
1189 'ext': ext,
1190 'protocol': 'm3u8',
37768f92 1191 'preference': preference - 100 if preference else -100,
704df56d
PH
1192 'resolution': 'multiple',
1193 'format_note': 'Quality selection URL',
16da9bbc
YCH
1194 }
1195
1196 def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
1197 entry_protocol='m3u8', preference=None,
1198 m3u8_id=None, note=None, errnote=None,
1199 fatal=True, live=False):
1200
dbd82a1d 1201 res = self._download_webpage_handle(
81515ad9 1202 m3u8_url, video_id,
621ed9f5 1203 note=note or 'Downloading m3u8 information',
13af92fd
YCH
1204 errnote=errnote or 'Failed to download m3u8 information',
1205 fatal=fatal)
dbd82a1d 1206 if res is False:
8d29e47f 1207 return []
dbd82a1d 1208 m3u8_doc, urlh = res
37113045 1209 m3u8_url = urlh.geturl()
9cdffeeb 1210
0def7587
RA
1211 formats = [self._m3u8_meta_format(m3u8_url, ext, preference, m3u8_id)]
1212
1213 format_url = lambda u: (
1214 u
1215 if re.match(r'^https?://', u)
1216 else compat_urlparse.urljoin(m3u8_url, u))
1217
9cdffeeb
S
1218 # We should try extracting formats only from master playlists [1], i.e.
1219 # playlists that describe available qualities. On the other hand media
1220 # playlists [2] should be returned as is since they contain just the media
1221 # without qualities renditions.
1222 # Fortunately, master playlist can be easily distinguished from media
1223 # playlist based on particular tags availability. As of [1, 2] master
1224 # playlist tags MUST NOT appear in a media playist and vice versa.
1225 # As of [3] #EXT-X-TARGETDURATION tag is REQUIRED for every media playlist
1226 # and MUST NOT appear in master playlist thus we can clearly detect media
1227 # playlist with this criterion.
1228 # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.4
1229 # 2. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.3
1230 # 3. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.3.1
1231 if '#EXT-X-TARGETDURATION' in m3u8_doc: # media playlist, return as is
7f32e5dc 1232 return [{
1233 'url': m3u8_url,
1234 'format_id': m3u8_id,
1235 'ext': ext,
1236 'protocol': entry_protocol,
1237 'preference': preference,
1238 }]
a0758836 1239 audio_in_video_stream = {}
e816c9d1
S
1240 last_info = {}
1241 last_media = {}
704df56d
PH
1242 for line in m3u8_doc.splitlines():
1243 if line.startswith('#EXT-X-STREAM-INF:'):
e154c651 1244 last_info = parse_m3u8_attributes(line)
4cd95bcb 1245 elif line.startswith('#EXT-X-MEDIA:'):
f39ffc58
RA
1246 media = parse_m3u8_attributes(line)
1247 media_type = media.get('TYPE')
1248 if media_type in ('VIDEO', 'AUDIO'):
a0758836 1249 group_id = media.get('GROUP-ID')
f39ffc58
RA
1250 media_url = media.get('URI')
1251 if media_url:
1252 format_id = []
a0758836 1253 for v in (group_id, media.get('NAME')):
f39ffc58
RA
1254 if v:
1255 format_id.append(v)
8821a718 1256 f = {
f39ffc58
RA
1257 'format_id': '-'.join(format_id),
1258 'url': format_url(media_url),
1259 'language': media.get('LANGUAGE'),
f39ffc58
RA
1260 'ext': ext,
1261 'protocol': entry_protocol,
1262 'preference': preference,
8821a718
RA
1263 }
1264 if media_type == 'AUDIO':
1265 f['vcodec'] = 'none'
a0758836
RA
1266 if group_id and not audio_in_video_stream.get(group_id):
1267 audio_in_video_stream[group_id] = False
8821a718 1268 formats.append(f)
9250181f
S
1269 else:
1270 # When there is no URI in EXT-X-MEDIA let this tag's
1271 # data be used by regular URI lines below
1272 last_media = media
a0758836
RA
1273 if media_type == 'AUDIO' and group_id:
1274 audio_in_video_stream[group_id] = True
704df56d
PH
1275 elif line.startswith('#') or not line.strip():
1276 continue
1277 else:
f39ffc58 1278 tbr = int_or_none(last_info.get('AVERAGE-BANDWIDTH') or last_info.get('BANDWIDTH'), scale=1000)
8dc9d361
S
1279 format_id = []
1280 if m3u8_id:
1281 format_id.append(m3u8_id)
9250181f
S
1282 # Despite specification does not mention NAME attribute for
1283 # EXT-X-STREAM-INF it still sometimes may be present
e816c9d1 1284 stream_name = last_info.get('NAME') or last_media.get('NAME')
b24d6336
KH
1285 # Bandwidth of live streams may differ over time thus making
1286 # format_id unpredictable. So it's better to keep provided
1287 # format_id intact.
e9c6cdf4 1288 if not live:
ed56f260 1289 format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
30d0b549 1290 manifest_url = format_url(line.strip())
704df56d 1291 f = {
8dc9d361 1292 'format_id': '-'.join(format_id),
30d0b549
S
1293 'url': manifest_url,
1294 'manifest_url': manifest_url,
704df56d
PH
1295 'tbr': tbr,
1296 'ext': ext,
00f4764c 1297 'fps': float_or_none(last_info.get('FRAME-RATE')),
f0b5d6af
PH
1298 'protocol': entry_protocol,
1299 'preference': preference,
704df56d 1300 }
704df56d
PH
1301 resolution = last_info.get('RESOLUTION')
1302 if resolution:
c4c9b844
S
1303 mobj = re.search(r'(?P<width>\d+)[xX](?P<height>\d+)', resolution)
1304 if mobj:
1305 f['width'] = int(mobj.group('width'))
1306 f['height'] = int(mobj.group('height'))
00f4764c
RA
1307 # Unified Streaming Platform
1308 mobj = re.search(
1309 r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
1310 if mobj:
1311 abr, vbr = mobj.groups()
1312 abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
fbb6edd2 1313 f.update({
00f4764c
RA
1314 'vbr': vbr,
1315 'abr': abr,
fbb6edd2 1316 })
00f4764c 1317 f.update(parse_codecs(last_info.get('CODECS')))
242a14a1
S
1318 if audio_in_video_stream.get(last_info.get('AUDIO')) is False and f['vcodec'] != 'none':
1319 # TODO: update acodec for audio only formats with the same GROUP-ID
8821a718 1320 f['acodec'] = 'none'
704df56d
PH
1321 formats.append(f)
1322 last_info = {}
e816c9d1 1323 last_media = {}
704df56d
PH
1324 return formats
1325
a107193e
S
1326 @staticmethod
1327 def _xpath_ns(path, namespace=None):
1328 if not namespace:
1329 return path
1330 out = []
1331 for c in path.split('/'):
1332 if not c or c == '.':
1333 out.append(c)
1334 else:
1335 out.append('{%s}%s' % (namespace, c))
1336 return '/'.join(out)
1337
09f572fb 1338 def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
1339 smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
a107193e 1340
995029a1
PH
1341 if smil is False:
1342 assert not fatal
1343 return []
e89a2aab 1344
17712eeb 1345 namespace = self._parse_smil_namespace(smil)
a107193e
S
1346
1347 return self._parse_smil_formats(
1348 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1349
1350 def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
1351 smil = self._download_smil(smil_url, video_id, fatal=fatal)
1352 if smil is False:
1353 return {}
1354 return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
1355
09f572fb 1356 def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
a107193e
S
1357 return self._download_xml(
1358 smil_url, video_id, 'Downloading SMIL file',
09f572fb 1359 'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
a107193e
S
1360
1361 def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
17712eeb 1362 namespace = self._parse_smil_namespace(smil)
a107193e
S
1363
1364 formats = self._parse_smil_formats(
1365 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1366 subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
1367
1368 video_id = os.path.splitext(url_basename(smil_url))[0]
1369 title = None
1370 description = None
647eab45 1371 upload_date = None
a107193e
S
1372 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1373 name = meta.attrib.get('name')
1374 content = meta.attrib.get('content')
1375 if not name or not content:
1376 continue
1377 if not title and name == 'title':
1378 title = content
1379 elif not description and name in ('description', 'abstract'):
1380 description = content
647eab45
S
1381 elif not upload_date and name == 'date':
1382 upload_date = unified_strdate(content)
a107193e 1383
1e5bcdec
S
1384 thumbnails = [{
1385 'id': image.get('type'),
1386 'url': image.get('src'),
1387 'width': int_or_none(image.get('width')),
1388 'height': int_or_none(image.get('height')),
1389 } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
1390
a107193e
S
1391 return {
1392 'id': video_id,
1393 'title': title or video_id,
1394 'description': description,
647eab45 1395 'upload_date': upload_date,
1e5bcdec 1396 'thumbnails': thumbnails,
a107193e
S
1397 'formats': formats,
1398 'subtitles': subtitles,
1399 }
1400
17712eeb
S
1401 def _parse_smil_namespace(self, smil):
1402 return self._search_regex(
1403 r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
1404
f877c6ae 1405 def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
a107193e
S
1406 base = smil_url
1407 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1408 b = meta.get('base') or meta.get('httpBase')
1409 if b:
1410 base = b
1411 break
e89a2aab
S
1412
1413 formats = []
1414 rtmp_count = 0
a107193e 1415 http_count = 0
7f32e5dc 1416 m3u8_count = 0
a107193e 1417
81e1c4e2 1418 srcs = []
ad96b4c8
YCH
1419 media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
1420 for medium in media:
1421 src = medium.get('src')
81e1c4e2 1422 if not src or src in srcs:
a107193e 1423 continue
81e1c4e2 1424 srcs.append(src)
a107193e 1425
ad96b4c8
YCH
1426 bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
1427 filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
1428 width = int_or_none(medium.get('width'))
1429 height = int_or_none(medium.get('height'))
1430 proto = medium.get('proto')
1431 ext = medium.get('ext')
a107193e 1432 src_ext = determine_ext(src)
ad96b4c8 1433 streamer = medium.get('streamer') or base
a107193e
S
1434
1435 if proto == 'rtmp' or streamer.startswith('rtmp'):
1436 rtmp_count += 1
1437 formats.append({
1438 'url': streamer,
1439 'play_path': src,
1440 'ext': 'flv',
1441 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
1442 'tbr': bitrate,
1443 'filesize': filesize,
1444 'width': width,
1445 'height': height,
1446 })
f877c6ae
YCH
1447 if transform_rtmp_url:
1448 streamer, src = transform_rtmp_url(streamer, src)
1449 formats[-1].update({
1450 'url': streamer,
1451 'play_path': src,
1452 })
a107193e
S
1453 continue
1454
1455 src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
c349456e 1456 src_url = src_url.strip()
a107193e
S
1457
1458 if proto == 'm3u8' or src_ext == 'm3u8':
7f32e5dc 1459 m3u8_formats = self._extract_m3u8_formats(
1460 src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
1461 if len(m3u8_formats) == 1:
1462 m3u8_count += 1
1463 m3u8_formats[0].update({
1464 'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
1465 'tbr': bitrate,
1466 'width': width,
1467 'height': height,
1468 })
1469 formats.extend(m3u8_formats)
a107193e
S
1470 continue
1471
1472 if src_ext == 'f4m':
1473 f4m_url = src_url
1474 if not f4m_params:
1475 f4m_params = {
1476 'hdcore': '3.2.0',
1477 'plugin': 'flowplayer-3.2.0.1',
1478 }
1479 f4m_url += '&' if '?' in f4m_url else '?'
15707c7e 1480 f4m_url += compat_urllib_parse_urlencode(f4m_params)
7e5edcfd 1481 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
a107193e
S
1482 continue
1483
c78e4817 1484 if src_url.startswith('http') and self._is_valid_url(src, video_id):
a107193e
S
1485 http_count += 1
1486 formats.append({
1487 'url': src_url,
1488 'ext': ext or src_ext or 'flv',
1489 'format_id': 'http-%d' % (bitrate or http_count),
1490 'tbr': bitrate,
1491 'filesize': filesize,
1492 'width': width,
1493 'height': height,
1494 })
1495 continue
63757032 1496
e89a2aab
S
1497 return formats
1498
ce00af87 1499 def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
d413095f 1500 urls = []
a107193e
S
1501 subtitles = {}
1502 for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
1503 src = textstream.get('src')
d413095f 1504 if not src or src in urls:
a107193e 1505 continue
d413095f 1506 urls.append(src)
df634be2 1507 ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
03bc7237 1508 lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
a107193e
S
1509 subtitles.setdefault(lang, []).append({
1510 'url': src,
1511 'ext': ext,
1512 })
1513 return subtitles
63757032 1514
942acef5
S
1515 def _extract_xspf_playlist(self, playlist_url, playlist_id, fatal=True):
1516 xspf = self._download_xml(
8d6765cf 1517 playlist_url, playlist_id, 'Downloading xpsf playlist',
942acef5
S
1518 'Unable to download xspf manifest', fatal=fatal)
1519 if xspf is False:
1520 return []
1521 return self._parse_xspf(xspf, playlist_id)
8d6765cf 1522
942acef5 1523 def _parse_xspf(self, playlist, playlist_id):
8d6765cf
S
1524 NS_MAP = {
1525 'xspf': 'http://xspf.org/ns/0/',
1526 's1': 'http://static.streamone.nl/player/ns/0',
1527 }
1528
1529 entries = []
1530 for track in playlist.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
1531 title = xpath_text(
98044462 1532 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
8d6765cf
S
1533 description = xpath_text(
1534 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
1535 thumbnail = xpath_text(
1536 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
1537 duration = float_or_none(
1538 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
1539
1540 formats = [{
1541 'url': location.text,
1542 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
1543 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
1544 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
1545 } for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP))]
1546 self._sort_formats(formats)
1547
1548 entries.append({
1549 'id': playlist_id,
1550 'title': title,
1551 'description': description,
1552 'thumbnail': thumbnail,
1553 'duration': duration,
1554 'formats': formats,
1555 })
1556 return entries
1557
1bac3455 1558 def _extract_mpd_formats(self, mpd_url, video_id, mpd_id=None, note=None, errnote=None, fatal=True, formats_dict={}):
1559 res = self._download_webpage_handle(
1560 mpd_url, video_id,
1561 note=note or 'Downloading MPD manifest',
1562 errnote=errnote or 'Failed to download MPD manifest',
2d2fa82d 1563 fatal=fatal)
1bac3455 1564 if res is False:
2d2fa82d 1565 return []
1bac3455 1566 mpd, urlh = res
02dc0a36 1567 mpd_base_url = base_url(urlh.geturl())
1bac3455 1568
91cb6b50 1569 return self._parse_mpd_formats(
86f4d14f
S
1570 compat_etree_fromstring(mpd.encode('utf-8')), mpd_id, mpd_base_url,
1571 formats_dict=formats_dict, mpd_url=mpd_url)
2d2fa82d 1572
86f4d14f 1573 def _parse_mpd_formats(self, mpd_doc, mpd_id=None, mpd_base_url='', formats_dict={}, mpd_url=None):
f0948348
S
1574 """
1575 Parse formats from MPD manifest.
1576 References:
1577 1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
1578 http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
1579 2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
1580 """
1bac3455 1581 if mpd_doc.get('type') == 'dynamic':
1582 return []
2d2fa82d 1583
91cb6b50 1584 namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
f14be228 1585
1586 def _add_ns(path):
1587 return self._xpath_ns(path, namespace)
1588
675d0016 1589 def is_drm_protected(element):
1590 return element.find(_add_ns('ContentProtection')) is not None
1591
1bac3455 1592 def extract_multisegment_info(element, ms_parent_info):
1593 ms_info = ms_parent_info.copy()
b4c1d6e8
S
1594
1595 # As per [1, 5.3.9.2.2] SegmentList and SegmentTemplate share some
1596 # common attributes and elements. We will only extract relevant
1597 # for us.
1598 def extract_common(source):
1599 segment_timeline = source.find(_add_ns('SegmentTimeline'))
1600 if segment_timeline is not None:
1601 s_e = segment_timeline.findall(_add_ns('S'))
1602 if s_e:
1603 ms_info['total_number'] = 0
1604 ms_info['s'] = []
1605 for s in s_e:
1606 r = int(s.get('r', 0))
1607 ms_info['total_number'] += 1 + r
1608 ms_info['s'].append({
1609 't': int(s.get('t', 0)),
1610 # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
1611 'd': int(s.attrib['d']),
1612 'r': r,
1613 })
1614 start_number = source.get('startNumber')
1615 if start_number:
1616 ms_info['start_number'] = int(start_number)
1617 timescale = source.get('timescale')
1618 if timescale:
1619 ms_info['timescale'] = int(timescale)
1620 segment_duration = source.get('duration')
1621 if segment_duration:
1622 ms_info['segment_duration'] = int(segment_duration)
1623
1624 def extract_Initialization(source):
1625 initialization = source.find(_add_ns('Initialization'))
1626 if initialization is not None:
1627 ms_info['initialization_url'] = initialization.attrib['sourceURL']
1628
f14be228 1629 segment_list = element.find(_add_ns('SegmentList'))
1bac3455 1630 if segment_list is not None:
b4c1d6e8
S
1631 extract_common(segment_list)
1632 extract_Initialization(segment_list)
f14be228 1633 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
1bac3455 1634 if segment_urls_e:
1635 ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
1bac3455 1636 else:
f14be228 1637 segment_template = element.find(_add_ns('SegmentTemplate'))
1bac3455 1638 if segment_template is not None:
b4c1d6e8 1639 extract_common(segment_template)
e228616c
S
1640 media = segment_template.get('media')
1641 if media:
1642 ms_info['media'] = media
1bac3455 1643 initialization = segment_template.get('initialization')
1644 if initialization:
e228616c 1645 ms_info['initialization'] = initialization
1bac3455 1646 else:
b4c1d6e8 1647 extract_Initialization(segment_template)
1bac3455 1648 return ms_info
b323e170 1649
1bac3455 1650 mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
17b598d3 1651 formats = []
f14be228 1652 for period in mpd_doc.findall(_add_ns('Period')):
1bac3455 1653 period_duration = parse_duration(period.get('duration')) or mpd_duration
1654 period_ms_info = extract_multisegment_info(period, {
1655 'start_number': 1,
1656 'timescale': 1,
1657 })
f14be228 1658 for adaptation_set in period.findall(_add_ns('AdaptationSet')):
675d0016 1659 if is_drm_protected(adaptation_set):
1660 continue
1bac3455 1661 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
f14be228 1662 for representation in adaptation_set.findall(_add_ns('Representation')):
675d0016 1663 if is_drm_protected(representation):
1664 continue
1bac3455 1665 representation_attrib = adaptation_set.attrib.copy()
1666 representation_attrib.update(representation.attrib)
f0948348 1667 # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
a6c8b759
YCH
1668 mime_type = representation_attrib['mimeType']
1669 content_type = mime_type.split('/')[0]
1bac3455 1670 if content_type == 'text':
1671 # TODO implement WebVTT downloading
1672 pass
1673 elif content_type == 'video' or content_type == 'audio':
1674 base_url = ''
1675 for element in (representation, adaptation_set, period, mpd_doc):
f14be228 1676 base_url_e = element.find(_add_ns('BaseURL'))
1bac3455 1677 if base_url_e is not None:
1678 base_url = base_url_e.text + base_url
1679 if re.match(r'^https?://', base_url):
1680 break
bb20526b
S
1681 if mpd_base_url and not re.match(r'^https?://', base_url):
1682 if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
1683 mpd_base_url += '/'
1bac3455 1684 base_url = mpd_base_url + base_url
1685 representation_id = representation_attrib.get('id')
d577c796 1686 lang = representation_attrib.get('lang')
51e9094f 1687 url_el = representation.find(_add_ns('BaseURL'))
1688 filesize = int_or_none(url_el.attrib.get('{http://youtube.com/yt/2012/10/10}contentLength') if url_el is not None else None)
e228616c 1689 bandwidth = int_or_none(representation_attrib.get('bandwidth'))
1bac3455 1690 f = {
154c209e 1691 'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
1bac3455 1692 'url': base_url,
86f4d14f 1693 'manifest_url': mpd_url,
a6c8b759 1694 'ext': mimetype2ext(mime_type),
1bac3455 1695 'width': int_or_none(representation_attrib.get('width')),
1696 'height': int_or_none(representation_attrib.get('height')),
e228616c 1697 'tbr': int_or_none(bandwidth, 1000),
1bac3455 1698 'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
1699 'fps': int_or_none(representation_attrib.get('frameRate')),
d577c796 1700 'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
1bac3455 1701 'format_note': 'DASH %s' % content_type,
51e9094f 1702 'filesize': filesize,
1bac3455 1703 }
7fe15920 1704 f.update(parse_codecs(representation_attrib.get('codecs')))
1bac3455 1705 representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
b4c1d6e8 1706
e228616c
S
1707 def prepare_template(template_name, identifiers):
1708 t = representation_ms_info[template_name]
1709 t = t.replace('$RepresentationID$', representation_id)
1710 t = re.sub(r'\$(%s)\$' % '|'.join(identifiers), r'%(\1)d', t)
1711 t = re.sub(r'\$(%s)%%([^$]+)\$' % '|'.join(identifiers), r'%(\1)\2', t)
1712 t.replace('$$', '$')
1713 return t
1714
1715 # @initialization is a regular template like @media one
1716 # so it should be handled just the same way (see
1717 # https://github.com/rg3/youtube-dl/issues/11605)
1718 if 'initialization' in representation_ms_info:
1719 initialization_template = prepare_template(
1720 'initialization',
1721 # As per [1, 5.3.9.4.2, Table 15, page 54] $Number$ and
1722 # $Time$ shall not be included for @initialization thus
1723 # only $Bandwidth$ remains
1724 ('Bandwidth', ))
1725 representation_ms_info['initialization_url'] = initialization_template % {
1726 'Bandwidth': bandwidth,
1727 }
1728
1729 if 'segment_urls' not in representation_ms_info and 'media' in representation_ms_info:
1730
1731 media_template = prepare_template('media', ('Number', 'Bandwidth', 'Time'))
f0948348
S
1732
1733 # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
1734 # can't be used at the same time
b4c1d6e8
S
1735 if '%(Number' in media_template and 's' not in representation_ms_info:
1736 segment_duration = None
1737 if 'total_number' not in representation_ms_info and 'segment_duration':
1738 segment_duration = float_or_none(representation_ms_info['segment_duration'], representation_ms_info['timescale'])
1739 representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
b4c1d6e8
S
1740 representation_ms_info['fragments'] = [{
1741 'url': media_template % {
1742 'Number': segment_number,
e228616c 1743 'Bandwidth': bandwidth,
b4c1d6e8
S
1744 },
1745 'duration': segment_duration,
1746 } for segment_number in range(
1747 representation_ms_info['start_number'],
1748 representation_ms_info['total_number'] + representation_ms_info['start_number'])]
f0948348 1749 else:
b4c1d6e8
S
1750 # $Number*$ or $Time$ in media template with S list available
1751 # Example $Number*$: http://www.svtplay.se/klipp/9023742/stopptid-om-bjorn-borg
1752 # Example $Time$: https://play.arkena.com/embed/avp/v2/player/media/b41dda37-d8e7-4d3f-b1b5-9a9db578bdfe/1/129411
b4c1d6e8 1753 representation_ms_info['fragments'] = []
f0948348 1754 segment_time = 0
b4c1d6e8
S
1755 segment_d = None
1756 segment_number = representation_ms_info['start_number']
f0948348
S
1757
1758 def add_segment_url():
b4c1d6e8
S
1759 segment_url = media_template % {
1760 'Time': segment_time,
e228616c 1761 'Bandwidth': bandwidth,
b4c1d6e8
S
1762 'Number': segment_number,
1763 }
b4c1d6e8
S
1764 representation_ms_info['fragments'].append({
1765 'url': segment_url,
1766 'duration': float_or_none(segment_d, representation_ms_info['timescale']),
1767 })
f0948348
S
1768
1769 for num, s in enumerate(representation_ms_info['s']):
1770 segment_time = s.get('t') or segment_time
b4c1d6e8 1771 segment_d = s['d']
f0948348 1772 add_segment_url()
b4c1d6e8 1773 segment_number += 1
f0948348 1774 for r in range(s.get('r', 0)):
b4c1d6e8 1775 segment_time += segment_d
f0948348 1776 add_segment_url()
b4c1d6e8
S
1777 segment_number += 1
1778 segment_time += segment_d
1779 elif 'segment_urls' in representation_ms_info and 's' in representation_ms_info:
1780 # No media template
1781 # Example: https://www.youtube.com/watch?v=iXZV5uAYMJI
1782 # or any YouTube dashsegments video
1783 fragments = []
d04621da
S
1784 segment_index = 0
1785 timescale = representation_ms_info['timescale']
1786 for s in representation_ms_info['s']:
1787 duration = float_or_none(s['d'], timescale)
b4c1d6e8
S
1788 for r in range(s.get('r', 0) + 1):
1789 fragments.append({
d04621da
S
1790 'url': representation_ms_info['segment_urls'][segment_index],
1791 'duration': duration,
b4c1d6e8 1792 })
d04621da 1793 segment_index += 1
b4c1d6e8 1794 representation_ms_info['fragments'] = fragments
86f4d14f
S
1795 # NB: MPD manifest may contain direct URLs to unfragmented media.
1796 # No fragments key is present in this case.
1797 if 'fragments' in representation_ms_info:
1bac3455 1798 f.update({
b4c1d6e8 1799 'fragments': [],
1bac3455 1800 'protocol': 'http_dash_segments',
df374b52 1801 })
1bac3455 1802 if 'initialization_url' in representation_ms_info:
e228616c 1803 initialization_url = representation_ms_info['initialization_url']
1bac3455 1804 if not f.get('url'):
1805 f['url'] = initialization_url
b4c1d6e8
S
1806 f['fragments'].append({'url': initialization_url})
1807 f['fragments'].extend(representation_ms_info['fragments'])
1808 for fragment in f['fragments']:
7fe15920 1809 fragment['url'] = urljoin(base_url, fragment['url'])
1bac3455 1810 try:
1811 existing_format = next(
1812 fo for fo in formats
1813 if fo['format_id'] == representation_id)
1814 except StopIteration:
1815 full_info = formats_dict.get(representation_id, {}).copy()
1816 full_info.update(f)
1817 formats.append(full_info)
1818 else:
1819 existing_format.update(f)
17b598d3 1820 else:
1bac3455 1821 self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
17b598d3
YCH
1822 return formats
1823
b2758123
RA
1824 def _extract_ism_formats(self, ism_url, video_id, ism_id=None, note=None, errnote=None, fatal=True):
1825 res = self._download_webpage_handle(
1826 ism_url, video_id,
1827 note=note or 'Downloading ISM manifest',
1828 errnote=errnote or 'Failed to download ISM manifest',
1829 fatal=fatal)
1830 if res is False:
1831 return []
1832 ism, urlh = res
1833
1834 return self._parse_ism_formats(
1835 compat_etree_fromstring(ism.encode('utf-8')), urlh.geturl(), ism_id)
1836
1837 def _parse_ism_formats(self, ism_doc, ism_url, ism_id=None):
1838 if ism_doc.get('IsLive') == 'TRUE' or ism_doc.find('Protection') is not None:
1839 return []
1840
b2758123
RA
1841 duration = int(ism_doc.attrib['Duration'])
1842 timescale = int_or_none(ism_doc.get('TimeScale')) or 10000000
1843
1844 formats = []
1845 for stream in ism_doc.findall('StreamIndex'):
1846 stream_type = stream.get('Type')
1847 if stream_type not in ('video', 'audio'):
1848 continue
1849 url_pattern = stream.attrib['Url']
1850 stream_timescale = int_or_none(stream.get('TimeScale')) or timescale
1851 stream_name = stream.get('Name')
1852 for track in stream.findall('QualityLevel'):
1853 fourcc = track.get('FourCC')
1854 # TODO: add support for WVC1 and WMAP
1855 if fourcc not in ('H264', 'AVC1', 'AACL'):
1856 self.report_warning('%s is not a supported codec' % fourcc)
1857 continue
1858 tbr = int(track.attrib['Bitrate']) // 1000
1859 width = int_or_none(track.get('MaxWidth'))
1860 height = int_or_none(track.get('MaxHeight'))
1861 sampling_rate = int_or_none(track.get('SamplingRate'))
1862
1863 track_url_pattern = re.sub(r'{[Bb]itrate}', track.attrib['Bitrate'], url_pattern)
1864 track_url_pattern = compat_urlparse.urljoin(ism_url, track_url_pattern)
1865
1866 fragments = []
1867 fragment_ctx = {
1868 'time': 0,
1869 }
1870 stream_fragments = stream.findall('c')
1871 for stream_fragment_index, stream_fragment in enumerate(stream_fragments):
1872 fragment_ctx['time'] = int_or_none(stream_fragment.get('t')) or fragment_ctx['time']
1873 fragment_repeat = int_or_none(stream_fragment.get('r')) or 1
1874 fragment_ctx['duration'] = int_or_none(stream_fragment.get('d'))
1875 if not fragment_ctx['duration']:
1876 try:
1877 next_fragment_time = int(stream_fragment[stream_fragment_index + 1].attrib['t'])
1878 except IndexError:
1879 next_fragment_time = duration
1616f9b4 1880 fragment_ctx['duration'] = (next_fragment_time - fragment_ctx['time']) / fragment_repeat
b2758123
RA
1881 for _ in range(fragment_repeat):
1882 fragments.append({
1616f9b4 1883 'url': re.sub(r'{start[ _]time}', compat_str(fragment_ctx['time']), track_url_pattern),
b2758123
RA
1884 'duration': fragment_ctx['duration'] / stream_timescale,
1885 })
1886 fragment_ctx['time'] += fragment_ctx['duration']
1887
1888 format_id = []
1889 if ism_id:
1890 format_id.append(ism_id)
1891 if stream_name:
1892 format_id.append(stream_name)
1893 format_id.append(compat_str(tbr))
1894
1895 formats.append({
1896 'format_id': '-'.join(format_id),
1897 'url': ism_url,
1898 'manifest_url': ism_url,
1899 'ext': 'ismv' if stream_type == 'video' else 'isma',
1900 'width': width,
1901 'height': height,
1902 'tbr': tbr,
1903 'asr': sampling_rate,
1904 'vcodec': 'none' if stream_type == 'audio' else fourcc,
1905 'acodec': 'none' if stream_type == 'video' else fourcc,
1906 'protocol': 'ism',
1907 'fragments': fragments,
1908 '_download_params': {
1909 'duration': duration,
1910 'timescale': stream_timescale,
1911 'width': width or 0,
1912 'height': height or 0,
1913 'fourcc': fourcc,
1914 'codec_private_data': track.get('CodecPrivateData'),
1915 'sampling_rate': sampling_rate,
1916 'channels': int_or_none(track.get('Channels', 2)),
1917 'bits_per_sample': int_or_none(track.get('BitsPerSample', 16)),
1918 'nal_unit_length_field': int_or_none(track.get('NALUnitLengthField', 4)),
1919 },
1920 })
1921 return formats
1922
87a449c1 1923 def _parse_html5_media_entries(self, base_url, webpage, video_id, m3u8_id=None, m3u8_entry_protocol='m3u8', mpd_id=None):
59bbe491 1924 def absolute_url(video_url):
1925 return compat_urlparse.urljoin(base_url, video_url)
1926
1927 def parse_content_type(content_type):
1928 if not content_type:
1929 return {}
1930 ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
1931 if ctr:
1932 mimetype, codecs = ctr.groups()
1933 f = parse_codecs(codecs)
1934 f['ext'] = mimetype2ext(mimetype)
1935 return f
1936 return {}
1937
520251c0
YCH
1938 def _media_formats(src, cur_media_type):
1939 full_url = absolute_url(src)
87a449c1
S
1940 ext = determine_ext(full_url)
1941 if ext == 'm3u8':
520251c0
YCH
1942 is_plain_url = False
1943 formats = self._extract_m3u8_formats(
ad120ae1
YCH
1944 full_url, video_id, ext='mp4',
1945 entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id)
87a449c1
S
1946 elif ext == 'mpd':
1947 is_plain_url = False
1948 formats = self._extract_mpd_formats(
1949 full_url, video_id, mpd_id=mpd_id)
520251c0
YCH
1950 else:
1951 is_plain_url = True
1952 formats = [{
1953 'url': full_url,
1954 'vcodec': 'none' if cur_media_type == 'audio' else None,
1955 }]
1956 return is_plain_url, formats
1957
59bbe491 1958 entries = []
cea364f7
YCH
1959 media_tags = [(media_tag, media_type, '')
1960 for media_tag, media_type
1961 in re.findall(r'(?s)(<(video|audio)[^>]*/>)', webpage)]
2aec7256
S
1962 media_tags.extend(re.findall(
1963 # We only allow video|audio followed by a whitespace or '>'.
1964 # Allowing more characters may end up in significant slow down (see
1965 # https://github.com/rg3/youtube-dl/issues/11979, example URL:
1966 # http://www.porntrex.com/maps/videositemap.xml).
1967 r'(?s)(<(?P<tag>video|audio)(?:\s+[^>]*)?>)(.*?)</(?P=tag)>', webpage))
cea364f7 1968 for media_tag, media_type, media_content in media_tags:
59bbe491 1969 media_info = {
1970 'formats': [],
1971 'subtitles': {},
1972 }
1973 media_attributes = extract_attributes(media_tag)
1974 src = media_attributes.get('src')
1975 if src:
dedb1770 1976 _, formats = _media_formats(src, media_type)
520251c0 1977 media_info['formats'].extend(formats)
59bbe491 1978 media_info['thumbnail'] = media_attributes.get('poster')
1979 if media_content:
1980 for source_tag in re.findall(r'<source[^>]+>', media_content):
1981 source_attributes = extract_attributes(source_tag)
1982 src = source_attributes.get('src')
1983 if not src:
1984 continue
520251c0
YCH
1985 is_plain_url, formats = _media_formats(src, media_type)
1986 if is_plain_url:
1987 f = parse_content_type(source_attributes.get('type'))
1988 f.update(formats[0])
1989 media_info['formats'].append(f)
1990 else:
1991 media_info['formats'].extend(formats)
59bbe491 1992 for track_tag in re.findall(r'<track[^>]+>', media_content):
1993 track_attributes = extract_attributes(track_tag)
1994 kind = track_attributes.get('kind')
5968d7d2 1995 if not kind or kind in ('subtitles', 'captions'):
59bbe491 1996 src = track_attributes.get('src')
1997 if not src:
1998 continue
1999 lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
2000 media_info['subtitles'].setdefault(lang, []).append({
2001 'url': absolute_url(src),
2002 })
5968d7d2 2003 if media_info['formats'] or media_info['subtitles']:
59bbe491 2004 entries.append(media_info)
2005 return entries
2006
c4251b9a 2007 def _extract_akamai_formats(self, manifest_url, video_id, hosts={}):
c7c43a93 2008 formats = []
e71a4509 2009 hdcore_sign = 'hdcore=3.7.0'
c4251b9a
RA
2010 f4m_url = re.sub(r'(https?://[^/+])/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
2011 hds_host = hosts.get('hds')
2012 if hds_host:
2013 f4m_url = re.sub(r'(https?://)[^/]+', r'\1' + hds_host, f4m_url)
e71a4509
RA
2014 if 'hdcore=' not in f4m_url:
2015 f4m_url += ('&' if '?' in f4m_url else '?') + hdcore_sign
2016 f4m_formats = self._extract_f4m_formats(
2017 f4m_url, video_id, f4m_id='hds', fatal=False)
2018 for entry in f4m_formats:
2019 entry.update({'extra_param_to_segment_url': hdcore_sign})
2020 formats.extend(f4m_formats)
c4251b9a
RA
2021 m3u8_url = re.sub(r'(https?://[^/]+)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
2022 hls_host = hosts.get('hls')
2023 if hls_host:
2024 m3u8_url = re.sub(r'(https?://)[^/]+', r'\1' + hls_host, m3u8_url)
c7c43a93
RA
2025 formats.extend(self._extract_m3u8_formats(
2026 m3u8_url, video_id, 'mp4', 'm3u8_native',
2027 m3u8_id='hls', fatal=False))
2028 return formats
2029
6ad02195
RA
2030 def _extract_wowza_formats(self, url, video_id, m3u8_entry_protocol='m3u8_native', skip_protocols=[]):
2031 url = re.sub(r'/(?:manifest|playlist|jwplayer)\.(?:m3u8|f4m|mpd|smil)', '', url)
2032 url_base = self._search_regex(r'(?:https?|rtmp|rtsp)(://[^?]+)', url, 'format url')
2033 http_base_url = 'http' + url_base
2034 formats = []
2035 if 'm3u8' not in skip_protocols:
2036 formats.extend(self._extract_m3u8_formats(
2037 http_base_url + '/playlist.m3u8', video_id, 'mp4',
2038 m3u8_entry_protocol, m3u8_id='hls', fatal=False))
2039 if 'f4m' not in skip_protocols:
2040 formats.extend(self._extract_f4m_formats(
2041 http_base_url + '/manifest.f4m',
2042 video_id, f4m_id='hds', fatal=False))
0384932e
RA
2043 if 'dash' not in skip_protocols:
2044 formats.extend(self._extract_mpd_formats(
2045 http_base_url + '/manifest.mpd',
2046 video_id, mpd_id='dash', fatal=False))
6ad02195 2047 if re.search(r'(?:/smil:|\.smil)', url_base):
6ad02195
RA
2048 if 'smil' not in skip_protocols:
2049 rtmp_formats = self._extract_smil_formats(
2050 http_base_url + '/jwplayer.smil',
2051 video_id, fatal=False)
2052 for rtmp_format in rtmp_formats:
2053 rtsp_format = rtmp_format.copy()
2054 rtsp_format['url'] = '%s/%s' % (rtmp_format['url'], rtmp_format['play_path'])
2055 del rtsp_format['play_path']
2056 del rtsp_format['ext']
2057 rtsp_format.update({
2058 'url': rtsp_format['url'].replace('rtmp://', 'rtsp://'),
2059 'format_id': rtmp_format['format_id'].replace('rtmp', 'rtsp'),
2060 'protocol': 'rtsp',
2061 })
2062 formats.extend([rtmp_format, rtsp_format])
2063 else:
2064 for protocol in ('rtmp', 'rtsp'):
2065 if protocol not in skip_protocols:
2066 formats.append({
2067 'url': protocol + url_base,
2068 'format_id': protocol,
2069 'protocol': protocol,
2070 })
2071 return formats
2072
f4b1c7ad
PH
2073 def _live_title(self, name):
2074 """ Generate the title for a live video """
2075 now = datetime.datetime.now()
611c1dd9 2076 now_str = now.strftime('%Y-%m-%d %H:%M')
f4b1c7ad
PH
2077 return name + ' ' + now_str
2078
b14f3a4c
PH
2079 def _int(self, v, name, fatal=False, **kwargs):
2080 res = int_or_none(v, **kwargs)
2081 if 'get_attr' in kwargs:
2082 print(getattr(v, kwargs['get_attr']))
2083 if res is None:
2084 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
2085 if fatal:
2086 raise ExtractorError(msg)
2087 else:
2088 self._downloader.report_warning(msg)
2089 return res
2090
2091 def _float(self, v, name, fatal=False, **kwargs):
2092 res = float_or_none(v, **kwargs)
2093 if res is None:
2094 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
2095 if fatal:
2096 raise ExtractorError(msg)
2097 else:
2098 self._downloader.report_warning(msg)
2099 return res
2100
42939b61 2101 def _set_cookie(self, domain, name, value, expire_time=None):
810fb84d
PH
2102 cookie = compat_cookiejar.Cookie(
2103 0, name, value, None, None, domain, None,
42939b61
JMF
2104 None, '/', True, False, expire_time, '', None, None, None)
2105 self._downloader.cookiejar.set_cookie(cookie)
2106
799207e8 2107 def _get_cookies(self, url):
2108 """ Return a compat_cookies.SimpleCookie with the cookies for the url """
5c2266df 2109 req = sanitized_Request(url)
799207e8 2110 self._downloader.cookiejar.add_cookie_header(req)
2111 return compat_cookies.SimpleCookie(req.get_header('Cookie'))
2112
05900629
PH
2113 def get_testcases(self, include_onlymatching=False):
2114 t = getattr(self, '_TEST', None)
2115 if t:
2116 assert not hasattr(self, '_TESTS'), \
2117 '%s has _TEST and _TESTS' % type(self).__name__
2118 tests = [t]
2119 else:
2120 tests = getattr(self, '_TESTS', [])
2121 for t in tests:
2122 if not include_onlymatching and t.get('only_matching', False):
2123 continue
2124 t['name'] = type(self).__name__[:-len('IE')]
2125 yield t
2126
2127 def is_suitable(self, age_limit):
2128 """ Test whether the extractor is generally suitable for the given
2129 age limit (i.e. pornographic sites are not, all others usually are) """
2130
2131 any_restricted = False
2132 for tc in self.get_testcases(include_onlymatching=False):
40090e8d 2133 if tc.get('playlist', []):
05900629
PH
2134 tc = tc['playlist'][0]
2135 is_restricted = age_restricted(
2136 tc.get('info_dict', {}).get('age_limit'), age_limit)
2137 if not is_restricted:
2138 return True
2139 any_restricted = any_restricted or is_restricted
2140 return not any_restricted
2141
a504ced0 2142 def extract_subtitles(self, *args, **kwargs):
9868ea49
JMF
2143 if (self._downloader.params.get('writesubtitles', False) or
2144 self._downloader.params.get('listsubtitles')):
2145 return self._get_subtitles(*args, **kwargs)
2146 return {}
a504ced0
JMF
2147
2148 def _get_subtitles(self, *args, **kwargs):
611c1dd9 2149 raise NotImplementedError('This method must be implemented by subclasses')
a504ced0 2150
912e0b7e
YCH
2151 @staticmethod
2152 def _merge_subtitle_items(subtitle_list1, subtitle_list2):
2153 """ Merge subtitle items for one language. Items with duplicated URLs
2154 will be dropped. """
2155 list1_urls = set([item['url'] for item in subtitle_list1])
2156 ret = list(subtitle_list1)
2157 ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
2158 return ret
2159
2160 @classmethod
8c97f819 2161 def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2):
912e0b7e 2162 """ Merge two subtitle dictionaries, language by language. """
912e0b7e
YCH
2163 ret = dict(subtitle_dict1)
2164 for lang in subtitle_dict2:
8c97f819 2165 ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang])
912e0b7e
YCH
2166 return ret
2167
360e1ca5 2168 def extract_automatic_captions(self, *args, **kwargs):
9868ea49
JMF
2169 if (self._downloader.params.get('writeautomaticsub', False) or
2170 self._downloader.params.get('listsubtitles')):
2171 return self._get_automatic_captions(*args, **kwargs)
2172 return {}
360e1ca5
JMF
2173
2174 def _get_automatic_captions(self, *args, **kwargs):
611c1dd9 2175 raise NotImplementedError('This method must be implemented by subclasses')
360e1ca5 2176
d77ab8e2
S
2177 def mark_watched(self, *args, **kwargs):
2178 if (self._downloader.params.get('mark_watched', False) and
2179 (self._get_login_info()[0] is not None or
2180 self._downloader.params.get('cookiefile') is not None)):
2181 self._mark_watched(*args, **kwargs)
2182
2183 def _mark_watched(self, *args, **kwargs):
2184 raise NotImplementedError('This method must be implemented by subclasses')
2185
38cce791
YCH
2186 def geo_verification_headers(self):
2187 headers = {}
2188 geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
2189 if geo_verification_proxy:
2190 headers['Ytdl-request-proxy'] = geo_verification_proxy
2191 return headers
2192
98763ee3
YCH
2193 def _generic_id(self, url):
2194 return compat_urllib_parse_unquote(os.path.splitext(url.rstrip('/').split('/')[-1])[0])
2195
2196 def _generic_title(self, url):
2197 return compat_urllib_parse_unquote(os.path.splitext(url_basename(url))[0])
2198
8dbe9899 2199
d6983cb4
PH
2200class SearchInfoExtractor(InfoExtractor):
2201 """
2202 Base class for paged search queries extractors.
10952eb2 2203 They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
d6983cb4
PH
2204 Instances should define _SEARCH_KEY and _MAX_RESULTS.
2205 """
2206
2207 @classmethod
2208 def _make_valid_url(cls):
2209 return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
2210
2211 @classmethod
2212 def suitable(cls, url):
2213 return re.match(cls._make_valid_url(), url) is not None
2214
2215 def _real_extract(self, query):
2216 mobj = re.match(self._make_valid_url(), query)
2217 if mobj is None:
f1a9d64e 2218 raise ExtractorError('Invalid search query "%s"' % query)
d6983cb4
PH
2219
2220 prefix = mobj.group('prefix')
2221 query = mobj.group('query')
2222 if prefix == '':
2223 return self._get_n_results(query, 1)
2224 elif prefix == 'all':
2225 return self._get_n_results(query, self._MAX_RESULTS)
2226 else:
2227 n = int(prefix)
2228 if n <= 0:
f1a9d64e 2229 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
d6983cb4 2230 elif n > self._MAX_RESULTS:
f1a9d64e 2231 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
d6983cb4
PH
2232 n = self._MAX_RESULTS
2233 return self._get_n_results(query, n)
2234
2235 def _get_n_results(self, query, n):
2236 """Get a specified number of results for a query"""
611c1dd9 2237 raise NotImplementedError('This method must be implemented by subclasses')
0f818663
PH
2238
2239 @property
2240 def SEARCH_KEY(self):
2241 return self._SEARCH_KEY