1 from __future__ import unicode_literals
13 import xml.etree.ElementTree
15 from ..compat import (
20 compat_urllib_parse_urlparse,
35 _NO_DEFAULT = object()
38 class InfoExtractor(object):
39 """Information Extractor class.
41 Information extractors are the classes that, given a URL, extract
42 information about the video (or videos) the URL refers to. This
43 information includes the real video URL, the video title, author and
44 others. The information is stored in a dictionary which is then
45 passed to the YoutubeDL. The YoutubeDL processes this
46 information possibly downloading the video to the file system, among
47 other possible outcomes.
49 The type field determines the the type of the result.
50 By far the most common value (and the default if _type is missing) is
51 "video", which indicates a single video.
53 For a video, the dictionaries must include the following fields:
56 title: Video title, unescaped.
58 Additionally, it must contain either a formats entry or a url one:
60 formats: A list of dictionaries for each format available, ordered
61 from worst to best quality.
64 * url Mandatory. The URL of the video file
65 * ext Will be calculated from url if missing
66 * format A human-readable description of the format
67 ("mp4 container with h264/opus").
68 Calculated from the format_id, width, height.
69 and format_note fields if missing.
70 * format_id A short description of the format
71 ("mp4_h264_opus" or "19").
72 Technically optional, but strongly recommended.
73 * format_note Additional info about the format
74 ("3D" or "DASH video")
75 * width Width of the video, if known
76 * height Height of the video, if known
77 * resolution Textual description of width and height
78 * tbr Average bitrate of audio and video in KBit/s
79 * abr Average audio bitrate in KBit/s
80 * acodec Name of the audio codec in use
81 * asr Audio sampling rate in Hertz
82 * vbr Average video bitrate in KBit/s
84 * vcodec Name of the video codec in use
85 * container Name of the container format
86 * filesize The number of bytes, if known in advance
87 * filesize_approx An estimate for the number of bytes
88 * player_url SWF Player URL (used for rtmpdump).
89 * protocol The protocol that will be used for the actual
91 "http", "https", "rtsp", "rtmp", "rtmpe",
92 "m3u8", or "m3u8_native".
93 * preference Order number of this format. If this field is
94 present and not None, the formats get sorted
95 by this field, regardless of all other values.
96 -1 for default (order by other properties),
97 -2 or smaller for less than default.
98 < -1000 to hide the format (if there is
99 another one which is strictly better)
100 * language_preference Is this in the correct requested
102 10 if it's what the URL is about,
103 -1 for default (don't know),
104 -10 otherwise, other values reserved for now.
105 * quality Order number of the video quality of this
106 format, irrespective of the file format.
107 -1 for default (order by other properties),
108 -2 or smaller for less than default.
109 * source_preference Order number for this video source
110 (quality takes higher priority)
111 -1 for default (order by other properties),
112 -2 or smaller for less than default.
113 * http_method HTTP method to use for the download.
114 * http_headers A dictionary of additional HTTP headers
115 to add to the request.
116 * http_post_data Additional data to send with a POST
118 * stretched_ratio If given and not 1, indicates that the
119 video's pixels are not square.
120 width : height ratio as float.
121 * no_resume The server does not support resuming the
122 (HTTP or RTMP) download. Boolean.
124 url: Final video URL.
125 ext: Video filename extension.
126 format: The video format, defaults to ext (used for --get-format)
127 player_url: SWF Player URL (used for rtmpdump).
129 The following fields are optional:
131 alt_title: A secondary title of the video.
132 display_id An alternative identifier for the video, not necessarily
133 unique, but available before title. Typically, id is
134 something like "4234987", title "Dancing naked mole rats",
135 and display_id "dancing-naked-mole-rats"
136 thumbnails: A list of dictionaries, with the following entries:
137 * "id" (optional, string) - Thumbnail format ID
139 * "preference" (optional, int) - quality of the image
140 * "width" (optional, int)
141 * "height" (optional, int)
142 * "resolution" (optional, string "{width}x{height"},
144 thumbnail: Full URL to a video thumbnail image.
145 description: Full video description.
146 uploader: Full name of the video uploader.
147 creator: The main artist who created the video.
148 timestamp: UNIX timestamp of the moment the video became available.
149 upload_date: Video upload date (YYYYMMDD).
150 If not explicitly set, calculated from timestamp.
151 uploader_id: Nickname or id of the video uploader.
152 location: Physical location where the video was filmed.
153 subtitles: The available subtitles as a dictionary in the format
154 {language: subformats}. "subformats" is a list sorted from
155 lower to higher preference, each element is a dictionary
156 with the "ext" entry and one of:
157 * "data": The subtitles file contents
158 * "url": A url pointing to the subtitles file
159 automatic_captions: Like 'subtitles', used by the YoutubeIE for
160 automatically generated captions
161 duration: Length of the video in seconds, as an integer.
162 view_count: How many users have watched the video on the platform.
163 like_count: Number of positive ratings of the video
164 dislike_count: Number of negative ratings of the video
165 average_rating: Average rating give by users, the scale used depends on the webpage
166 comment_count: Number of comments on the video
167 comments: A list of comments, each with one or more of the following
168 properties (all but one of text or html optional):
169 * "author" - human-readable name of the comment author
170 * "author_id" - user ID of the comment author
172 * "html" - Comment as HTML
173 * "text" - Plain text of the comment
174 * "timestamp" - UNIX timestamp of comment
175 * "parent" - ID of the comment this one is replying to.
176 Set to "root" to indicate that this is a
177 comment to the original video.
178 age_limit: Age restriction for the video, as an integer (years)
179 webpage_url: The url to the video webpage, if given to youtube-dl it
180 should allow to get the same result again. (It will be set
181 by YoutubeDL if it's missing)
182 categories: A list of categories that the video falls in, for example
184 is_live: True, False, or None (=unknown). Whether this video is a
185 live stream that goes on instead of a fixed-length video.
187 Unless mentioned otherwise, the fields should be Unicode strings.
189 Unless mentioned otherwise, None is equivalent to absence of information.
192 _type "playlist" indicates multiple videos.
193 There must be a key "entries", which is a list, an iterable, or a PagedList
194 object, each element of which is a valid dictionary by this specification.
196 Additionally, playlists can have "title" and "id" attributes with the same
197 semantics as videos (see above).
200 _type "multi_video" indicates that there are multiple videos that
201 form a single show, for examples multiple acts of an opera or TV episode.
202 It must have an entries key like a playlist and contain all the keys
203 required for a video at the same time.
206 _type "url" indicates that the video must be extracted from another
207 location, possibly by a different extractor. Its only required key is:
208 "url" - the next URL to extract.
209 The key "ie_key" can be set to the class name (minus the trailing "IE",
210 e.g. "Youtube") if the extractor class is known in advance.
211 Additionally, the dictionary may have any properties of the resolved entity
212 known in advance, for example "title" if the title of the referred video is
216 _type "url_transparent" entities have the same specification as "url", but
217 indicate that the given additional information is more precise than the one
218 associated with the resolved URL.
219 This is useful when a site employs a video service that hosts the video and
220 its technical metadata, but that video service does not embed a useful
221 title, description etc.
224 Subclasses of this one should re-define the _real_initialize() and
225 _real_extract() methods and define a _VALID_URL regexp.
226 Probably, they should also be added to the list of extractors.
228 Finally, the _WORKING attribute should be set to False for broken IEs
229 in order to warn the users and skip the tests.
236 def __init__(self, downloader=None):
237 """Constructor. Receives an optional downloader."""
239 self.set_downloader(downloader)
242 def suitable(cls, url):
243 """Receives a URL and returns True if suitable for this IE."""
245 # This does not use has/getattr intentionally - we want to know whether
246 # we have cached the regexp for *this* class, whereas getattr would also
247 # match the superclass
248 if '_VALID_URL_RE' not in cls.__dict__:
249 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
250 return cls._VALID_URL_RE.match(url) is not None
253 def _match_id(cls, url):
254 if '_VALID_URL_RE' not in cls.__dict__:
255 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
256 m = cls._VALID_URL_RE.match(url)
262 """Getter method for _WORKING."""
265 def initialize(self):
266 """Initializes an instance (authentication, etc)."""
268 self._real_initialize()
271 def extract(self, url):
272 """Extracts URL information and returns it in list of dicts."""
275 return self._real_extract(url)
276 except ExtractorError:
278 except compat_http_client.IncompleteRead as e:
279 raise ExtractorError('A network error has occured.', cause=e, expected=True)
280 except (KeyError, StopIteration) as e:
281 raise ExtractorError('An extractor error has occured.', cause=e)
283 def set_downloader(self, downloader):
284 """Sets the downloader for this IE."""
285 self._downloader = downloader
287 def _real_initialize(self):
288 """Real initialization process. Redefine in subclasses."""
291 def _real_extract(self, url):
292 """Real extraction process. Redefine in subclasses."""
297 """A string for getting the InfoExtractor with get_info_extractor"""
298 return cls.__name__[:-2]
302 return type(self).__name__[:-2]
304 def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True):
305 """ Returns the response handle """
307 self.report_download_webpage(video_id)
308 elif note is not False:
310 self.to_screen('%s' % (note,))
312 self.to_screen('%s: %s' % (video_id, note))
314 return self._downloader.urlopen(url_or_request)
315 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
319 errnote = 'Unable to download webpage'
320 errmsg = '%s: %s' % (errnote, compat_str(err))
322 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
324 self._downloader.report_warning(errmsg)
327 def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True):
328 """ Returns a tuple (page content as string, URL handle) """
329 # Strip hashes from the URL (#1038)
330 if isinstance(url_or_request, (compat_str, str)):
331 url_or_request = url_or_request.partition('#')[0]
333 urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal)
337 content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal)
338 return (content, urlh)
340 def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None):
341 content_type = urlh.headers.get('Content-Type', '')
342 webpage_bytes = urlh.read()
343 if prefix is not None:
344 webpage_bytes = prefix + webpage_bytes
345 m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
347 encoding = m.group(1)
349 m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
350 webpage_bytes[:1024])
352 encoding = m.group(1).decode('ascii')
353 elif webpage_bytes.startswith(b'\xff\xfe'):
357 if self._downloader.params.get('dump_intermediate_pages', False):
359 url = url_or_request.get_full_url()
360 except AttributeError:
362 self.to_screen('Dumping request to ' + url)
363 dump = base64.b64encode(webpage_bytes).decode('ascii')
364 self._downloader.to_screen(dump)
365 if self._downloader.params.get('write_pages', False):
367 url = url_or_request.get_full_url()
368 except AttributeError:
370 basen = '%s_%s' % (video_id, url)
372 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
373 basen = basen[:240 - len(h)] + h
374 raw_filename = basen + '.dump'
375 filename = sanitize_filename(raw_filename, restricted=True)
376 self.to_screen('Saving request to ' + filename)
377 # Working around MAX_PATH limitation on Windows (see
378 # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
380 absfilepath = os.path.abspath(filename)
381 if len(absfilepath) > 259:
382 filename = '\\\\?\\' + absfilepath
383 with open(filename, 'wb') as outf:
384 outf.write(webpage_bytes)
387 content = webpage_bytes.decode(encoding, 'replace')
389 content = webpage_bytes.decode('utf-8', 'replace')
391 if ('<title>Access to this site is blocked</title>' in content and
392 'Websense' in content[:512]):
393 msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
394 blocked_iframe = self._html_search_regex(
395 r'<iframe src="([^"]+)"', content,
396 'Websense information URL', default=None)
398 msg += ' Visit %s for more details' % blocked_iframe
399 raise ExtractorError(msg, expected=True)
400 if '<title>The URL you requested has been blocked</title>' in content[:512]:
402 'Access to this webpage has been blocked by Indian censorship. '
403 'Use a VPN or proxy server (with --proxy) to route around it.')
404 block_msg = self._html_search_regex(
405 r'</h1><p>(.*?)</p>',
406 content, 'block message', default=None)
408 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
409 raise ExtractorError(msg, expected=True)
413 def _download_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, tries=1, timeout=5):
414 """ Returns the data of the page as a string """
417 while success is False:
419 res = self._download_webpage_handle(url_or_request, video_id, note, errnote, fatal)
421 except compat_http_client.IncompleteRead as e:
423 if try_count >= tries:
425 self._sleep(timeout, video_id)
432 def _download_xml(self, url_or_request, video_id,
433 note='Downloading XML', errnote='Unable to download XML',
434 transform_source=None, fatal=True):
435 """Return the xml as an xml.etree.ElementTree.Element"""
436 xml_string = self._download_webpage(
437 url_or_request, video_id, note, errnote, fatal=fatal)
438 if xml_string is False:
441 xml_string = transform_source(xml_string)
442 return xml.etree.ElementTree.fromstring(xml_string.encode('utf-8'))
444 def _download_json(self, url_or_request, video_id,
445 note='Downloading JSON metadata',
446 errnote='Unable to download JSON metadata',
447 transform_source=None,
449 json_string = self._download_webpage(
450 url_or_request, video_id, note, errnote, fatal=fatal)
451 if (not fatal) and json_string is False:
453 return self._parse_json(
454 json_string, video_id, transform_source=transform_source, fatal=fatal)
456 def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
458 json_string = transform_source(json_string)
460 return json.loads(json_string)
461 except ValueError as ve:
462 errmsg = '%s: Failed to parse JSON ' % video_id
464 raise ExtractorError(errmsg, cause=ve)
466 self.report_warning(errmsg + str(ve))
468 def report_warning(self, msg, video_id=None):
469 idstr = '' if video_id is None else '%s: ' % video_id
470 self._downloader.report_warning(
471 '[%s] %s%s' % (self.IE_NAME, idstr, msg))
473 def to_screen(self, msg):
474 """Print msg to screen, prefixing it with '[ie_name]'"""
475 self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
477 def report_extraction(self, id_or_name):
478 """Report information extraction."""
479 self.to_screen('%s: Extracting information' % id_or_name)
481 def report_download_webpage(self, video_id):
482 """Report webpage download."""
483 self.to_screen('%s: Downloading webpage' % video_id)
485 def report_age_confirmation(self):
486 """Report attempt to confirm age."""
487 self.to_screen('Confirming age')
489 def report_login(self):
490 """Report attempt to log in."""
491 self.to_screen('Logging in')
493 # Methods for following #608
495 def url_result(url, ie=None, video_id=None):
496 """Returns a url that points to a page that should be processed"""
497 # TODO: ie should be the class used for getting the info
498 video_info = {'_type': 'url',
501 if video_id is not None:
502 video_info['id'] = video_id
506 def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None):
507 """Returns a playlist"""
508 video_info = {'_type': 'playlist',
511 video_info['id'] = playlist_id
513 video_info['title'] = playlist_title
514 if playlist_description:
515 video_info['description'] = playlist_description
518 def _search_regex(self, pattern, string, name, default=_NO_DEFAULT, fatal=True, flags=0, group=None):
520 Perform a regex search on the given string, using a single or a list of
521 patterns returning the first matching group.
522 In case of failure return a default value or raise a WARNING or a
523 RegexNotFoundError, depending on fatal, specifying the field name.
525 if isinstance(pattern, (str, compat_str, compiled_regex_type)):
526 mobj = re.search(pattern, string, flags)
529 mobj = re.search(p, string, flags)
533 if not self._downloader.params.get('no_color') and os.name != 'nt' and sys.stderr.isatty():
534 _name = '\033[0;34m%s\033[0m' % name
540 # return the first matching group
541 return next(g for g in mobj.groups() if g is not None)
543 return mobj.group(group)
544 elif default is not _NO_DEFAULT:
547 raise RegexNotFoundError('Unable to extract %s' % _name)
549 self._downloader.report_warning('unable to extract %s; '
550 'please report this issue on http://yt-dl.org/bug' % _name)
553 def _html_search_regex(self, pattern, string, name, default=_NO_DEFAULT, fatal=True, flags=0, group=None):
555 Like _search_regex, but strips HTML tags and unescapes entities.
557 res = self._search_regex(pattern, string, name, default, fatal, flags, group)
559 return clean_html(res).strip()
563 def _get_login_info(self):
565 Get the the login info as (username, password)
566 It will look in the netrc file using the _NETRC_MACHINE value
567 If there's no info available, return (None, None)
569 if self._downloader is None:
574 downloader_params = self._downloader.params
576 # Attempt to use provided username and password or .netrc data
577 if downloader_params.get('username', None) is not None:
578 username = downloader_params['username']
579 password = downloader_params['password']
580 elif downloader_params.get('usenetrc', False):
582 info = netrc.netrc().authenticators(self._NETRC_MACHINE)
587 raise netrc.NetrcParseError('No authenticators for %s' % self._NETRC_MACHINE)
588 except (IOError, netrc.NetrcParseError) as err:
589 self._downloader.report_warning('parsing .netrc: %s' % compat_str(err))
591 return (username, password)
593 def _get_tfa_info(self):
595 Get the two-factor authentication info
596 TODO - asking the user will be required for sms/phone verify
597 currently just uses the command line option
598 If there's no info available, return None
600 if self._downloader is None:
602 downloader_params = self._downloader.params
604 if downloader_params.get('twofactor', None) is not None:
605 return downloader_params['twofactor']
609 # Helper functions for extracting OpenGraph info
611 def _og_regexes(prop):
612 content_re = r'content=(?:"([^>]+?)"|\'([^>]+?)\')'
613 property_re = r'(?:name|property)=[\'"]og:%s[\'"]' % re.escape(prop)
614 template = r'<meta[^>]+?%s[^>]+?%s'
616 template % (property_re, content_re),
617 template % (content_re, property_re),
620 def _og_search_property(self, prop, html, name=None, **kargs):
622 name = 'OpenGraph %s' % prop
623 escaped = self._search_regex(self._og_regexes(prop), html, name, flags=re.DOTALL, **kargs)
626 return unescapeHTML(escaped)
628 def _og_search_thumbnail(self, html, **kargs):
629 return self._og_search_property('image', html, 'thumbnail url', fatal=False, **kargs)
631 def _og_search_description(self, html, **kargs):
632 return self._og_search_property('description', html, fatal=False, **kargs)
634 def _og_search_title(self, html, **kargs):
635 return self._og_search_property('title', html, **kargs)
637 def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
638 regexes = self._og_regexes('video') + self._og_regexes('video:url')
640 regexes = self._og_regexes('video:secure_url') + regexes
641 return self._html_search_regex(regexes, html, name, **kargs)
643 def _og_search_url(self, html, **kargs):
644 return self._og_search_property('url', html, **kargs)
646 def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
647 if display_name is None:
649 return self._html_search_regex(
651 (?=[^>]+(?:itemprop|name|property)=(["\']?)%s\1)
652 [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(name),
653 html, display_name, fatal=fatal, group='content', **kwargs)
655 def _dc_search_uploader(self, html):
656 return self._html_search_meta('dc.creator', html, 'uploader')
658 def _rta_search(self, html):
659 # See http://www.rtalabel.org/index.php?content=howtofaq#single
660 if re.search(r'(?ix)<meta\s+name="rating"\s+'
661 r' content="RTA-5042-1996-1400-1577-RTA"',
666 def _media_rating_search(self, html):
667 # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
668 rating = self._html_search_meta('rating', html)
680 return RATING_TABLE.get(rating.lower(), None)
682 def _family_friendly_search(self, html):
683 # See http://schema.org/VideoObject
684 family_friendly = self._html_search_meta('isFamilyFriendly', html)
686 if not family_friendly:
695 return RATING_TABLE.get(family_friendly.lower(), None)
697 def _twitter_search_player(self, html):
698 return self._html_search_meta('twitter:player', html,
699 'twitter card player')
701 def _sort_formats(self, formats):
703 raise ExtractorError('No video formats found')
706 # TODO remove the following workaround
707 from ..utils import determine_ext
708 if not f.get('ext') and 'url' in f:
709 f['ext'] = determine_ext(f['url'])
711 preference = f.get('preference')
712 if preference is None:
713 proto = f.get('protocol')
715 proto = compat_urllib_parse_urlparse(f.get('url', '')).scheme
717 preference = 0 if proto in ['http', 'https'] else -0.1
718 if f.get('ext') in ['f4f', 'f4m']: # Not yet supported
721 if f.get('vcodec') == 'none': # audio only
722 if self._downloader.params.get('prefer_free_formats'):
723 ORDER = ['aac', 'mp3', 'm4a', 'webm', 'ogg', 'opus']
725 ORDER = ['webm', 'opus', 'ogg', 'mp3', 'aac', 'm4a']
728 audio_ext_preference = ORDER.index(f['ext'])
730 audio_ext_preference = -1
732 if self._downloader.params.get('prefer_free_formats'):
733 ORDER = ['flv', 'mp4', 'webm']
735 ORDER = ['webm', 'flv', 'mp4']
737 ext_preference = ORDER.index(f['ext'])
740 audio_ext_preference = 0
744 f.get('language_preference') if f.get('language_preference') is not None else -1,
745 f.get('quality') if f.get('quality') is not None else -1,
746 f.get('tbr') if f.get('tbr') is not None else -1,
747 f.get('filesize') if f.get('filesize') is not None else -1,
748 f.get('vbr') if f.get('vbr') is not None else -1,
749 f.get('height') if f.get('height') is not None else -1,
750 f.get('width') if f.get('width') is not None else -1,
752 f.get('abr') if f.get('abr') is not None else -1,
753 audio_ext_preference,
754 f.get('fps') if f.get('fps') is not None else -1,
755 f.get('filesize_approx') if f.get('filesize_approx') is not None else -1,
756 f.get('source_preference') if f.get('source_preference') is not None else -1,
759 formats.sort(key=_formats_key)
761 def _check_formats(self, formats, video_id):
764 lambda f: self._is_valid_url(
766 item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
769 def _is_valid_url(self, url, video_id, item='video'):
771 self._request_webpage(url, video_id, 'Checking %s URL' % item)
773 except ExtractorError as e:
774 if isinstance(e.cause, compat_HTTPError):
776 '%s URL is invalid, skipping' % item, video_id)
780 def http_scheme(self):
781 """ Either "http:" or "https:", depending on the user's preferences """
784 if self._downloader.params.get('prefer_insecure', False)
787 def _proto_relative_url(self, url, scheme=None):
790 if url.startswith('//'):
792 scheme = self.http_scheme()
797 def _sleep(self, timeout, video_id, msg_template=None):
798 if msg_template is None:
799 msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
800 msg = msg_template % {'video_id': video_id, 'timeout': timeout}
804 def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None):
805 manifest = self._download_xml(
806 manifest_url, video_id, 'Downloading f4m manifest',
807 'Unable to download f4m manifest')
810 manifest_version = '1.0'
811 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
813 manifest_version = '2.0'
814 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
815 for i, media_el in enumerate(media_nodes):
816 if manifest_version == '2.0':
817 manifest_url = ('/'.join(manifest_url.split('/')[:-1]) + '/' +
818 (media_el.attrib.get('href') or media_el.attrib.get('url')))
819 tbr = int_or_none(media_el.attrib.get('bitrate'))
821 'format_id': '-'.join(filter(None, [f4m_id, 'f4m-%d' % (i if tbr is None else tbr)])),
825 'width': int_or_none(media_el.attrib.get('width')),
826 'height': int_or_none(media_el.attrib.get('height')),
827 'preference': preference,
829 self._sort_formats(formats)
833 def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
834 entry_protocol='m3u8', preference=None,
838 'format_id': '-'.join(filter(None, [m3u8_id, 'm3u8-meta'])),
842 'preference': preference - 1 if preference else -1,
843 'resolution': 'multiple',
844 'format_note': 'Quality selection URL',
847 format_url = lambda u: (
849 if re.match(r'^https?://', u)
850 else compat_urlparse.urljoin(m3u8_url, u))
852 m3u8_doc = self._download_webpage(
854 note='Downloading m3u8 information',
855 errnote='Failed to download m3u8 information')
859 r'(?P<key>[a-zA-Z_-]+)=(?P<val>"[^"]+"|[^",]+)(?:,|$)')
860 for line in m3u8_doc.splitlines():
861 if line.startswith('#EXT-X-STREAM-INF:'):
863 for m in kv_rex.finditer(line):
865 if v.startswith('"'):
867 last_info[m.group('key')] = v
868 elif line.startswith('#EXT-X-MEDIA:'):
870 for m in kv_rex.finditer(line):
872 if v.startswith('"'):
874 last_media[m.group('key')] = v
875 elif line.startswith('#') or not line.strip():
878 if last_info is None:
879 formats.append({'url': format_url(line)})
881 tbr = int_or_none(last_info.get('BANDWIDTH'), scale=1000)
883 'format_id': '-'.join(filter(None, [m3u8_id, 'm3u8-%d' % (tbr if tbr else len(formats))])),
884 'url': format_url(line.strip()),
887 'protocol': entry_protocol,
888 'preference': preference,
890 codecs = last_info.get('CODECS')
892 # TODO: looks like video codec is not always necessarily goes first
893 va_codecs = codecs.split(',')
895 f['vcodec'] = va_codecs[0].partition('.')[0]
896 if len(va_codecs) > 1 and va_codecs[1]:
897 f['acodec'] = va_codecs[1].partition('.')[0]
898 resolution = last_info.get('RESOLUTION')
900 width_str, height_str = resolution.split('x')
901 f['width'] = int(width_str)
902 f['height'] = int(height_str)
903 if last_media is not None:
904 f['m3u8_media'] = last_media
908 self._sort_formats(formats)
911 # TODO: improve extraction
912 def _extract_smil_formats(self, smil_url, video_id, fatal=True):
913 smil = self._download_xml(
914 smil_url, video_id, 'Downloading SMIL file',
915 'Unable to download SMIL file', fatal=fatal)
920 base = smil.find('./head/meta').get('base')
924 if smil.findall('./body/seq/video'):
925 video = smil.findall('./body/seq/video')[0]
926 fmts, rtmp_count = self._parse_smil_video(video, video_id, base, rtmp_count)
929 for video in smil.findall('./body/switch/video'):
930 fmts, rtmp_count = self._parse_smil_video(video, video_id, base, rtmp_count)
933 self._sort_formats(formats)
937 def _parse_smil_video(self, video, video_id, base, rtmp_count):
938 src = video.get('src')
940 return ([], rtmp_count)
941 bitrate = int_or_none(video.get('system-bitrate') or video.get('systemBitrate'), 1000)
942 width = int_or_none(video.get('width'))
943 height = int_or_none(video.get('height'))
944 proto = video.get('proto')
947 if base.startswith('rtmp'):
949 elif base.startswith('http'):
951 ext = video.get('ext')
953 return (self._extract_m3u8_formats(src, video_id, ext), rtmp_count)
954 elif proto == 'rtmp':
956 streamer = video.get('streamer') or base
961 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
966 elif proto.startswith('http'):
975 def _live_title(self, name):
976 """ Generate the title for a live video """
977 now = datetime.datetime.now()
978 now_str = now.strftime("%Y-%m-%d %H:%M")
979 return name + ' ' + now_str
981 def _int(self, v, name, fatal=False, **kwargs):
982 res = int_or_none(v, **kwargs)
983 if 'get_attr' in kwargs:
984 print(getattr(v, kwargs['get_attr']))
986 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
988 raise ExtractorError(msg)
990 self._downloader.report_warning(msg)
993 def _float(self, v, name, fatal=False, **kwargs):
994 res = float_or_none(v, **kwargs)
996 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
998 raise ExtractorError(msg)
1000 self._downloader.report_warning(msg)
1003 def _set_cookie(self, domain, name, value, expire_time=None):
1004 cookie = compat_cookiejar.Cookie(
1005 0, name, value, None, None, domain, None,
1006 None, '/', True, False, expire_time, '', None, None, None)
1007 self._downloader.cookiejar.set_cookie(cookie)
1009 def get_testcases(self, include_onlymatching=False):
1010 t = getattr(self, '_TEST', None)
1012 assert not hasattr(self, '_TESTS'), \
1013 '%s has _TEST and _TESTS' % type(self).__name__
1016 tests = getattr(self, '_TESTS', [])
1018 if not include_onlymatching and t.get('only_matching', False):
1020 t['name'] = type(self).__name__[:-len('IE')]
1023 def is_suitable(self, age_limit):
1024 """ Test whether the extractor is generally suitable for the given
1025 age limit (i.e. pornographic sites are not, all others usually are) """
1027 any_restricted = False
1028 for tc in self.get_testcases(include_onlymatching=False):
1029 if 'playlist' in tc:
1030 tc = tc['playlist'][0]
1031 is_restricted = age_restricted(
1032 tc.get('info_dict', {}).get('age_limit'), age_limit)
1033 if not is_restricted:
1035 any_restricted = any_restricted or is_restricted
1036 return not any_restricted
1038 def extract_subtitles(self, *args, **kwargs):
1039 if (self._downloader.params.get('writesubtitles', False) or
1040 self._downloader.params.get('listsubtitles')):
1041 return self._get_subtitles(*args, **kwargs)
1044 def _get_subtitles(self, *args, **kwargs):
1045 raise NotImplementedError("This method must be implemented by subclasses")
1047 def extract_automatic_captions(self, *args, **kwargs):
1048 if (self._downloader.params.get('writeautomaticsub', False) or
1049 self._downloader.params.get('listsubtitles')):
1050 return self._get_automatic_captions(*args, **kwargs)
1053 def _get_automatic_captions(self, *args, **kwargs):
1054 raise NotImplementedError("This method must be implemented by subclasses")
1057 class SearchInfoExtractor(InfoExtractor):
1059 Base class for paged search queries extractors.
1060 They accept urls in the format _SEARCH_KEY(|all|[0-9]):{query}
1061 Instances should define _SEARCH_KEY and _MAX_RESULTS.
1065 def _make_valid_url(cls):
1066 return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
1069 def suitable(cls, url):
1070 return re.match(cls._make_valid_url(), url) is not None
1072 def _real_extract(self, query):
1073 mobj = re.match(self._make_valid_url(), query)
1075 raise ExtractorError('Invalid search query "%s"' % query)
1077 prefix = mobj.group('prefix')
1078 query = mobj.group('query')
1080 return self._get_n_results(query, 1)
1081 elif prefix == 'all':
1082 return self._get_n_results(query, self._MAX_RESULTS)
1086 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
1087 elif n > self._MAX_RESULTS:
1088 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
1089 n = self._MAX_RESULTS
1090 return self._get_n_results(query, n)
1092 def _get_n_results(self, query, n):
1093 """Get a specified number of results for a query"""
1094 raise NotImplementedError("This method must be implemented by subclasses")
1097 def SEARCH_KEY(self):
1098 return self._SEARCH_KEY