[brightcove:new] Add support for playlists (#21331)
[youtube-dl] / youtube_dl / extractor / brightcove.py
1 # coding: utf-8
2 from __future__ import unicode_literals
3
4 import base64
5 import json
6 import re
7 import struct
8
9 from .common import InfoExtractor
10 from .adobepass import AdobePassIE
11 from ..compat import (
12     compat_etree_fromstring,
13     compat_parse_qs,
14     compat_str,
15     compat_urllib_parse_urlparse,
16     compat_urlparse,
17     compat_xml_parse_error,
18     compat_HTTPError,
19 )
20 from ..utils import (
21     determine_ext,
22     ExtractorError,
23     extract_attributes,
24     find_xpath_attr,
25     fix_xml_ampersands,
26     float_or_none,
27     js_to_json,
28     int_or_none,
29     parse_iso8601,
30     unescapeHTML,
31     unsmuggle_url,
32     update_url_query,
33     clean_html,
34     mimetype2ext,
35 )
36
37
38 class BrightcoveLegacyIE(InfoExtractor):
39     IE_NAME = 'brightcove:legacy'
40     _VALID_URL = r'(?:https?://.*brightcove\.com/(services|viewer).*?\?|brightcove:)(?P<query>.*)'
41     _FEDERATED_URL = 'http://c.brightcove.com/services/viewer/htmlFederated'
42
43     _TESTS = [
44         {
45             # From http://www.8tv.cat/8aldia/videos/xavier-sala-i-martin-aquesta-tarda-a-8-al-dia/
46             'url': 'http://c.brightcove.com/services/viewer/htmlFederated?playerID=1654948606001&flashID=myExperience&%40videoPlayer=2371591881001',
47             'md5': '5423e113865d26e40624dce2e4b45d95',
48             'note': 'Test Brightcove downloads and detection in GenericIE',
49             'info_dict': {
50                 'id': '2371591881001',
51                 'ext': 'mp4',
52                 'title': 'Xavier Sala i Martín: “Un banc que no presta és un banc zombi que no serveix per a res”',
53                 'uploader': '8TV',
54                 'description': 'md5:a950cc4285c43e44d763d036710cd9cd',
55                 'timestamp': 1368213670,
56                 'upload_date': '20130510',
57                 'uploader_id': '1589608506001',
58             }
59         },
60         {
61             # From http://medianetwork.oracle.com/video/player/1785452137001
62             'url': 'http://c.brightcove.com/services/viewer/htmlFederated?playerID=1217746023001&flashID=myPlayer&%40videoPlayer=1785452137001',
63             'info_dict': {
64                 'id': '1785452137001',
65                 'ext': 'flv',
66                 'title': 'JVMLS 2012: Arrays 2.0 - Opportunities and Challenges',
67                 'description': 'John Rose speaks at the JVM Language Summit, August 1, 2012.',
68                 'uploader': 'Oracle',
69                 'timestamp': 1344975024,
70                 'upload_date': '20120814',
71                 'uploader_id': '1460825906',
72             },
73         },
74         {
75             # From http://mashable.com/2013/10/26/thermoelectric-bracelet-lets-you-control-your-body-temperature/
76             'url': 'http://c.brightcove.com/services/viewer/federated_f9?&playerID=1265504713001&publisherID=AQ%7E%7E%2CAAABBzUwv1E%7E%2CxP-xFHVUstiMFlNYfvF4G9yFnNaqCw_9&videoID=2750934548001',
77             'info_dict': {
78                 'id': '2750934548001',
79                 'ext': 'mp4',
80                 'title': 'This Bracelet Acts as a Personal Thermostat',
81                 'description': 'md5:547b78c64f4112766ccf4e151c20b6a0',
82                 'uploader': 'Mashable',
83                 'timestamp': 1382041798,
84                 'upload_date': '20131017',
85                 'uploader_id': '1130468786001',
86             },
87         },
88         {
89             # test that the default referer works
90             # from http://national.ballet.ca/interact/video/Lost_in_Motion_II/
91             'url': 'http://link.brightcove.com/services/player/bcpid756015033001?bckey=AQ~~,AAAApYJi_Ck~,GxhXCegT1Dp39ilhXuxMJxasUhVNZiil&bctid=2878862109001',
92             'info_dict': {
93                 'id': '2878862109001',
94                 'ext': 'mp4',
95                 'title': 'Lost in Motion II',
96                 'description': 'md5:363109c02998fee92ec02211bd8000df',
97                 'uploader': 'National Ballet of Canada',
98             },
99             'skip': 'Video gone',
100         },
101         {
102             # test flv videos served by akamaihd.net
103             # From http://www.redbull.com/en/bike/stories/1331655643987/replay-uci-dh-world-cup-2014-from-fort-william
104             'url': 'http://c.brightcove.com/services/viewer/htmlFederated?%40videoPlayer=ref%3Aevent-stream-356&linkBaseURL=http%3A%2F%2Fwww.redbull.com%2Fen%2Fbike%2Fvideos%2F1331655630249%2Freplay-uci-fort-william-2014-dh&playerKey=AQ%7E%7E%2CAAAApYJ7UqE%7E%2Cxqr_zXk0I-zzNndy8NlHogrCb5QdyZRf&playerID=1398061561001#__youtubedl_smuggle=%7B%22Referer%22%3A+%22http%3A%2F%2Fwww.redbull.com%2Fen%2Fbike%2Fstories%2F1331655643987%2Freplay-uci-dh-world-cup-2014-from-fort-william%22%7D',
105             # The md5 checksum changes on each download
106             'info_dict': {
107                 'id': '3750436379001',
108                 'ext': 'flv',
109                 'title': 'UCI MTB World Cup 2014: Fort William, UK - Downhill Finals',
110                 'uploader': 'RBTV Old (do not use)',
111                 'description': 'UCI MTB World Cup 2014: Fort William, UK - Downhill Finals',
112                 'timestamp': 1409122195,
113                 'upload_date': '20140827',
114                 'uploader_id': '710858724001',
115             },
116             'skip': 'Video gone',
117         },
118         {
119             # playlist with 'videoList'
120             # from http://support.brightcove.com/en/video-cloud/docs/playlist-support-single-video-players
121             'url': 'http://c.brightcove.com/services/viewer/htmlFederated?playerID=3550052898001&playerKey=AQ%7E%7E%2CAAABmA9XpXk%7E%2C-Kp7jNgisre1fG5OdqpAFUTcs0lP_ZoL',
122             'info_dict': {
123                 'title': 'Sealife',
124                 'id': '3550319591001',
125             },
126             'playlist_mincount': 7,
127         },
128         {
129             # playlist with 'playlistTab' (https://github.com/ytdl-org/youtube-dl/issues/9965)
130             'url': 'http://c.brightcove.com/services/json/experience/runtime/?command=get_programming_for_experience&playerKey=AQ%7E%7E,AAABXlLMdok%7E,NJ4EoMlZ4rZdx9eU1rkMVd8EaYPBBUlg',
131             'info_dict': {
132                 'id': '1522758701001',
133                 'title': 'Lesson 08',
134             },
135             'playlist_mincount': 10,
136         },
137         {
138             # playerID inferred from bcpid
139             # from http://www.un.org/chinese/News/story.asp?NewsID=27724
140             'url': 'https://link.brightcove.com/services/player/bcpid1722935254001/?bctid=5360463607001&autoStart=false&secureConnections=true&width=650&height=350',
141             'only_matching': True,  # Tested in GenericIE
142         }
143     ]
144     FLV_VCODECS = {
145         1: 'SORENSON',
146         2: 'ON2',
147         3: 'H264',
148         4: 'VP8',
149     }
150
151     @classmethod
152     def _build_brighcove_url(cls, object_str):
153         """
154         Build a Brightcove url from a xml string containing
155         <object class="BrightcoveExperience">{params}</object>
156         """
157
158         # Fix up some stupid HTML, see https://github.com/ytdl-org/youtube-dl/issues/1553
159         object_str = re.sub(r'(<param(?:\s+[a-zA-Z0-9_]+="[^"]*")*)>',
160                             lambda m: m.group(1) + '/>', object_str)
161         # Fix up some stupid XML, see https://github.com/ytdl-org/youtube-dl/issues/1608
162         object_str = object_str.replace('<--', '<!--')
163         # remove namespace to simplify extraction
164         object_str = re.sub(r'(<object[^>]*)(xmlns=".*?")', r'\1', object_str)
165         object_str = fix_xml_ampersands(object_str)
166
167         try:
168             object_doc = compat_etree_fromstring(object_str.encode('utf-8'))
169         except compat_xml_parse_error:
170             return
171
172         fv_el = find_xpath_attr(object_doc, './param', 'name', 'flashVars')
173         if fv_el is not None:
174             flashvars = dict(
175                 (k, v[0])
176                 for k, v in compat_parse_qs(fv_el.attrib['value']).items())
177         else:
178             flashvars = {}
179
180         data_url = object_doc.attrib.get('data', '')
181         data_url_params = compat_parse_qs(compat_urllib_parse_urlparse(data_url).query)
182
183         def find_param(name):
184             if name in flashvars:
185                 return flashvars[name]
186             node = find_xpath_attr(object_doc, './param', 'name', name)
187             if node is not None:
188                 return node.attrib['value']
189             return data_url_params.get(name)
190
191         params = {}
192
193         playerID = find_param('playerID') or find_param('playerId')
194         if playerID is None:
195             raise ExtractorError('Cannot find player ID')
196         params['playerID'] = playerID
197
198         playerKey = find_param('playerKey')
199         # Not all pages define this value
200         if playerKey is not None:
201             params['playerKey'] = playerKey
202         # These fields hold the id of the video
203         videoPlayer = find_param('@videoPlayer') or find_param('videoId') or find_param('videoID') or find_param('@videoList')
204         if videoPlayer is not None:
205             if isinstance(videoPlayer, list):
206                 videoPlayer = videoPlayer[0]
207             videoPlayer = videoPlayer.strip()
208             # UUID is also possible for videoPlayer (e.g.
209             # http://www.popcornflix.com/hoodies-vs-hooligans/7f2d2b87-bbf2-4623-acfb-ea942b4f01dd
210             # or http://www8.hp.com/cn/zh/home.html)
211             if not (re.match(
212                     r'^(?:\d+|[\da-fA-F]{8}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{4}-?[\da-fA-F]{12})$',
213                     videoPlayer) or videoPlayer.startswith('ref:')):
214                 return None
215             params['@videoPlayer'] = videoPlayer
216         linkBase = find_param('linkBaseURL')
217         if linkBase is not None:
218             params['linkBaseURL'] = linkBase
219         return cls._make_brightcove_url(params)
220
221     @classmethod
222     def _build_brighcove_url_from_js(cls, object_js):
223         # The layout of JS is as follows:
224         # customBC.createVideo = function (width, height, playerID, playerKey, videoPlayer, VideoRandomID) {
225         #   // build Brightcove <object /> XML
226         # }
227         m = re.search(
228             r'''(?x)customBC\.createVideo\(
229                 .*?                                                  # skipping width and height
230                 ["\'](?P<playerID>\d+)["\']\s*,\s*                   # playerID
231                 ["\'](?P<playerKey>AQ[^"\']{48})[^"\']*["\']\s*,\s*  # playerKey begins with AQ and is 50 characters
232                                                                      # in length, however it's appended to itself
233                                                                      # in places, so truncate
234                 ["\'](?P<videoID>\d+)["\']                           # @videoPlayer
235             ''', object_js)
236         if m:
237             return cls._make_brightcove_url(m.groupdict())
238
239     @classmethod
240     def _make_brightcove_url(cls, params):
241         return update_url_query(cls._FEDERATED_URL, params)
242
243     @classmethod
244     def _extract_brightcove_url(cls, webpage):
245         """Try to extract the brightcove url from the webpage, returns None
246         if it can't be found
247         """
248         urls = cls._extract_brightcove_urls(webpage)
249         return urls[0] if urls else None
250
251     @classmethod
252     def _extract_brightcove_urls(cls, webpage):
253         """Return a list of all Brightcove URLs from the webpage """
254
255         url_m = re.search(
256             r'''(?x)
257                 <meta\s+
258                     (?:property|itemprop)=([\'"])(?:og:video|embedURL)\1[^>]+
259                     content=([\'"])(?P<url>https?://(?:secure|c)\.brightcove.com/(?:(?!\2).)+)\2
260             ''', webpage)
261         if url_m:
262             url = unescapeHTML(url_m.group('url'))
263             # Some sites don't add it, we can't download with this url, for example:
264             # http://www.ktvu.com/videos/news/raw-video-caltrain-releases-video-of-man-almost/vCTZdY/
265             if 'playerKey' in url or 'videoId' in url or 'idVideo' in url:
266                 return [url]
267
268         matches = re.findall(
269             r'''(?sx)<object
270             (?:
271                 [^>]+?class=[\'"][^>]*?BrightcoveExperience.*?[\'"] |
272                 [^>]*?>\s*<param\s+name="movie"\s+value="https?://[^/]*brightcove\.com/
273             ).+?>\s*</object>''',
274             webpage)
275         if matches:
276             return list(filter(None, [cls._build_brighcove_url(m) for m in matches]))
277
278         matches = re.findall(r'(customBC\.createVideo\(.+?\);)', webpage)
279         if matches:
280             return list(filter(None, [
281                 cls._build_brighcove_url_from_js(custom_bc)
282                 for custom_bc in matches]))
283         return [src for _, src in re.findall(
284             r'<iframe[^>]+src=([\'"])((?:https?:)?//link\.brightcove\.com/services/player/(?!\1).+)\1', webpage)]
285
286     def _real_extract(self, url):
287         url, smuggled_data = unsmuggle_url(url, {})
288
289         # Change the 'videoId' and others field to '@videoPlayer'
290         url = re.sub(r'(?<=[?&])(videoI(d|D)|idVideo|bctid)', '%40videoPlayer', url)
291         # Change bckey (used by bcove.me urls) to playerKey
292         url = re.sub(r'(?<=[?&])bckey', 'playerKey', url)
293         mobj = re.match(self._VALID_URL, url)
294         query_str = mobj.group('query')
295         query = compat_urlparse.parse_qs(query_str)
296
297         videoPlayer = query.get('@videoPlayer')
298         if videoPlayer:
299             # We set the original url as the default 'Referer' header
300             referer = smuggled_data.get('Referer', url)
301             if 'playerID' not in query:
302                 mobj = re.search(r'/bcpid(\d+)', url)
303                 if mobj is not None:
304                     query['playerID'] = [mobj.group(1)]
305             return self._get_video_info(
306                 videoPlayer[0], query, referer=referer)
307         elif 'playerKey' in query:
308             player_key = query['playerKey']
309             return self._get_playlist_info(player_key[0])
310         else:
311             raise ExtractorError(
312                 'Cannot find playerKey= variable. Did you forget quotes in a shell invocation?',
313                 expected=True)
314
315     def _brightcove_new_url_result(self, publisher_id, video_id):
316         brightcove_new_url = 'http://players.brightcove.net/%s/default_default/index.html?videoId=%s' % (publisher_id, video_id)
317         return self.url_result(brightcove_new_url, BrightcoveNewIE.ie_key(), video_id)
318
319     def _get_video_info(self, video_id, query, referer=None):
320         headers = {}
321         linkBase = query.get('linkBaseURL')
322         if linkBase is not None:
323             referer = linkBase[0]
324         if referer is not None:
325             headers['Referer'] = referer
326         webpage = self._download_webpage(self._FEDERATED_URL, video_id, headers=headers, query=query)
327
328         error_msg = self._html_search_regex(
329             r"<h1>We're sorry.</h1>([\s\n]*<p>.*?</p>)+", webpage,
330             'error message', default=None)
331         if error_msg is not None:
332             publisher_id = query.get('publisherId')
333             if publisher_id and publisher_id[0].isdigit():
334                 publisher_id = publisher_id[0]
335             if not publisher_id:
336                 player_key = query.get('playerKey')
337                 if player_key and ',' in player_key[0]:
338                     player_key = player_key[0]
339                 else:
340                     player_id = query.get('playerID')
341                     if player_id and player_id[0].isdigit():
342                         player_page = self._download_webpage(
343                             'http://link.brightcove.com/services/player/bcpid' + player_id[0],
344                             video_id, headers=headers, fatal=False)
345                         if player_page:
346                             player_key = self._search_regex(
347                                 r'<param\s+name="playerKey"\s+value="([\w~,-]+)"',
348                                 player_page, 'player key', fatal=False)
349                 if player_key:
350                     enc_pub_id = player_key.split(',')[1].replace('~', '=')
351                     publisher_id = struct.unpack('>Q', base64.urlsafe_b64decode(enc_pub_id))[0]
352                 if publisher_id:
353                     return self._brightcove_new_url_result(publisher_id, video_id)
354             raise ExtractorError(
355                 'brightcove said: %s' % error_msg, expected=True)
356
357         self.report_extraction(video_id)
358         info = self._search_regex(r'var experienceJSON = ({.*});', webpage, 'json')
359         info = json.loads(info)['data']
360         video_info = info['programmedContent']['videoPlayer']['mediaDTO']
361         video_info['_youtubedl_adServerURL'] = info.get('adServerURL')
362
363         return self._extract_video_info(video_info)
364
365     def _get_playlist_info(self, player_key):
366         info_url = 'http://c.brightcove.com/services/json/experience/runtime/?command=get_programming_for_experience&playerKey=%s' % player_key
367         playlist_info = self._download_webpage(
368             info_url, player_key, 'Downloading playlist information')
369
370         json_data = json.loads(playlist_info)
371         if 'videoList' in json_data:
372             playlist_info = json_data['videoList']
373             playlist_dto = playlist_info['mediaCollectionDTO']
374         elif 'playlistTabs' in json_data:
375             playlist_info = json_data['playlistTabs']
376             playlist_dto = playlist_info['lineupListDTO']['playlistDTOs'][0]
377         else:
378             raise ExtractorError('Empty playlist')
379
380         videos = [self._extract_video_info(video_info) for video_info in playlist_dto['videoDTOs']]
381
382         return self.playlist_result(videos, playlist_id='%s' % playlist_info['id'],
383                                     playlist_title=playlist_dto['displayName'])
384
385     def _extract_video_info(self, video_info):
386         video_id = compat_str(video_info['id'])
387         publisher_id = video_info.get('publisherId')
388         info = {
389             'id': video_id,
390             'title': video_info['displayName'].strip(),
391             'description': video_info.get('shortDescription'),
392             'thumbnail': video_info.get('videoStillURL') or video_info.get('thumbnailURL'),
393             'uploader': video_info.get('publisherName'),
394             'uploader_id': compat_str(publisher_id) if publisher_id else None,
395             'duration': float_or_none(video_info.get('length'), 1000),
396             'timestamp': int_or_none(video_info.get('creationDate'), 1000),
397         }
398
399         renditions = video_info.get('renditions', []) + video_info.get('IOSRenditions', [])
400         if renditions:
401             formats = []
402             for rend in renditions:
403                 url = rend['defaultURL']
404                 if not url:
405                     continue
406                 ext = None
407                 if rend['remote']:
408                     url_comp = compat_urllib_parse_urlparse(url)
409                     if url_comp.path.endswith('.m3u8'):
410                         formats.extend(
411                             self._extract_m3u8_formats(
412                                 url, video_id, 'mp4', 'm3u8_native', m3u8_id='hls', fatal=False))
413                         continue
414                     elif 'akamaihd.net' in url_comp.netloc:
415                         # This type of renditions are served through
416                         # akamaihd.net, but they don't use f4m manifests
417                         url = url.replace('control/', '') + '?&v=3.3.0&fp=13&r=FEEFJ&g=RTSJIMBMPFPB'
418                         ext = 'flv'
419                 if ext is None:
420                     ext = determine_ext(url)
421                 tbr = int_or_none(rend.get('encodingRate'), 1000)
422                 a_format = {
423                     'format_id': 'http%s' % ('-%s' % tbr if tbr else ''),
424                     'url': url,
425                     'ext': ext,
426                     'filesize': int_or_none(rend.get('size')) or None,
427                     'tbr': tbr,
428                 }
429                 if rend.get('audioOnly'):
430                     a_format.update({
431                         'vcodec': 'none',
432                     })
433                 else:
434                     a_format.update({
435                         'height': int_or_none(rend.get('frameHeight')),
436                         'width': int_or_none(rend.get('frameWidth')),
437                         'vcodec': rend.get('videoCodec'),
438                     })
439
440                 # m3u8 manifests with remote == false are media playlists
441                 # Not calling _extract_m3u8_formats here to save network traffic
442                 if ext == 'm3u8':
443                     a_format.update({
444                         'format_id': 'hls%s' % ('-%s' % tbr if tbr else ''),
445                         'ext': 'mp4',
446                         'protocol': 'm3u8_native',
447                     })
448
449                 formats.append(a_format)
450             self._sort_formats(formats)
451             info['formats'] = formats
452         elif video_info.get('FLVFullLengthURL') is not None:
453             info.update({
454                 'url': video_info['FLVFullLengthURL'],
455                 'vcodec': self.FLV_VCODECS.get(video_info.get('FLVFullCodec')),
456                 'filesize': int_or_none(video_info.get('FLVFullSize')),
457             })
458
459         if self._downloader.params.get('include_ads', False):
460             adServerURL = video_info.get('_youtubedl_adServerURL')
461             if adServerURL:
462                 ad_info = {
463                     '_type': 'url',
464                     'url': adServerURL,
465                 }
466                 if 'url' in info:
467                     return {
468                         '_type': 'playlist',
469                         'title': info['title'],
470                         'entries': [ad_info, info],
471                     }
472                 else:
473                     return ad_info
474
475         if not info.get('url') and not info.get('formats'):
476             uploader_id = info.get('uploader_id')
477             if uploader_id:
478                 info.update(self._brightcove_new_url_result(uploader_id, video_id))
479             else:
480                 raise ExtractorError('Unable to extract video url for %s' % video_id)
481         return info
482
483
484 class BrightcoveNewIE(AdobePassIE):
485     IE_NAME = 'brightcove:new'
486     _VALID_URL = r'https?://players\.brightcove\.net/(?P<account_id>\d+)/(?P<player_id>[^/]+)_(?P<embed>[^/]+)/index\.html\?.*(?P<content_type>video|playlist)Id=(?P<video_id>\d+|ref:[^&]+)'
487     _TESTS = [{
488         'url': 'http://players.brightcove.net/929656772001/e41d32dc-ec74-459e-a845-6c69f7b724ea_default/index.html?videoId=4463358922001',
489         'md5': 'c8100925723840d4b0d243f7025703be',
490         'info_dict': {
491             'id': '4463358922001',
492             'ext': 'mp4',
493             'title': 'Meet the man behind Popcorn Time',
494             'description': 'md5:eac376a4fe366edc70279bfb681aea16',
495             'duration': 165.768,
496             'timestamp': 1441391203,
497             'upload_date': '20150904',
498             'uploader_id': '929656772001',
499             'formats': 'mincount:20',
500         },
501     }, {
502         # with rtmp streams
503         'url': 'http://players.brightcove.net/4036320279001/5d112ed9-283f-485f-a7f9-33f42e8bc042_default/index.html?videoId=4279049078001',
504         'info_dict': {
505             'id': '4279049078001',
506             'ext': 'mp4',
507             'title': 'Titansgrave: Chapter 0',
508             'description': 'Titansgrave: Chapter 0',
509             'duration': 1242.058,
510             'timestamp': 1433556729,
511             'upload_date': '20150606',
512             'uploader_id': '4036320279001',
513             'formats': 'mincount:39',
514         },
515         'params': {
516             # m3u8 download
517             'skip_download': True,
518         }
519     }, {
520         # playlist stream
521         'url': 'https://players.brightcove.net/1752604059001/S13cJdUBz_default/index.html?playlistId=5718313430001',
522         'info_dict': {
523             'id': '5718313430001',
524             'title': 'No Audio Playlist',
525         },
526         'playlist_count': 7,
527         'params': {
528             # m3u8 download
529             'skip_download': True,
530         }
531     }, {
532         'url': 'http://players.brightcove.net/5690807595001/HyZNerRl7_default/index.html?playlistId=5743160747001',
533         'only_matching': True,
534     }, {
535         # ref: prefixed video id
536         'url': 'http://players.brightcove.net/3910869709001/21519b5c-4b3b-4363-accb-bdc8f358f823_default/index.html?videoId=ref:7069442',
537         'only_matching': True,
538     }, {
539         # non numeric ref: prefixed video id
540         'url': 'http://players.brightcove.net/710858724001/default_default/index.html?videoId=ref:event-stream-356',
541         'only_matching': True,
542     }, {
543         # unavailable video without message but with error_code
544         'url': 'http://players.brightcove.net/1305187701/c832abfb-641b-44eb-9da0-2fe76786505f_default/index.html?videoId=4377407326001',
545         'only_matching': True,
546     }]
547
548     @staticmethod
549     def _extract_url(ie, webpage):
550         urls = BrightcoveNewIE._extract_urls(ie, webpage)
551         return urls[0] if urls else None
552
553     @staticmethod
554     def _extract_urls(ie, webpage):
555         # Reference:
556         # 1. http://docs.brightcove.com/en/video-cloud/brightcove-player/guides/publish-video.html#setvideoiniframe
557         # 2. http://docs.brightcove.com/en/video-cloud/brightcove-player/guides/publish-video.html#tag
558         # 3. http://docs.brightcove.com/en/video-cloud/brightcove-player/guides/publish-video.html#setvideousingjavascript
559         # 4. http://docs.brightcove.com/en/video-cloud/brightcove-player/guides/in-page-embed-player-implementation.html
560         # 5. https://support.brightcove.com/en/video-cloud/docs/dynamically-assigning-videos-player
561
562         entries = []
563
564         # Look for iframe embeds [1]
565         for _, url in re.findall(
566                 r'<iframe[^>]+src=(["\'])((?:https?:)?//players\.brightcove\.net/\d+/[^/]+/index\.html.+?)\1', webpage):
567             entries.append(url if url.startswith('http') else 'http:' + url)
568
569         # Look for <video> tags [2] and embed_in_page embeds [3]
570         # [2] looks like:
571         for video, script_tag, account_id, player_id, embed in re.findall(
572                 r'''(?isx)
573                     (<video\s+[^>]*\bdata-video-id\s*=\s*['"]?[^>]+>)
574                     (?:.*?
575                         (<script[^>]+
576                             src=["\'](?:https?:)?//players\.brightcove\.net/
577                             (\d+)/([^/]+)_([^/]+)/index(?:\.min)?\.js
578                         )
579                     )?
580                 ''', webpage):
581             attrs = extract_attributes(video)
582
583             # According to examples from [4] it's unclear whether video id
584             # may be optional and what to do when it is
585             video_id = attrs.get('data-video-id')
586             if not video_id:
587                 continue
588
589             account_id = account_id or attrs.get('data-account')
590             if not account_id:
591                 continue
592
593             player_id = player_id or attrs.get('data-player') or 'default'
594             embed = embed or attrs.get('data-embed') or 'default'
595
596             bc_url = 'http://players.brightcove.net/%s/%s_%s/index.html?videoId=%s' % (
597                 account_id, player_id, embed, video_id)
598
599             # Some brightcove videos may be embedded with video tag only and
600             # without script tag or any mentioning of brightcove at all. Such
601             # embeds are considered ambiguous since they are matched based only
602             # on data-video-id and data-account attributes and in the wild may
603             # not be brightcove embeds at all. Let's check reconstructed
604             # brightcove URLs in case of such embeds and only process valid
605             # ones. By this we ensure there is indeed a brightcove embed.
606             if not script_tag and not ie._is_valid_url(
607                     bc_url, video_id, 'possible brightcove video'):
608                 continue
609
610             entries.append(bc_url)
611
612         return entries
613
614     def _parse_brightcove_metadata(self, json_data, video_id, headers={}):
615         title = json_data['name'].strip()
616
617         formats = []
618         for source in json_data.get('sources', []):
619             container = source.get('container')
620             ext = mimetype2ext(source.get('type'))
621             src = source.get('src')
622             # https://support.brightcove.com/playback-api-video-fields-reference#key_systems_object
623             if ext == 'ism' or container == 'WVM' or source.get('key_systems'):
624                 continue
625             elif ext == 'm3u8' or container == 'M2TS':
626                 if not src:
627                     continue
628                 formats.extend(self._extract_m3u8_formats(
629                     src, video_id, 'mp4', 'm3u8_native', m3u8_id='hls', fatal=False))
630             elif ext == 'mpd':
631                 if not src:
632                     continue
633                 formats.extend(self._extract_mpd_formats(src, video_id, 'dash', fatal=False))
634             else:
635                 streaming_src = source.get('streaming_src')
636                 stream_name, app_name = source.get('stream_name'), source.get('app_name')
637                 if not src and not streaming_src and (not stream_name or not app_name):
638                     continue
639                 tbr = float_or_none(source.get('avg_bitrate'), 1000)
640                 height = int_or_none(source.get('height'))
641                 width = int_or_none(source.get('width'))
642                 f = {
643                     'tbr': tbr,
644                     'filesize': int_or_none(source.get('size')),
645                     'container': container,
646                     'ext': ext or container.lower(),
647                 }
648                 if width == 0 and height == 0:
649                     f.update({
650                         'vcodec': 'none',
651                     })
652                 else:
653                     f.update({
654                         'width': width,
655                         'height': height,
656                         'vcodec': source.get('codec'),
657                     })
658
659                 def build_format_id(kind):
660                     format_id = kind
661                     if tbr:
662                         format_id += '-%dk' % int(tbr)
663                     if height:
664                         format_id += '-%dp' % height
665                     return format_id
666
667                 if src or streaming_src:
668                     f.update({
669                         'url': src or streaming_src,
670                         'format_id': build_format_id('http' if src else 'http-streaming'),
671                         'source_preference': 0 if src else -1,
672                     })
673                 else:
674                     f.update({
675                         'url': app_name,
676                         'play_path': stream_name,
677                         'format_id': build_format_id('rtmp'),
678                     })
679                 formats.append(f)
680         if not formats:
681             # for sonyliv.com DRM protected videos
682             s3_source_url = json_data.get('custom_fields', {}).get('s3sourceurl')
683             if s3_source_url:
684                 formats.append({
685                     'url': s3_source_url,
686                     'format_id': 'source',
687                 })
688
689         errors = json_data.get('errors')
690         if not formats and errors:
691             error = errors[0]
692             raise ExtractorError(
693                 error.get('message') or error.get('error_subcode') or error['error_code'], expected=True)
694
695         self._sort_formats(formats)
696
697         for f in formats:
698             f.setdefault('http_headers', {}).update(headers)
699
700         subtitles = {}
701         for text_track in json_data.get('text_tracks', []):
702             if text_track.get('src'):
703                 subtitles.setdefault(text_track.get('srclang'), []).append({
704                     'url': text_track['src'],
705                 })
706
707         is_live = False
708         duration = float_or_none(json_data.get('duration'), 1000)
709         if duration is not None and duration <= 0:
710             is_live = True
711
712         return {
713             'id': video_id,
714             'title': self._live_title(title) if is_live else title,
715             'description': clean_html(json_data.get('description')),
716             'thumbnail': json_data.get('thumbnail') or json_data.get('poster'),
717             'duration': duration,
718             'timestamp': parse_iso8601(json_data.get('published_at')),
719             'uploader_id': json_data.get('account_id'),
720             'formats': formats,
721             'subtitles': subtitles,
722             'tags': json_data.get('tags', []),
723             'is_live': is_live,
724         }
725
726     def _real_extract(self, url):
727         url, smuggled_data = unsmuggle_url(url, {})
728         self._initialize_geo_bypass({
729             'countries': smuggled_data.get('geo_countries'),
730             'ip_blocks': smuggled_data.get('geo_ip_blocks'),
731         })
732
733         account_id, player_id, embed, content_type, video_id = re.match(self._VALID_URL, url).groups()
734
735         webpage = self._download_webpage(
736             'http://players.brightcove.net/%s/%s_%s/index.min.js'
737             % (account_id, player_id, embed), video_id)
738
739         policy_key = None
740
741         catalog = self._search_regex(
742             r'catalog\(({.+?})\);', webpage, 'catalog', default=None)
743         if catalog:
744             catalog = self._parse_json(
745                 js_to_json(catalog), video_id, fatal=False)
746             if catalog:
747                 policy_key = catalog.get('policyKey')
748
749         if not policy_key:
750             policy_key = self._search_regex(
751                 r'policyKey\s*:\s*(["\'])(?P<pk>.+?)\1',
752                 webpage, 'policy key', group='pk')
753
754         api_url = 'https://edge.api.brightcove.com/playback/v1/accounts/%s/%ss/%s' % (account_id, content_type, video_id)
755         headers = {
756             'Accept': 'application/json;pk=%s' % policy_key,
757         }
758         referrer = smuggled_data.get('referrer')
759         if referrer:
760             headers.update({
761                 'Referer': referrer,
762                 'Origin': re.search(r'https?://[^/]+', referrer).group(0),
763             })
764         try:
765             json_data = self._download_json(api_url, video_id, headers=headers)
766         except ExtractorError as e:
767             if isinstance(e.cause, compat_HTTPError) and e.cause.code == 403:
768                 json_data = self._parse_json(e.cause.read().decode(), video_id)[0]
769                 message = json_data.get('message') or json_data['error_code']
770                 if json_data.get('error_subcode') == 'CLIENT_GEO':
771                     self.raise_geo_restricted(msg=message)
772                 raise ExtractorError(message, expected=True)
773             raise
774
775         errors = json_data.get('errors')
776         if errors and errors[0].get('error_subcode') == 'TVE_AUTH':
777             custom_fields = json_data['custom_fields']
778             tve_token = self._extract_mvpd_auth(
779                 smuggled_data['source_url'], video_id,
780                 custom_fields['bcadobepassrequestorid'],
781                 custom_fields['bcadobepassresourceid'])
782             json_data = self._download_json(
783                 api_url, video_id, headers={
784                     'Accept': 'application/json;pk=%s' % policy_key
785                 }, query={
786                     'tveToken': tve_token,
787                 })
788
789         if content_type == 'playlist':
790             return self.playlist_result(
791                 [self._parse_brightcove_metadata(vid, vid.get('id'), headers)
792                  for vid in json_data.get('videos', []) if vid.get('id')],
793                 json_data.get('id'), json_data.get('name'),
794                 json_data.get('description'))
795
796         return self._parse_brightcove_metadata(
797             json_data, video_id, headers=headers)