1 from __future__ import unicode_literals
15 from ..compat import (
18 compat_etree_fromstring,
24 compat_urllib_parse_unquote,
25 compat_urllib_parse_urlencode,
26 compat_urllib_request,
29 from ..downloader.f4m import remove_encrypted_media
59 parse_m3u8_attributes,
66 class InfoExtractor(object):
67 """Information Extractor class.
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
73 passed to the YoutubeDL. The YoutubeDL processes this
74 information possibly downloading the video to the file system, among
75 other possible outcomes.
77 The type field determines the type of the result.
78 By far the most common value (and the default if _type is missing) is
79 "video", which indicates a single video.
81 For a video, the dictionaries must include the following fields:
84 title: Video title, unescaped.
86 Additionally, it must contain either a formats entry or a url one:
88 formats: A list of dictionaries for each format available, ordered
89 from worst to best quality.
92 * url Mandatory. The URL of the video file
94 The URL of the manifest file in case of
95 fragmented media (DASH, hls, hds)
96 * ext Will be calculated from URL if missing
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
102 ("mp4_h264_opus" or "19").
103 Technically optional, but strongly recommended.
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
108 * resolution Textual description of width and height
109 * tbr Average bitrate of audio and video in KBit/s
110 * abr Average audio bitrate in KBit/s
111 * acodec Name of the audio codec in use
112 * asr Audio sampling rate in Hertz
113 * vbr Average video bitrate in KBit/s
115 * vcodec Name of the video codec in use
116 * container Name of the container format
117 * filesize The number of bytes, if known in advance
118 * filesize_approx An estimate for the number of bytes
119 * player_url SWF Player URL (used for rtmpdump).
120 * protocol The protocol that will be used for the actual
121 download, lower-case.
122 "http", "https", "rtsp", "rtmp", "rtmpe",
123 "m3u8", "m3u8_native" or "http_dash_segments".
124 * fragments A list of fragments of the fragmented media,
125 with the following entries:
126 * "url" (mandatory) - fragment's URL
127 * "duration" (optional, int or float)
128 * "filesize" (optional, int)
129 * preference Order number of this format. If this field is
130 present and not None, the formats get sorted
131 by this field, regardless of all other values.
132 -1 for default (order by other properties),
133 -2 or smaller for less than default.
134 < -1000 to hide the format (if there is
135 another one which is strictly better)
136 * language Language code, e.g. "de" or "en-US".
137 * language_preference Is this in the language mentioned in
139 10 if it's what the URL is about,
140 -1 for default (don't know),
141 -10 otherwise, other values reserved for now.
142 * quality Order number of the video quality of this
143 format, irrespective of the file format.
144 -1 for default (order by other properties),
145 -2 or smaller for less than default.
146 * source_preference Order number for this video source
147 (quality takes higher priority)
148 -1 for default (order by other properties),
149 -2 or smaller for less than default.
150 * http_headers A dictionary of additional HTTP headers
151 to add to the request.
152 * stretched_ratio If given and not 1, indicates that the
153 video's pixels are not square.
154 width : height ratio as float.
155 * no_resume The server does not support resuming the
156 (HTTP or RTMP) download. Boolean.
158 url: Final video URL.
159 ext: Video filename extension.
160 format: The video format, defaults to ext (used for --get-format)
161 player_url: SWF Player URL (used for rtmpdump).
163 The following fields are optional:
165 alt_title: A secondary title of the video.
166 display_id An alternative identifier for the video, not necessarily
167 unique, but available before title. Typically, id is
168 something like "4234987", title "Dancing naked mole rats",
169 and display_id "dancing-naked-mole-rats"
170 thumbnails: A list of dictionaries, with the following entries:
171 * "id" (optional, string) - Thumbnail format ID
173 * "preference" (optional, int) - quality of the image
174 * "width" (optional, int)
175 * "height" (optional, int)
176 * "resolution" (optional, string "{width}x{height"},
178 * "filesize" (optional, int)
179 thumbnail: Full URL to a video thumbnail image.
180 description: Full video description.
181 uploader: Full name of the video uploader.
182 license: License name the video is licensed under.
183 creator: The creator of the video.
184 release_date: The date (YYYYMMDD) when the video was released.
185 timestamp: UNIX timestamp of the moment the video became available.
186 upload_date: Video upload date (YYYYMMDD).
187 If not explicitly set, calculated from timestamp.
188 uploader_id: Nickname or id of the video uploader.
189 uploader_url: Full URL to a personal webpage of the video uploader.
190 location: Physical location where the video was filmed.
191 subtitles: The available subtitles as a dictionary in the format
192 {tag: subformats}. "tag" is usually a language code, and
193 "subformats" is a list sorted from lower to higher
194 preference, each element is a dictionary with the "ext"
196 * "data": The subtitles file contents
197 * "url": A URL pointing to the subtitles file
198 "ext" will be calculated from URL if missing
199 automatic_captions: Like 'subtitles', used by the YoutubeIE for
200 automatically generated captions
201 duration: Length of the video in seconds, as an integer or float.
202 view_count: How many users have watched the video on the platform.
203 like_count: Number of positive ratings of the video
204 dislike_count: Number of negative ratings of the video
205 repost_count: Number of reposts of the video
206 average_rating: Average rating give by users, the scale used depends on the webpage
207 comment_count: Number of comments on the video
208 comments: A list of comments, each with one or more of the following
209 properties (all but one of text or html optional):
210 * "author" - human-readable name of the comment author
211 * "author_id" - user ID of the comment author
213 * "html" - Comment as HTML
214 * "text" - Plain text of the comment
215 * "timestamp" - UNIX timestamp of comment
216 * "parent" - ID of the comment this one is replying to.
217 Set to "root" to indicate that this is a
218 comment to the original video.
219 age_limit: Age restriction for the video, as an integer (years)
220 webpage_url: The URL to the video webpage, if given to youtube-dl it
221 should allow to get the same result again. (It will be set
222 by YoutubeDL if it's missing)
223 categories: A list of categories that the video falls in, for example
225 tags: A list of tags assigned to the video, e.g. ["sweden", "pop music"]
226 is_live: True, False, or None (=unknown). Whether this video is a
227 live stream that goes on instead of a fixed-length video.
228 start_time: Time in seconds where the reproduction should start, as
229 specified in the URL.
230 end_time: Time in seconds where the reproduction should end, as
231 specified in the URL.
233 The following fields should only be used when the video belongs to some logical
236 chapter: Name or title of the chapter the video belongs to.
237 chapter_number: Number of the chapter the video belongs to, as an integer.
238 chapter_id: Id of the chapter the video belongs to, as a unicode string.
240 The following fields should only be used when the video is an episode of some
241 series, programme or podcast:
243 series: Title of the series or programme the video episode belongs to.
244 season: Title of the season the video episode belongs to.
245 season_number: Number of the season the video episode belongs to, as an integer.
246 season_id: Id of the season the video episode belongs to, as a unicode string.
247 episode: Title of the video episode. Unlike mandatory video title field,
248 this field should denote the exact title of the video episode
249 without any kind of decoration.
250 episode_number: Number of the video episode within a season, as an integer.
251 episode_id: Id of the video episode, as a unicode string.
253 The following fields should only be used when the media is a track or a part of
256 track: Title of the track.
257 track_number: Number of the track within an album or a disc, as an integer.
258 track_id: Id of the track (useful in case of custom indexing, e.g. 6.iii),
260 artist: Artist(s) of the track.
261 genre: Genre(s) of the track.
262 album: Title of the album the track belongs to.
263 album_type: Type of the album (e.g. "Demo", "Full-length", "Split", "Compilation", etc).
264 album_artist: List of all artists appeared on the album (e.g.
265 "Ash Borer / Fell Voices" or "Various Artists", useful for splits
267 disc_number: Number of the disc or other physical medium the track belongs to,
269 release_year: Year (YYYY) when the album was released.
271 Unless mentioned otherwise, the fields should be Unicode strings.
273 Unless mentioned otherwise, None is equivalent to absence of information.
276 _type "playlist" indicates multiple videos.
277 There must be a key "entries", which is a list, an iterable, or a PagedList
278 object, each element of which is a valid dictionary by this specification.
280 Additionally, playlists can have "title", "description" and "id" attributes
281 with the same semantics as videos (see above).
284 _type "multi_video" indicates that there are multiple videos that
285 form a single show, for examples multiple acts of an opera or TV episode.
286 It must have an entries key like a playlist and contain all the keys
287 required for a video at the same time.
290 _type "url" indicates that the video must be extracted from another
291 location, possibly by a different extractor. Its only required key is:
292 "url" - the next URL to extract.
293 The key "ie_key" can be set to the class name (minus the trailing "IE",
294 e.g. "Youtube") if the extractor class is known in advance.
295 Additionally, the dictionary may have any properties of the resolved entity
296 known in advance, for example "title" if the title of the referred video is
300 _type "url_transparent" entities have the same specification as "url", but
301 indicate that the given additional information is more precise than the one
302 associated with the resolved URL.
303 This is useful when a site employs a video service that hosts the video and
304 its technical metadata, but that video service does not embed a useful
305 title, description etc.
308 Subclasses of this one should re-define the _real_initialize() and
309 _real_extract() methods and define a _VALID_URL regexp.
310 Probably, they should also be added to the list of extractors.
312 Finally, the _WORKING attribute should be set to False for broken IEs
313 in order to warn the users and skip the tests.
320 def __init__(self, downloader=None):
321 """Constructor. Receives an optional downloader."""
323 self.set_downloader(downloader)
326 def suitable(cls, url):
327 """Receives a URL and returns True if suitable for this IE."""
329 # This does not use has/getattr intentionally - we want to know whether
330 # we have cached the regexp for *this* class, whereas getattr would also
331 # match the superclass
332 if '_VALID_URL_RE' not in cls.__dict__:
333 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
334 return cls._VALID_URL_RE.match(url) is not None
337 def _match_id(cls, url):
338 if '_VALID_URL_RE' not in cls.__dict__:
339 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
340 m = cls._VALID_URL_RE.match(url)
346 """Getter method for _WORKING."""
349 def initialize(self):
350 """Initializes an instance (authentication, etc)."""
352 self._real_initialize()
355 def extract(self, url):
356 """Extracts URL information and returns it in list of dicts."""
359 return self._real_extract(url)
360 except ExtractorError:
362 except compat_http_client.IncompleteRead as e:
363 raise ExtractorError('A network error has occurred.', cause=e, expected=True)
364 except (KeyError, StopIteration) as e:
365 raise ExtractorError('An extractor error has occurred.', cause=e)
367 def set_downloader(self, downloader):
368 """Sets the downloader for this IE."""
369 self._downloader = downloader
371 def _real_initialize(self):
372 """Real initialization process. Redefine in subclasses."""
375 def _real_extract(self, url):
376 """Real extraction process. Redefine in subclasses."""
381 """A string for getting the InfoExtractor with get_info_extractor"""
382 return compat_str(cls.__name__[:-2])
386 return compat_str(type(self).__name__[:-2])
388 def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
389 """ Returns the response handle """
391 self.report_download_webpage(video_id)
392 elif note is not False:
394 self.to_screen('%s' % (note,))
396 self.to_screen('%s: %s' % (video_id, note))
397 if isinstance(url_or_request, compat_urllib_request.Request):
398 url_or_request = update_Request(
399 url_or_request, data=data, headers=headers, query=query)
402 url_or_request = update_url_query(url_or_request, query)
403 if data is not None or headers:
404 url_or_request = sanitized_Request(url_or_request, data, headers)
406 return self._downloader.urlopen(url_or_request)
407 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
411 errnote = 'Unable to download webpage'
413 errmsg = '%s: %s' % (errnote, error_to_compat_str(err))
415 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
417 self._downloader.report_warning(errmsg)
420 def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True, encoding=None, data=None, headers={}, query={}):
421 """ Returns a tuple (page content as string, URL handle) """
422 # Strip hashes from the URL (#1038)
423 if isinstance(url_or_request, (compat_str, str)):
424 url_or_request = url_or_request.partition('#')[0]
426 urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal, data=data, headers=headers, query=query)
430 content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding)
431 return (content, urlh)
434 def _guess_encoding_from_content(content_type, webpage_bytes):
435 m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
437 encoding = m.group(1)
439 m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
440 webpage_bytes[:1024])
442 encoding = m.group(1).decode('ascii')
443 elif webpage_bytes.startswith(b'\xff\xfe'):
450 def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None):
451 content_type = urlh.headers.get('Content-Type', '')
452 webpage_bytes = urlh.read()
453 if prefix is not None:
454 webpage_bytes = prefix + webpage_bytes
456 encoding = self._guess_encoding_from_content(content_type, webpage_bytes)
457 if self._downloader.params.get('dump_intermediate_pages', False):
459 url = url_or_request.get_full_url()
460 except AttributeError:
462 self.to_screen('Dumping request to ' + url)
463 dump = base64.b64encode(webpage_bytes).decode('ascii')
464 self._downloader.to_screen(dump)
465 if self._downloader.params.get('write_pages', False):
467 url = url_or_request.get_full_url()
468 except AttributeError:
470 basen = '%s_%s' % (video_id, url)
472 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
473 basen = basen[:240 - len(h)] + h
474 raw_filename = basen + '.dump'
475 filename = sanitize_filename(raw_filename, restricted=True)
476 self.to_screen('Saving request to ' + filename)
477 # Working around MAX_PATH limitation on Windows (see
478 # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
479 if compat_os_name == 'nt':
480 absfilepath = os.path.abspath(filename)
481 if len(absfilepath) > 259:
482 filename = '\\\\?\\' + absfilepath
483 with open(filename, 'wb') as outf:
484 outf.write(webpage_bytes)
487 content = webpage_bytes.decode(encoding, 'replace')
489 content = webpage_bytes.decode('utf-8', 'replace')
491 if ('<title>Access to this site is blocked</title>' in content and
492 'Websense' in content[:512]):
493 msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
494 blocked_iframe = self._html_search_regex(
495 r'<iframe src="([^"]+)"', content,
496 'Websense information URL', default=None)
498 msg += ' Visit %s for more details' % blocked_iframe
499 raise ExtractorError(msg, expected=True)
500 if '<title>The URL you requested has been blocked</title>' in content[:512]:
502 'Access to this webpage has been blocked by Indian censorship. '
503 'Use a VPN or proxy server (with --proxy) to route around it.')
504 block_msg = self._html_search_regex(
505 r'</h1><p>(.*?)</p>',
506 content, 'block message', default=None)
508 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
509 raise ExtractorError(msg, expected=True)
513 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={}):
514 """ Returns the data of the page as a string """
517 while success is False:
519 res = self._download_webpage_handle(url_or_request, video_id, note, errnote, fatal, encoding=encoding, data=data, headers=headers, query=query)
521 except compat_http_client.IncompleteRead as e:
523 if try_count >= tries:
525 self._sleep(timeout, video_id)
532 def _download_xml(self, url_or_request, video_id,
533 note='Downloading XML', errnote='Unable to download XML',
534 transform_source=None, fatal=True, encoding=None, data=None, headers={}, query={}):
535 """Return the xml as an xml.etree.ElementTree.Element"""
536 xml_string = self._download_webpage(
537 url_or_request, video_id, note, errnote, fatal=fatal, encoding=encoding, data=data, headers=headers, query=query)
538 if xml_string is False:
541 xml_string = transform_source(xml_string)
542 return compat_etree_fromstring(xml_string.encode('utf-8'))
544 def _download_json(self, url_or_request, video_id,
545 note='Downloading JSON metadata',
546 errnote='Unable to download JSON metadata',
547 transform_source=None,
548 fatal=True, encoding=None, data=None, headers={}, query={}):
549 json_string = self._download_webpage(
550 url_or_request, video_id, note, errnote, fatal=fatal,
551 encoding=encoding, data=data, headers=headers, query=query)
552 if (not fatal) and json_string is False:
554 return self._parse_json(
555 json_string, video_id, transform_source=transform_source, fatal=fatal)
557 def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
559 json_string = transform_source(json_string)
561 return json.loads(json_string)
562 except ValueError as ve:
563 errmsg = '%s: Failed to parse JSON ' % video_id
565 raise ExtractorError(errmsg, cause=ve)
567 self.report_warning(errmsg + str(ve))
569 def report_warning(self, msg, video_id=None):
570 idstr = '' if video_id is None else '%s: ' % video_id
571 self._downloader.report_warning(
572 '[%s] %s%s' % (self.IE_NAME, idstr, msg))
574 def to_screen(self, msg):
575 """Print msg to screen, prefixing it with '[ie_name]'"""
576 self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
578 def report_extraction(self, id_or_name):
579 """Report information extraction."""
580 self.to_screen('%s: Extracting information' % id_or_name)
582 def report_download_webpage(self, video_id):
583 """Report webpage download."""
584 self.to_screen('%s: Downloading webpage' % video_id)
586 def report_age_confirmation(self):
587 """Report attempt to confirm age."""
588 self.to_screen('Confirming age')
590 def report_login(self):
591 """Report attempt to log in."""
592 self.to_screen('Logging in')
595 def raise_login_required(msg='This video is only available for registered users'):
596 raise ExtractorError(
597 '%s. Use --username and --password or --netrc to provide account credentials.' % msg,
601 def raise_geo_restricted(msg='This video is not available from your location due to geo restriction'):
602 raise ExtractorError(
603 '%s. You might want to use --proxy to workaround.' % msg,
606 # Methods for following #608
608 def url_result(url, ie=None, video_id=None, video_title=None):
609 """Returns a URL that points to a page that should be processed"""
610 # TODO: ie should be the class used for getting the info
611 video_info = {'_type': 'url',
614 if video_id is not None:
615 video_info['id'] = video_id
616 if video_title is not None:
617 video_info['title'] = video_title
621 def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None):
622 """Returns a playlist"""
623 video_info = {'_type': 'playlist',
626 video_info['id'] = playlist_id
628 video_info['title'] = playlist_title
629 if playlist_description:
630 video_info['description'] = playlist_description
633 def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
635 Perform a regex search on the given string, using a single or a list of
636 patterns returning the first matching group.
637 In case of failure return a default value or raise a WARNING or a
638 RegexNotFoundError, depending on fatal, specifying the field name.
640 if isinstance(pattern, (str, compat_str, compiled_regex_type)):
641 mobj = re.search(pattern, string, flags)
644 mobj = re.search(p, string, flags)
648 if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
649 _name = '\033[0;34m%s\033[0m' % name
655 # return the first matching group
656 return next(g for g in mobj.groups() if g is not None)
658 return mobj.group(group)
659 elif default is not NO_DEFAULT:
662 raise RegexNotFoundError('Unable to extract %s' % _name)
664 self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message())
667 def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
669 Like _search_regex, but strips HTML tags and unescapes entities.
671 res = self._search_regex(pattern, string, name, default, fatal, flags, group)
673 return clean_html(res).strip()
677 def _get_netrc_login_info(self, netrc_machine=None):
680 netrc_machine = netrc_machine or self._NETRC_MACHINE
682 if self._downloader.params.get('usenetrc', False):
684 info = netrc.netrc().authenticators(netrc_machine)
689 raise netrc.NetrcParseError(
690 'No authenticators for %s' % netrc_machine)
691 except (IOError, netrc.NetrcParseError) as err:
692 self._downloader.report_warning(
693 'parsing .netrc: %s' % error_to_compat_str(err))
695 return username, password
697 def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
699 Get the login info as (username, password)
700 First look for the manually specified credentials using username_option
701 and password_option as keys in params dictionary. If no such credentials
702 available look in the netrc file using the netrc_machine or _NETRC_MACHINE
704 If there's no info available, return (None, None)
706 if self._downloader is None:
709 downloader_params = self._downloader.params
711 # Attempt to use provided username and password or .netrc data
712 if downloader_params.get(username_option) is not None:
713 username = downloader_params[username_option]
714 password = downloader_params[password_option]
716 username, password = self._get_netrc_login_info(netrc_machine)
718 return username, password
720 def _get_tfa_info(self, note='two-factor verification code'):
722 Get the two-factor authentication info
723 TODO - asking the user will be required for sms/phone verify
724 currently just uses the command line option
725 If there's no info available, return None
727 if self._downloader is None:
729 downloader_params = self._downloader.params
731 if downloader_params.get('twofactor') is not None:
732 return downloader_params['twofactor']
734 return compat_getpass('Type %s and press [Return]: ' % note)
736 # Helper functions for extracting OpenGraph info
738 def _og_regexes(prop):
739 content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
740 property_re = (r'(?:name|property)=(?:\'og:%(prop)s\'|"og:%(prop)s"|\s*og:%(prop)s\b)'
741 % {'prop': re.escape(prop)})
742 template = r'<meta[^>]+?%s[^>]+?%s'
744 template % (property_re, content_re),
745 template % (content_re, property_re),
749 def _meta_regex(prop):
750 return r'''(?isx)<meta
751 (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
752 [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
754 def _og_search_property(self, prop, html, name=None, **kargs):
755 if not isinstance(prop, (list, tuple)):
758 name = 'OpenGraph %s' % prop[0]
761 og_regexes.extend(self._og_regexes(p))
762 escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
765 return unescapeHTML(escaped)
767 def _og_search_thumbnail(self, html, **kargs):
768 return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
770 def _og_search_description(self, html, **kargs):
771 return self._og_search_property('description', html, fatal=False, **kargs)
773 def _og_search_title(self, html, **kargs):
774 return self._og_search_property('title', html, **kargs)
776 def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
777 regexes = self._og_regexes('video') + self._og_regexes('video:url')
779 regexes = self._og_regexes('video:secure_url') + regexes
780 return self._html_search_regex(regexes, html, name, **kargs)
782 def _og_search_url(self, html, **kargs):
783 return self._og_search_property('url', html, **kargs)
785 def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
786 if not isinstance(name, (list, tuple)):
788 if display_name is None:
789 display_name = name[0]
790 return self._html_search_regex(
791 [self._meta_regex(n) for n in name],
792 html, display_name, fatal=fatal, group='content', **kwargs)
794 def _dc_search_uploader(self, html):
795 return self._html_search_meta('dc.creator', html, 'uploader')
797 def _rta_search(self, html):
798 # See http://www.rtalabel.org/index.php?content=howtofaq#single
799 if re.search(r'(?ix)<meta\s+name="rating"\s+'
800 r' content="RTA-5042-1996-1400-1577-RTA"',
805 def _media_rating_search(self, html):
806 # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
807 rating = self._html_search_meta('rating', html)
819 return RATING_TABLE.get(rating.lower())
821 def _family_friendly_search(self, html):
822 # See http://schema.org/VideoObject
823 family_friendly = self._html_search_meta('isFamilyFriendly', html)
825 if not family_friendly:
834 return RATING_TABLE.get(family_friendly.lower())
836 def _twitter_search_player(self, html):
837 return self._html_search_meta('twitter:player', html,
838 'twitter card player')
840 def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
841 json_ld = self._search_regex(
842 r'(?s)<script[^>]+type=(["\'])application/ld\+json\1[^>]*>(?P<json_ld>.+?)</script>',
843 html, 'JSON-LD', group='json_ld', **kwargs)
844 default = kwargs.get('default', NO_DEFAULT)
846 return default if default is not NO_DEFAULT else {}
847 # JSON-LD may be malformed and thus `fatal` should be respected.
848 # At the same time `default` may be passed that assumes `fatal=False`
849 # for _search_regex. Let's simulate the same behavior here as well.
850 fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
851 return self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
853 def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
854 if isinstance(json_ld, compat_str):
855 json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
859 if not isinstance(json_ld, (list, tuple, dict)):
861 if isinstance(json_ld, dict):
864 if e.get('@context') == 'http://schema.org':
865 item_type = e.get('@type')
866 if expected_type is not None and expected_type != item_type:
868 if item_type == 'TVEpisode':
870 'episode': unescapeHTML(e.get('name')),
871 'episode_number': int_or_none(e.get('episodeNumber')),
872 'description': unescapeHTML(e.get('description')),
874 part_of_season = e.get('partOfSeason')
875 if isinstance(part_of_season, dict) and part_of_season.get('@type') == 'TVSeason':
876 info['season_number'] = int_or_none(part_of_season.get('seasonNumber'))
877 part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
878 if isinstance(part_of_series, dict) and part_of_series.get('@type') == 'TVSeries':
879 info['series'] = unescapeHTML(part_of_series.get('name'))
880 elif item_type == 'Article':
882 'timestamp': parse_iso8601(e.get('datePublished')),
883 'title': unescapeHTML(e.get('headline')),
884 'description': unescapeHTML(e.get('articleBody')),
886 elif item_type == 'VideoObject':
888 'url': e.get('contentUrl'),
889 'title': unescapeHTML(e.get('name')),
890 'description': unescapeHTML(e.get('description')),
891 'thumbnail': e.get('thumbnailUrl') or e.get('thumbnailURL'),
892 'duration': parse_duration(e.get('duration')),
893 'timestamp': unified_timestamp(e.get('uploadDate')),
894 'filesize': float_or_none(e.get('contentSize')),
895 'tbr': int_or_none(e.get('bitrate')),
896 'width': int_or_none(e.get('width')),
897 'height': int_or_none(e.get('height')),
900 return dict((k, v) for k, v in info.items() if v is not None)
903 def _hidden_inputs(html):
904 html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
906 for input in re.findall(r'(?i)(<input[^>]+>)', html):
907 attrs = extract_attributes(input)
910 if attrs.get('type') not in ('hidden', 'submit'):
912 name = attrs.get('name') or attrs.get('id')
913 value = attrs.get('value')
914 if name and value is not None:
915 hidden_inputs[name] = value
918 def _form_hidden_inputs(self, form_id, html):
919 form = self._search_regex(
920 r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
921 html, '%s form' % form_id, group='form')
922 return self._hidden_inputs(form)
924 def _sort_formats(self, formats, field_preference=None):
926 raise ExtractorError('No video formats found')
929 # Automatically determine tbr when missing based on abr and vbr (improves
930 # formats sorting in some cases)
931 if 'tbr' not in f and f.get('abr') is not None and f.get('vbr') is not None:
932 f['tbr'] = f['abr'] + f['vbr']
935 # TODO remove the following workaround
936 from ..utils import determine_ext
937 if not f.get('ext') and 'url' in f:
938 f['ext'] = determine_ext(f['url'])
940 if isinstance(field_preference, (list, tuple)):
943 if f.get(field) is not None
944 else ('' if field == 'format_id' else -1)
945 for field in field_preference)
947 preference = f.get('preference')
948 if preference is None:
950 if f.get('ext') in ['f4f', 'f4m']: # Not yet supported
953 protocol = f.get('protocol') or determine_protocol(f)
954 proto_preference = 0 if protocol in ['http', 'https'] else (-0.5 if protocol == 'rtsp' else -0.1)
956 if f.get('vcodec') == 'none': # audio only
958 if self._downloader.params.get('prefer_free_formats'):
959 ORDER = ['aac', 'mp3', 'm4a', 'webm', 'ogg', 'opus']
961 ORDER = ['webm', 'opus', 'ogg', 'mp3', 'aac', 'm4a']
964 audio_ext_preference = ORDER.index(f['ext'])
966 audio_ext_preference = -1
968 if f.get('acodec') == 'none': # video only
970 if self._downloader.params.get('prefer_free_formats'):
971 ORDER = ['flv', 'mp4', 'webm']
973 ORDER = ['webm', 'flv', 'mp4']
975 ext_preference = ORDER.index(f['ext'])
978 audio_ext_preference = 0
982 f.get('language_preference') if f.get('language_preference') is not None else -1,
983 f.get('quality') if f.get('quality') is not None else -1,
984 f.get('tbr') if f.get('tbr') is not None else -1,
985 f.get('filesize') if f.get('filesize') is not None else -1,
986 f.get('vbr') if f.get('vbr') is not None else -1,
987 f.get('height') if f.get('height') is not None else -1,
988 f.get('width') if f.get('width') is not None else -1,
991 f.get('abr') if f.get('abr') is not None else -1,
992 audio_ext_preference,
993 f.get('fps') if f.get('fps') is not None else -1,
994 f.get('filesize_approx') if f.get('filesize_approx') is not None else -1,
995 f.get('source_preference') if f.get('source_preference') is not None else -1,
996 f.get('format_id') if f.get('format_id') is not None else '',
998 formats.sort(key=_formats_key)
1000 def _check_formats(self, formats, video_id):
1002 formats[:] = filter(
1003 lambda f: self._is_valid_url(
1005 item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
1009 def _remove_duplicate_formats(formats):
1013 if f['url'] not in format_urls:
1014 format_urls.add(f['url'])
1015 unique_formats.append(f)
1016 formats[:] = unique_formats
1018 def _is_valid_url(self, url, video_id, item='video'):
1019 url = self._proto_relative_url(url, scheme='http:')
1020 # For now assume non HTTP(S) URLs always valid
1021 if not (url.startswith('http://') or url.startswith('https://')):
1024 self._request_webpage(url, video_id, 'Checking %s URL' % item)
1026 except ExtractorError as e:
1027 if isinstance(e.cause, compat_urllib_error.URLError):
1029 '%s: %s URL is invalid, skipping' % (video_id, item))
1033 def http_scheme(self):
1034 """ Either "http:" or "https:", depending on the user's preferences """
1037 if self._downloader.params.get('prefer_insecure', False)
1040 def _proto_relative_url(self, url, scheme=None):
1043 if url.startswith('//'):
1045 scheme = self.http_scheme()
1050 def _sleep(self, timeout, video_id, msg_template=None):
1051 if msg_template is None:
1052 msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
1053 msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1057 def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None,
1058 transform_source=lambda s: fix_xml_ampersands(s).strip(),
1059 fatal=True, m3u8_id=None):
1060 manifest = self._download_xml(
1061 manifest_url, video_id, 'Downloading f4m manifest',
1062 'Unable to download f4m manifest',
1063 # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
1064 # (see https://github.com/rg3/youtube-dl/issues/6215#issuecomment-121704244)
1065 transform_source=transform_source,
1068 if manifest is False:
1071 return self._parse_f4m_formats(
1072 manifest, manifest_url, video_id, preference=preference, f4m_id=f4m_id,
1073 transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
1075 def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, f4m_id=None,
1076 transform_source=lambda s: fix_xml_ampersands(s).strip(),
1077 fatal=True, m3u8_id=None):
1078 # currently youtube-dl cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
1079 akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1080 if akamai_pv is not None and ';' in akamai_pv.text:
1081 playerVerificationChallenge = akamai_pv.text.split(';')[0]
1082 if playerVerificationChallenge.strip() != '':
1086 manifest_version = '1.0'
1087 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
1089 manifest_version = '2.0'
1090 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
1091 # Remove unsupported DRM protected media from final formats
1092 # rendition (see https://github.com/rg3/youtube-dl/issues/8573).
1093 media_nodes = remove_encrypted_media(media_nodes)
1096 base_url = xpath_text(
1097 manifest, ['{http://ns.adobe.com/f4m/1.0}baseURL', '{http://ns.adobe.com/f4m/2.0}baseURL'],
1098 'base URL', default=None)
1100 base_url = base_url.strip()
1102 bootstrap_info = xpath_element(
1103 manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1104 'bootstrap info', default=None)
1107 mime_type = xpath_text(
1108 manifest, ['{http://ns.adobe.com/f4m/1.0}mimeType', '{http://ns.adobe.com/f4m/2.0}mimeType'],
1109 'base URL', default=None)
1110 if mime_type and mime_type.startswith('audio/'):
1113 for i, media_el in enumerate(media_nodes):
1114 tbr = int_or_none(media_el.attrib.get('bitrate'))
1115 width = int_or_none(media_el.attrib.get('width'))
1116 height = int_or_none(media_el.attrib.get('height'))
1117 format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
1118 # If <bootstrapInfo> is present, the specified f4m is a
1119 # stream-level manifest, and only set-level manifests may refer to
1120 # external resources. See section 11.4 and section 4 of F4M spec
1121 if bootstrap_info is None:
1123 # @href is introduced in 2.0, see section 11.6 of F4M spec
1124 if manifest_version == '2.0':
1125 media_url = media_el.attrib.get('href')
1126 if media_url is None:
1127 media_url = media_el.attrib.get('url')
1131 media_url if media_url.startswith('http://') or media_url.startswith('https://')
1132 else ((base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
1133 # If media_url is itself a f4m manifest do the recursive extraction
1134 # since bitrates in parent manifest (this one) and media_url manifest
1135 # may differ leading to inability to resolve the format by requested
1136 # bitrate in f4m downloader
1137 ext = determine_ext(manifest_url)
1139 f4m_formats = self._extract_f4m_formats(
1140 manifest_url, video_id, preference=preference, f4m_id=f4m_id,
1141 transform_source=transform_source, fatal=fatal)
1142 # Sometimes stream-level manifest contains single media entry that
1143 # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1144 # At the same time parent's media entry in set-level manifest may
1145 # contain it. We will copy it from parent in such cases.
1146 if len(f4m_formats) == 1:
1149 'tbr': f.get('tbr') or tbr,
1150 'width': f.get('width') or width,
1151 'height': f.get('height') or height,
1152 'format_id': f.get('format_id') if not tbr else format_id,
1155 formats.extend(f4m_formats)
1158 formats.extend(self._extract_m3u8_formats(
1159 manifest_url, video_id, 'mp4', preference=preference,
1160 m3u8_id=m3u8_id, fatal=fatal))
1163 'format_id': format_id,
1164 'url': manifest_url,
1165 'manifest_url': manifest_url,
1166 'ext': 'flv' if bootstrap_info is not None else None,
1171 'preference': preference,
1175 def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, m3u8_id=None):
1177 'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
1181 'preference': preference - 100 if preference else -100,
1182 'resolution': 'multiple',
1183 'format_note': 'Quality selection URL',
1186 def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
1187 entry_protocol='m3u8', preference=None,
1188 m3u8_id=None, note=None, errnote=None,
1189 fatal=True, live=False):
1191 res = self._download_webpage_handle(
1193 note=note or 'Downloading m3u8 information',
1194 errnote=errnote or 'Failed to download m3u8 information',
1198 m3u8_doc, urlh = res
1199 m3u8_url = urlh.geturl()
1201 formats = [self._m3u8_meta_format(m3u8_url, ext, preference, m3u8_id)]
1203 format_url = lambda u: (
1205 if re.match(r'^https?://', u)
1206 else compat_urlparse.urljoin(m3u8_url, u))
1208 # We should try extracting formats only from master playlists [1], i.e.
1209 # playlists that describe available qualities. On the other hand media
1210 # playlists [2] should be returned as is since they contain just the media
1211 # without qualities renditions.
1212 # Fortunately, master playlist can be easily distinguished from media
1213 # playlist based on particular tags availability. As of [1, 2] master
1214 # playlist tags MUST NOT appear in a media playist and vice versa.
1215 # As of [3] #EXT-X-TARGETDURATION tag is REQUIRED for every media playlist
1216 # and MUST NOT appear in master playlist thus we can clearly detect media
1217 # playlist with this criterion.
1218 # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.4
1219 # 2. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.3
1220 # 3. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.3.1
1221 if '#EXT-X-TARGETDURATION' in m3u8_doc: # media playlist, return as is
1224 'format_id': m3u8_id,
1226 'protocol': entry_protocol,
1227 'preference': preference,
1229 audio_in_video_stream = {}
1232 for line in m3u8_doc.splitlines():
1233 if line.startswith('#EXT-X-STREAM-INF:'):
1234 last_info = parse_m3u8_attributes(line)
1235 elif line.startswith('#EXT-X-MEDIA:'):
1236 media = parse_m3u8_attributes(line)
1237 media_type = media.get('TYPE')
1238 if media_type in ('VIDEO', 'AUDIO'):
1239 group_id = media.get('GROUP-ID')
1240 media_url = media.get('URI')
1243 for v in (group_id, media.get('NAME')):
1247 'format_id': '-'.join(format_id),
1248 'url': format_url(media_url),
1249 'language': media.get('LANGUAGE'),
1251 'protocol': entry_protocol,
1252 'preference': preference,
1254 if media_type == 'AUDIO':
1255 f['vcodec'] = 'none'
1256 if group_id and not audio_in_video_stream.get(group_id):
1257 audio_in_video_stream[group_id] = False
1260 # When there is no URI in EXT-X-MEDIA let this tag's
1261 # data be used by regular URI lines below
1263 if media_type == 'AUDIO' and group_id:
1264 audio_in_video_stream[group_id] = True
1265 elif line.startswith('#') or not line.strip():
1268 tbr = int_or_none(last_info.get('AVERAGE-BANDWIDTH') or last_info.get('BANDWIDTH'), scale=1000)
1271 format_id.append(m3u8_id)
1272 # Despite specification does not mention NAME attribute for
1273 # EXT-X-STREAM-INF it still sometimes may be present
1274 stream_name = last_info.get('NAME') or last_media.get('NAME')
1275 # Bandwidth of live streams may differ over time thus making
1276 # format_id unpredictable. So it's better to keep provided
1279 format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
1280 manifest_url = format_url(line.strip())
1282 'format_id': '-'.join(format_id),
1283 'url': manifest_url,
1284 'manifest_url': manifest_url,
1287 'fps': float_or_none(last_info.get('FRAME-RATE')),
1288 'protocol': entry_protocol,
1289 'preference': preference,
1291 resolution = last_info.get('RESOLUTION')
1293 mobj = re.search(r'(?P<width>\d+)[xX](?P<height>\d+)', resolution)
1295 f['width'] = int(mobj.group('width'))
1296 f['height'] = int(mobj.group('height'))
1297 # Unified Streaming Platform
1299 r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
1301 abr, vbr = mobj.groups()
1302 abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
1307 f.update(parse_codecs(last_info.get('CODECS')))
1308 if audio_in_video_stream.get(last_info.get('AUDIO')) is False:
1309 # TODO: update acodec for for audio only formats with the same GROUP-ID
1310 f['acodec'] = 'none'
1317 def _xpath_ns(path, namespace=None):
1321 for c in path.split('/'):
1322 if not c or c == '.':
1325 out.append('{%s}%s' % (namespace, c))
1326 return '/'.join(out)
1328 def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
1329 smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
1335 namespace = self._parse_smil_namespace(smil)
1337 return self._parse_smil_formats(
1338 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1340 def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
1341 smil = self._download_smil(smil_url, video_id, fatal=fatal)
1344 return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
1346 def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
1347 return self._download_xml(
1348 smil_url, video_id, 'Downloading SMIL file',
1349 'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
1351 def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
1352 namespace = self._parse_smil_namespace(smil)
1354 formats = self._parse_smil_formats(
1355 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
1356 subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
1358 video_id = os.path.splitext(url_basename(smil_url))[0]
1362 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1363 name = meta.attrib.get('name')
1364 content = meta.attrib.get('content')
1365 if not name or not content:
1367 if not title and name == 'title':
1369 elif not description and name in ('description', 'abstract'):
1370 description = content
1371 elif not upload_date and name == 'date':
1372 upload_date = unified_strdate(content)
1375 'id': image.get('type'),
1376 'url': image.get('src'),
1377 'width': int_or_none(image.get('width')),
1378 'height': int_or_none(image.get('height')),
1379 } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
1383 'title': title or video_id,
1384 'description': description,
1385 'upload_date': upload_date,
1386 'thumbnails': thumbnails,
1388 'subtitles': subtitles,
1391 def _parse_smil_namespace(self, smil):
1392 return self._search_regex(
1393 r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
1395 def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
1397 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
1398 b = meta.get('base') or meta.get('httpBase')
1409 media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
1410 for medium in media:
1411 src = medium.get('src')
1412 if not src or src in srcs:
1416 bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
1417 filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
1418 width = int_or_none(medium.get('width'))
1419 height = int_or_none(medium.get('height'))
1420 proto = medium.get('proto')
1421 ext = medium.get('ext')
1422 src_ext = determine_ext(src)
1423 streamer = medium.get('streamer') or base
1425 if proto == 'rtmp' or streamer.startswith('rtmp'):
1431 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
1433 'filesize': filesize,
1437 if transform_rtmp_url:
1438 streamer, src = transform_rtmp_url(streamer, src)
1439 formats[-1].update({
1445 src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
1446 src_url = src_url.strip()
1448 if proto == 'm3u8' or src_ext == 'm3u8':
1449 m3u8_formats = self._extract_m3u8_formats(
1450 src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
1451 if len(m3u8_formats) == 1:
1453 m3u8_formats[0].update({
1454 'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
1459 formats.extend(m3u8_formats)
1462 if src_ext == 'f4m':
1467 'plugin': 'flowplayer-3.2.0.1',
1469 f4m_url += '&' if '?' in f4m_url else '?'
1470 f4m_url += compat_urllib_parse_urlencode(f4m_params)
1471 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
1474 if src_url.startswith('http') and self._is_valid_url(src, video_id):
1478 'ext': ext or src_ext or 'flv',
1479 'format_id': 'http-%d' % (bitrate or http_count),
1481 'filesize': filesize,
1489 def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
1492 for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
1493 src = textstream.get('src')
1494 if not src or src in urls:
1497 ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
1498 lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
1499 subtitles.setdefault(lang, []).append({
1505 def _extract_xspf_playlist(self, playlist_url, playlist_id, fatal=True):
1506 xspf = self._download_xml(
1507 playlist_url, playlist_id, 'Downloading xpsf playlist',
1508 'Unable to download xspf manifest', fatal=fatal)
1511 return self._parse_xspf(xspf, playlist_id)
1513 def _parse_xspf(self, playlist, playlist_id):
1515 'xspf': 'http://xspf.org/ns/0/',
1516 's1': 'http://static.streamone.nl/player/ns/0',
1520 for track in playlist.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
1522 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
1523 description = xpath_text(
1524 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
1525 thumbnail = xpath_text(
1526 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
1527 duration = float_or_none(
1528 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
1531 'url': location.text,
1532 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
1533 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
1534 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
1535 } for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP))]
1536 self._sort_formats(formats)
1541 'description': description,
1542 'thumbnail': thumbnail,
1543 'duration': duration,
1548 def _extract_mpd_formats(self, mpd_url, video_id, mpd_id=None, note=None, errnote=None, fatal=True, formats_dict={}):
1549 res = self._download_webpage_handle(
1551 note=note or 'Downloading MPD manifest',
1552 errnote=errnote or 'Failed to download MPD manifest',
1557 mpd_base_url = base_url(urlh.geturl())
1559 return self._parse_mpd_formats(
1560 compat_etree_fromstring(mpd.encode('utf-8')), mpd_id, mpd_base_url,
1561 formats_dict=formats_dict, mpd_url=mpd_url)
1563 def _parse_mpd_formats(self, mpd_doc, mpd_id=None, mpd_base_url='', formats_dict={}, mpd_url=None):
1565 Parse formats from MPD manifest.
1567 1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
1568 http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
1569 2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
1571 if mpd_doc.get('type') == 'dynamic':
1574 namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
1577 return self._xpath_ns(path, namespace)
1579 def is_drm_protected(element):
1580 return element.find(_add_ns('ContentProtection')) is not None
1582 def extract_multisegment_info(element, ms_parent_info):
1583 ms_info = ms_parent_info.copy()
1585 # As per [1, 5.3.9.2.2] SegmentList and SegmentTemplate share some
1586 # common attributes and elements. We will only extract relevant
1588 def extract_common(source):
1589 segment_timeline = source.find(_add_ns('SegmentTimeline'))
1590 if segment_timeline is not None:
1591 s_e = segment_timeline.findall(_add_ns('S'))
1593 ms_info['total_number'] = 0
1596 r = int(s.get('r', 0))
1597 ms_info['total_number'] += 1 + r
1598 ms_info['s'].append({
1599 't': int(s.get('t', 0)),
1600 # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
1601 'd': int(s.attrib['d']),
1604 start_number = source.get('startNumber')
1606 ms_info['start_number'] = int(start_number)
1607 timescale = source.get('timescale')
1609 ms_info['timescale'] = int(timescale)
1610 segment_duration = source.get('duration')
1611 if segment_duration:
1612 ms_info['segment_duration'] = int(segment_duration)
1614 def extract_Initialization(source):
1615 initialization = source.find(_add_ns('Initialization'))
1616 if initialization is not None:
1617 ms_info['initialization_url'] = initialization.attrib['sourceURL']
1619 segment_list = element.find(_add_ns('SegmentList'))
1620 if segment_list is not None:
1621 extract_common(segment_list)
1622 extract_Initialization(segment_list)
1623 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
1625 ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
1627 segment_template = element.find(_add_ns('SegmentTemplate'))
1628 if segment_template is not None:
1629 extract_common(segment_template)
1630 media_template = segment_template.get('media')
1632 ms_info['media_template'] = media_template
1633 initialization = segment_template.get('initialization')
1635 ms_info['initialization_url'] = initialization
1637 extract_Initialization(segment_template)
1640 mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
1642 for period in mpd_doc.findall(_add_ns('Period')):
1643 period_duration = parse_duration(period.get('duration')) or mpd_duration
1644 period_ms_info = extract_multisegment_info(period, {
1648 for adaptation_set in period.findall(_add_ns('AdaptationSet')):
1649 if is_drm_protected(adaptation_set):
1651 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
1652 for representation in adaptation_set.findall(_add_ns('Representation')):
1653 if is_drm_protected(representation):
1655 representation_attrib = adaptation_set.attrib.copy()
1656 representation_attrib.update(representation.attrib)
1657 # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
1658 mime_type = representation_attrib['mimeType']
1659 content_type = mime_type.split('/')[0]
1660 if content_type == 'text':
1661 # TODO implement WebVTT downloading
1663 elif content_type == 'video' or content_type == 'audio':
1665 for element in (representation, adaptation_set, period, mpd_doc):
1666 base_url_e = element.find(_add_ns('BaseURL'))
1667 if base_url_e is not None:
1668 base_url = base_url_e.text + base_url
1669 if re.match(r'^https?://', base_url):
1671 if mpd_base_url and not re.match(r'^https?://', base_url):
1672 if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
1674 base_url = mpd_base_url + base_url
1675 representation_id = representation_attrib.get('id')
1676 lang = representation_attrib.get('lang')
1677 url_el = representation.find(_add_ns('BaseURL'))
1678 filesize = int_or_none(url_el.attrib.get('{http://youtube.com/yt/2012/10/10}contentLength') if url_el is not None else None)
1680 'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
1682 'manifest_url': mpd_url,
1683 'ext': mimetype2ext(mime_type),
1684 'width': int_or_none(representation_attrib.get('width')),
1685 'height': int_or_none(representation_attrib.get('height')),
1686 'tbr': int_or_none(representation_attrib.get('bandwidth'), 1000),
1687 'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
1688 'fps': int_or_none(representation_attrib.get('frameRate')),
1689 'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
1690 'format_note': 'DASH %s' % content_type,
1691 'filesize': filesize,
1693 f.update(parse_codecs(representation_attrib.get('codecs')))
1694 representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
1695 if 'segment_urls' not in representation_ms_info and 'media_template' in representation_ms_info:
1697 media_template = representation_ms_info['media_template']
1698 media_template = media_template.replace('$RepresentationID$', representation_id)
1699 media_template = re.sub(r'\$(Number|Bandwidth|Time)\$', r'%(\1)d', media_template)
1700 media_template = re.sub(r'\$(Number|Bandwidth|Time)%([^$]+)\$', r'%(\1)\2', media_template)
1701 media_template.replace('$$', '$')
1703 # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
1704 # can't be used at the same time
1705 if '%(Number' in media_template and 's' not in representation_ms_info:
1706 segment_duration = None
1707 if 'total_number' not in representation_ms_info and 'segment_duration':
1708 segment_duration = float_or_none(representation_ms_info['segment_duration'], representation_ms_info['timescale'])
1709 representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
1710 representation_ms_info['fragments'] = [{
1711 'url': media_template % {
1712 'Number': segment_number,
1713 'Bandwidth': int_or_none(representation_attrib.get('bandwidth')),
1715 'duration': segment_duration,
1716 } for segment_number in range(
1717 representation_ms_info['start_number'],
1718 representation_ms_info['total_number'] + representation_ms_info['start_number'])]
1720 # $Number*$ or $Time$ in media template with S list available
1721 # Example $Number*$: http://www.svtplay.se/klipp/9023742/stopptid-om-bjorn-borg
1722 # Example $Time$: https://play.arkena.com/embed/avp/v2/player/media/b41dda37-d8e7-4d3f-b1b5-9a9db578bdfe/1/129411
1723 representation_ms_info['fragments'] = []
1726 segment_number = representation_ms_info['start_number']
1728 def add_segment_url():
1729 segment_url = media_template % {
1730 'Time': segment_time,
1731 'Bandwidth': int_or_none(representation_attrib.get('bandwidth')),
1732 'Number': segment_number,
1734 representation_ms_info['fragments'].append({
1736 'duration': float_or_none(segment_d, representation_ms_info['timescale']),
1739 for num, s in enumerate(representation_ms_info['s']):
1740 segment_time = s.get('t') or segment_time
1744 for r in range(s.get('r', 0)):
1745 segment_time += segment_d
1748 segment_time += segment_d
1749 elif 'segment_urls' in representation_ms_info and 's' in representation_ms_info:
1751 # Example: https://www.youtube.com/watch?v=iXZV5uAYMJI
1752 # or any YouTube dashsegments video
1755 for segment_url in representation_ms_info['segment_urls']:
1756 s = representation_ms_info['s'][s_num]
1757 for r in range(s.get('r', 0) + 1):
1760 'duration': float_or_none(s['d'], representation_ms_info['timescale']),
1762 representation_ms_info['fragments'] = fragments
1763 # NB: MPD manifest may contain direct URLs to unfragmented media.
1764 # No fragments key is present in this case.
1765 if 'fragments' in representation_ms_info:
1768 'protocol': 'http_dash_segments',
1770 if 'initialization_url' in representation_ms_info:
1771 initialization_url = representation_ms_info['initialization_url'].replace('$RepresentationID$', representation_id)
1772 if not f.get('url'):
1773 f['url'] = initialization_url
1774 f['fragments'].append({'url': initialization_url})
1775 f['fragments'].extend(representation_ms_info['fragments'])
1776 for fragment in f['fragments']:
1777 fragment['url'] = urljoin(base_url, fragment['url'])
1779 existing_format = next(
1780 fo for fo in formats
1781 if fo['format_id'] == representation_id)
1782 except StopIteration:
1783 full_info = formats_dict.get(representation_id, {}).copy()
1785 formats.append(full_info)
1787 existing_format.update(f)
1789 self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
1792 def _extract_ism_formats(self, ism_url, video_id, ism_id=None, note=None, errnote=None, fatal=True):
1793 res = self._download_webpage_handle(
1795 note=note or 'Downloading ISM manifest',
1796 errnote=errnote or 'Failed to download ISM manifest',
1802 return self._parse_ism_formats(
1803 compat_etree_fromstring(ism.encode('utf-8')), urlh.geturl(), ism_id)
1805 def _parse_ism_formats(self, ism_doc, ism_url, ism_id=None):
1806 if ism_doc.get('IsLive') == 'TRUE' or ism_doc.find('Protection') is not None:
1809 duration = int(ism_doc.attrib['Duration'])
1810 timescale = int_or_none(ism_doc.get('TimeScale')) or 10000000
1813 for stream in ism_doc.findall('StreamIndex'):
1814 stream_type = stream.get('Type')
1815 if stream_type not in ('video', 'audio'):
1817 url_pattern = stream.attrib['Url']
1818 stream_timescale = int_or_none(stream.get('TimeScale')) or timescale
1819 stream_name = stream.get('Name')
1820 for track in stream.findall('QualityLevel'):
1821 fourcc = track.get('FourCC')
1822 # TODO: add support for WVC1 and WMAP
1823 if fourcc not in ('H264', 'AVC1', 'AACL'):
1824 self.report_warning('%s is not a supported codec' % fourcc)
1826 tbr = int(track.attrib['Bitrate']) // 1000
1827 width = int_or_none(track.get('MaxWidth'))
1828 height = int_or_none(track.get('MaxHeight'))
1829 sampling_rate = int_or_none(track.get('SamplingRate'))
1831 track_url_pattern = re.sub(r'{[Bb]itrate}', track.attrib['Bitrate'], url_pattern)
1832 track_url_pattern = compat_urlparse.urljoin(ism_url, track_url_pattern)
1838 stream_fragments = stream.findall('c')
1839 for stream_fragment_index, stream_fragment in enumerate(stream_fragments):
1840 fragment_ctx['time'] = int_or_none(stream_fragment.get('t')) or fragment_ctx['time']
1841 fragment_repeat = int_or_none(stream_fragment.get('r')) or 1
1842 fragment_ctx['duration'] = int_or_none(stream_fragment.get('d'))
1843 if not fragment_ctx['duration']:
1845 next_fragment_time = int(stream_fragment[stream_fragment_index + 1].attrib['t'])
1847 next_fragment_time = duration
1848 fragment_ctx['duration'] = (next_fragment_time - fragment_ctx['time']) / fragment_repeat
1849 for _ in range(fragment_repeat):
1851 'url': re.sub(r'{start[ _]time}', compat_str(fragment_ctx['time']), track_url_pattern),
1852 'duration': fragment_ctx['duration'] / stream_timescale,
1854 fragment_ctx['time'] += fragment_ctx['duration']
1858 format_id.append(ism_id)
1860 format_id.append(stream_name)
1861 format_id.append(compat_str(tbr))
1864 'format_id': '-'.join(format_id),
1866 'manifest_url': ism_url,
1867 'ext': 'ismv' if stream_type == 'video' else 'isma',
1871 'asr': sampling_rate,
1872 'vcodec': 'none' if stream_type == 'audio' else fourcc,
1873 'acodec': 'none' if stream_type == 'video' else fourcc,
1875 'fragments': fragments,
1876 '_download_params': {
1877 'duration': duration,
1878 'timescale': stream_timescale,
1879 'width': width or 0,
1880 'height': height or 0,
1882 'codec_private_data': track.get('CodecPrivateData'),
1883 'sampling_rate': sampling_rate,
1884 'channels': int_or_none(track.get('Channels', 2)),
1885 'bits_per_sample': int_or_none(track.get('BitsPerSample', 16)),
1886 'nal_unit_length_field': int_or_none(track.get('NALUnitLengthField', 4)),
1891 def _parse_html5_media_entries(self, base_url, webpage, video_id, m3u8_id=None, m3u8_entry_protocol='m3u8', mpd_id=None):
1892 def absolute_url(video_url):
1893 return compat_urlparse.urljoin(base_url, video_url)
1895 def parse_content_type(content_type):
1896 if not content_type:
1898 ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
1900 mimetype, codecs = ctr.groups()
1901 f = parse_codecs(codecs)
1902 f['ext'] = mimetype2ext(mimetype)
1906 def _media_formats(src, cur_media_type):
1907 full_url = absolute_url(src)
1908 ext = determine_ext(full_url)
1910 is_plain_url = False
1911 formats = self._extract_m3u8_formats(
1912 full_url, video_id, ext='mp4',
1913 entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id)
1915 is_plain_url = False
1916 formats = self._extract_mpd_formats(
1917 full_url, video_id, mpd_id=mpd_id)
1922 'vcodec': 'none' if cur_media_type == 'audio' else None,
1924 return is_plain_url, formats
1927 media_tags = [(media_tag, media_type, '')
1928 for media_tag, media_type
1929 in re.findall(r'(?s)(<(video|audio)[^>]*/>)', webpage)]
1930 media_tags.extend(re.findall(r'(?s)(<(?P<tag>video|audio)[^>]*>)(.*?)</(?P=tag)>', webpage))
1931 for media_tag, media_type, media_content in media_tags:
1936 media_attributes = extract_attributes(media_tag)
1937 src = media_attributes.get('src')
1939 _, formats = _media_formats(src, media_type)
1940 media_info['formats'].extend(formats)
1941 media_info['thumbnail'] = media_attributes.get('poster')
1943 for source_tag in re.findall(r'<source[^>]+>', media_content):
1944 source_attributes = extract_attributes(source_tag)
1945 src = source_attributes.get('src')
1948 is_plain_url, formats = _media_formats(src, media_type)
1950 f = parse_content_type(source_attributes.get('type'))
1951 f.update(formats[0])
1952 media_info['formats'].append(f)
1954 media_info['formats'].extend(formats)
1955 for track_tag in re.findall(r'<track[^>]+>', media_content):
1956 track_attributes = extract_attributes(track_tag)
1957 kind = track_attributes.get('kind')
1958 if not kind or kind in ('subtitles', 'captions'):
1959 src = track_attributes.get('src')
1962 lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
1963 media_info['subtitles'].setdefault(lang, []).append({
1964 'url': absolute_url(src),
1966 if media_info['formats'] or media_info['subtitles']:
1967 entries.append(media_info)
1970 def _extract_akamai_formats(self, manifest_url, video_id, hosts={}):
1972 hdcore_sign = 'hdcore=3.7.0'
1973 f4m_url = re.sub(r'(https?://[^/+])/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
1974 hds_host = hosts.get('hds')
1976 f4m_url = re.sub(r'(https?://)[^/]+', r'\1' + hds_host, f4m_url)
1977 if 'hdcore=' not in f4m_url:
1978 f4m_url += ('&' if '?' in f4m_url else '?') + hdcore_sign
1979 f4m_formats = self._extract_f4m_formats(
1980 f4m_url, video_id, f4m_id='hds', fatal=False)
1981 for entry in f4m_formats:
1982 entry.update({'extra_param_to_segment_url': hdcore_sign})
1983 formats.extend(f4m_formats)
1984 m3u8_url = re.sub(r'(https?://[^/]+)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
1985 hls_host = hosts.get('hls')
1987 m3u8_url = re.sub(r'(https?://)[^/]+', r'\1' + hls_host, m3u8_url)
1988 formats.extend(self._extract_m3u8_formats(
1989 m3u8_url, video_id, 'mp4', 'm3u8_native',
1990 m3u8_id='hls', fatal=False))
1993 def _extract_wowza_formats(self, url, video_id, m3u8_entry_protocol='m3u8_native', skip_protocols=[]):
1994 url = re.sub(r'/(?:manifest|playlist|jwplayer)\.(?:m3u8|f4m|mpd|smil)', '', url)
1995 url_base = self._search_regex(r'(?:https?|rtmp|rtsp)(://[^?]+)', url, 'format url')
1996 http_base_url = 'http' + url_base
1998 if 'm3u8' not in skip_protocols:
1999 formats.extend(self._extract_m3u8_formats(
2000 http_base_url + '/playlist.m3u8', video_id, 'mp4',
2001 m3u8_entry_protocol, m3u8_id='hls', fatal=False))
2002 if 'f4m' not in skip_protocols:
2003 formats.extend(self._extract_f4m_formats(
2004 http_base_url + '/manifest.f4m',
2005 video_id, f4m_id='hds', fatal=False))
2006 if 'dash' not in skip_protocols:
2007 formats.extend(self._extract_mpd_formats(
2008 http_base_url + '/manifest.mpd',
2009 video_id, mpd_id='dash', fatal=False))
2010 if re.search(r'(?:/smil:|\.smil)', url_base):
2011 if 'smil' not in skip_protocols:
2012 rtmp_formats = self._extract_smil_formats(
2013 http_base_url + '/jwplayer.smil',
2014 video_id, fatal=False)
2015 for rtmp_format in rtmp_formats:
2016 rtsp_format = rtmp_format.copy()
2017 rtsp_format['url'] = '%s/%s' % (rtmp_format['url'], rtmp_format['play_path'])
2018 del rtsp_format['play_path']
2019 del rtsp_format['ext']
2020 rtsp_format.update({
2021 'url': rtsp_format['url'].replace('rtmp://', 'rtsp://'),
2022 'format_id': rtmp_format['format_id'].replace('rtmp', 'rtsp'),
2025 formats.extend([rtmp_format, rtsp_format])
2027 for protocol in ('rtmp', 'rtsp'):
2028 if protocol not in skip_protocols:
2030 'url': protocol + url_base,
2031 'format_id': protocol,
2032 'protocol': protocol,
2036 def _live_title(self, name):
2037 """ Generate the title for a live video """
2038 now = datetime.datetime.now()
2039 now_str = now.strftime('%Y-%m-%d %H:%M')
2040 return name + ' ' + now_str
2042 def _int(self, v, name, fatal=False, **kwargs):
2043 res = int_or_none(v, **kwargs)
2044 if 'get_attr' in kwargs:
2045 print(getattr(v, kwargs['get_attr']))
2047 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
2049 raise ExtractorError(msg)
2051 self._downloader.report_warning(msg)
2054 def _float(self, v, name, fatal=False, **kwargs):
2055 res = float_or_none(v, **kwargs)
2057 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
2059 raise ExtractorError(msg)
2061 self._downloader.report_warning(msg)
2064 def _set_cookie(self, domain, name, value, expire_time=None):
2065 cookie = compat_cookiejar.Cookie(
2066 0, name, value, None, None, domain, None,
2067 None, '/', True, False, expire_time, '', None, None, None)
2068 self._downloader.cookiejar.set_cookie(cookie)
2070 def _get_cookies(self, url):
2071 """ Return a compat_cookies.SimpleCookie with the cookies for the url """
2072 req = sanitized_Request(url)
2073 self._downloader.cookiejar.add_cookie_header(req)
2074 return compat_cookies.SimpleCookie(req.get_header('Cookie'))
2076 def get_testcases(self, include_onlymatching=False):
2077 t = getattr(self, '_TEST', None)
2079 assert not hasattr(self, '_TESTS'), \
2080 '%s has _TEST and _TESTS' % type(self).__name__
2083 tests = getattr(self, '_TESTS', [])
2085 if not include_onlymatching and t.get('only_matching', False):
2087 t['name'] = type(self).__name__[:-len('IE')]
2090 def is_suitable(self, age_limit):
2091 """ Test whether the extractor is generally suitable for the given
2092 age limit (i.e. pornographic sites are not, all others usually are) """
2094 any_restricted = False
2095 for tc in self.get_testcases(include_onlymatching=False):
2096 if tc.get('playlist', []):
2097 tc = tc['playlist'][0]
2098 is_restricted = age_restricted(
2099 tc.get('info_dict', {}).get('age_limit'), age_limit)
2100 if not is_restricted:
2102 any_restricted = any_restricted or is_restricted
2103 return not any_restricted
2105 def extract_subtitles(self, *args, **kwargs):
2106 if (self._downloader.params.get('writesubtitles', False) or
2107 self._downloader.params.get('listsubtitles')):
2108 return self._get_subtitles(*args, **kwargs)
2111 def _get_subtitles(self, *args, **kwargs):
2112 raise NotImplementedError('This method must be implemented by subclasses')
2115 def _merge_subtitle_items(subtitle_list1, subtitle_list2):
2116 """ Merge subtitle items for one language. Items with duplicated URLs
2117 will be dropped. """
2118 list1_urls = set([item['url'] for item in subtitle_list1])
2119 ret = list(subtitle_list1)
2120 ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
2124 def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2):
2125 """ Merge two subtitle dictionaries, language by language. """
2126 ret = dict(subtitle_dict1)
2127 for lang in subtitle_dict2:
2128 ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang])
2131 def extract_automatic_captions(self, *args, **kwargs):
2132 if (self._downloader.params.get('writeautomaticsub', False) or
2133 self._downloader.params.get('listsubtitles')):
2134 return self._get_automatic_captions(*args, **kwargs)
2137 def _get_automatic_captions(self, *args, **kwargs):
2138 raise NotImplementedError('This method must be implemented by subclasses')
2140 def mark_watched(self, *args, **kwargs):
2141 if (self._downloader.params.get('mark_watched', False) and
2142 (self._get_login_info()[0] is not None or
2143 self._downloader.params.get('cookiefile') is not None)):
2144 self._mark_watched(*args, **kwargs)
2146 def _mark_watched(self, *args, **kwargs):
2147 raise NotImplementedError('This method must be implemented by subclasses')
2149 def geo_verification_headers(self):
2151 geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
2152 if geo_verification_proxy:
2153 headers['Ytdl-request-proxy'] = geo_verification_proxy
2156 def _generic_id(self, url):
2157 return compat_urllib_parse_unquote(os.path.splitext(url.rstrip('/').split('/')[-1])[0])
2159 def _generic_title(self, url):
2160 return compat_urllib_parse_unquote(os.path.splitext(url_basename(url))[0])
2163 class SearchInfoExtractor(InfoExtractor):
2165 Base class for paged search queries extractors.
2166 They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
2167 Instances should define _SEARCH_KEY and _MAX_RESULTS.
2171 def _make_valid_url(cls):
2172 return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
2175 def suitable(cls, url):
2176 return re.match(cls._make_valid_url(), url) is not None
2178 def _real_extract(self, query):
2179 mobj = re.match(self._make_valid_url(), query)
2181 raise ExtractorError('Invalid search query "%s"' % query)
2183 prefix = mobj.group('prefix')
2184 query = mobj.group('query')
2186 return self._get_n_results(query, 1)
2187 elif prefix == 'all':
2188 return self._get_n_results(query, self._MAX_RESULTS)
2192 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
2193 elif n > self._MAX_RESULTS:
2194 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
2195 n = self._MAX_RESULTS
2196 return self._get_n_results(query, n)
2198 def _get_n_results(self, query, n):
2199 """Get a specified number of results for a query"""
2200 raise NotImplementedError('This method must be implemented by subclasses')
2203 def SEARCH_KEY(self):
2204 return self._SEARCH_KEY