[soundcloud] Modernize
[youtube-dl] / youtube_dl / extractor / soundcloud.py
1 # encoding: utf-8
2 from __future__ import unicode_literals
3
4 import re
5 import itertools
6
7 from .common import (
8     InfoExtractor,
9     SearchInfoExtractor
10 )
11 from ..compat import (
12     compat_str,
13     compat_urlparse,
14     compat_urllib_parse_urlencode,
15 )
16 from ..utils import (
17     ExtractorError,
18     int_or_none,
19     unified_strdate,
20 )
21
22
23 class SoundcloudIE(InfoExtractor):
24     """Information extractor for soundcloud.com
25        To access the media, the uid of the song and a stream token
26        must be extracted from the page source and the script must make
27        a request to media.soundcloud.com/crossdomain.xml. Then
28        the media can be grabbed by requesting from an url composed
29        of the stream token and uid
30      """
31
32     _VALID_URL = r'''(?x)^(?:https?://)?
33                     (?:(?:(?:www\.|m\.)?soundcloud\.com/
34                             (?P<uploader>[\w\d-]+)/
35                             (?!(?:tracks|sets(?:/.+?)?|reposts|likes|spotlight)/?(?:$|[?#]))
36                             (?P<title>[\w\d-]+)/?
37                             (?P<token>[^?]+?)?(?:[?].*)?$)
38                        |(?:api\.soundcloud\.com/tracks/(?P<track_id>\d+)
39                           (?:/?\?secret_token=(?P<secret_token>[^&]+))?)
40                        |(?P<player>(?:w|player|p.)\.soundcloud\.com/player/?.*?url=.*)
41                     )
42                     '''
43     IE_NAME = 'soundcloud'
44     _TESTS = [
45         {
46             'url': 'http://soundcloud.com/ethmusic/lostin-powers-she-so-heavy',
47             'md5': 'ebef0a451b909710ed1d7787dddbf0d7',
48             'info_dict': {
49                 'id': '62986583',
50                 'ext': 'mp3',
51                 'upload_date': '20121011',
52                 'description': 'No Downloads untill we record the finished version this weekend, i was too pumped n i had to post it , earl is prolly gonna b hella p.o\'d',
53                 'uploader': 'E.T. ExTerrestrial Music',
54                 'title': 'Lostin Powers - She so Heavy (SneakPreview) Adrian Ackers Blueprint 1',
55                 'duration': 143,
56                 'license': 'all-rights-reserved',
57             }
58         },
59         # not streamable song
60         {
61             'url': 'https://soundcloud.com/the-concept-band/goldrushed-mastered?in=the-concept-band/sets/the-royal-concept-ep',
62             'info_dict': {
63                 'id': '47127627',
64                 'ext': 'mp3',
65                 'title': 'Goldrushed',
66                 'description': 'From Stockholm Sweden\r\nPovel / Magnus / Filip / David\r\nwww.theroyalconcept.com',
67                 'uploader': 'The Royal Concept',
68                 'upload_date': '20120521',
69                 'duration': 227,
70                 'license': 'all-rights-reserved',
71             },
72             'params': {
73                 # rtmp
74                 'skip_download': True,
75             },
76         },
77         # private link
78         {
79             'url': 'https://soundcloud.com/jaimemf/youtube-dl-test-video-a-y-baw/s-8Pjrp',
80             'md5': 'aa0dd32bfea9b0c5ef4f02aacd080604',
81             'info_dict': {
82                 'id': '123998367',
83                 'ext': 'mp3',
84                 'title': 'Youtube - Dl Test Video \'\' Ä↭',
85                 'uploader': 'jaimeMF',
86                 'description': 'test chars:  \"\'/\\ä↭',
87                 'upload_date': '20131209',
88                 'duration': 9,
89                 'license': 'all-rights-reserved',
90             },
91         },
92         # private link (alt format)
93         {
94             'url': 'https://api.soundcloud.com/tracks/123998367?secret_token=s-8Pjrp',
95             'md5': 'aa0dd32bfea9b0c5ef4f02aacd080604',
96             'info_dict': {
97                 'id': '123998367',
98                 'ext': 'mp3',
99                 'title': 'Youtube - Dl Test Video \'\' Ä↭',
100                 'uploader': 'jaimeMF',
101                 'description': 'test chars:  \"\'/\\ä↭',
102                 'upload_date': '20131209',
103                 'duration': 9,
104                 'license': 'all-rights-reserved',
105             },
106         },
107         # downloadable song
108         {
109             'url': 'https://soundcloud.com/oddsamples/bus-brakes',
110             'md5': '7624f2351f8a3b2e7cd51522496e7631',
111             'info_dict': {
112                 'id': '128590877',
113                 'ext': 'mp3',
114                 'title': 'Bus Brakes',
115                 'description': 'md5:0053ca6396e8d2fd7b7e1595ef12ab66',
116                 'uploader': 'oddsamples',
117                 'upload_date': '20140109',
118                 'duration': 17,
119                 'license': 'cc-by-sa',
120             },
121         },
122     ]
123
124     _CLIENT_ID = '02gUJC0hH2ct1EGOcYXQIzRFU91c72Ea'
125     _IPHONE_CLIENT_ID = '376f225bf427445fc4bfb6b99b72e0bf'
126
127     @staticmethod
128     def _extract_urls(webpage):
129         return [m.group('url') for m in re.finditer(
130             r'<iframe[^>]+src=(["\'])(?P<url>(?:https?://)?(?:w\.)?soundcloud\.com/player.+?)\1',
131             webpage)]
132
133     def report_resolve(self, video_id):
134         """Report information extraction."""
135         self.to_screen('%s: Resolving id' % video_id)
136
137     @classmethod
138     def _resolv_url(cls, url):
139         return 'http://api.soundcloud.com/resolve.json?url=' + url + '&client_id=' + cls._CLIENT_ID
140
141     def _extract_info_dict(self, info, full_title=None, quiet=False, secret_token=None):
142         track_id = compat_str(info['id'])
143         name = full_title or track_id
144         if quiet:
145             self.report_extraction(name)
146         thumbnail = info.get('artwork_url')
147         if isinstance(thumbnail, compat_str):
148             thumbnail = thumbnail.replace('-large', '-t500x500')
149         ext = 'mp3'
150         result = {
151             'id': track_id,
152             'uploader': info.get('user', {}).get('username'),
153             'upload_date': unified_strdate(info.get('created_at')),
154             'title': info['title'],
155             'description': info.get('description'),
156             'thumbnail': thumbnail,
157             'duration': int_or_none(info.get('duration'), 1000),
158             'webpage_url': info.get('permalink_url'),
159             'license': info.get('license'),
160         }
161         formats = []
162         if info.get('downloadable', False):
163             # We can build a direct link to the song
164             format_url = (
165                 'https://api.soundcloud.com/tracks/{0}/download?client_id={1}'.format(
166                     track_id, self._CLIENT_ID))
167             formats.append({
168                 'format_id': 'download',
169                 'ext': info.get('original_format', 'mp3'),
170                 'url': format_url,
171                 'vcodec': 'none',
172                 'preference': 10,
173             })
174
175         # We have to retrieve the url
176         streams_url = ('http://api.soundcloud.com/i1/tracks/{0}/streams?'
177                        'client_id={1}&secret_token={2}'.format(track_id, self._IPHONE_CLIENT_ID, secret_token))
178         format_dict = self._download_json(
179             streams_url,
180             track_id, 'Downloading track url')
181
182         for key, stream_url in format_dict.items():
183             if key.startswith('http'):
184                 formats.append({
185                     'format_id': key,
186                     'ext': ext,
187                     'url': stream_url,
188                     'vcodec': 'none',
189                 })
190             elif key.startswith('rtmp'):
191                 # The url doesn't have an rtmp app, we have to extract the playpath
192                 url, path = stream_url.split('mp3:', 1)
193                 formats.append({
194                     'format_id': key,
195                     'url': url,
196                     'play_path': 'mp3:' + path,
197                     'ext': 'flv',
198                     'vcodec': 'none',
199                 })
200
201             if not formats:
202                 # We fallback to the stream_url in the original info, this
203                 # cannot be always used, sometimes it can give an HTTP 404 error
204                 formats.append({
205                     'format_id': 'fallback',
206                     'url': info['stream_url'] + '?client_id=' + self._CLIENT_ID,
207                     'ext': ext,
208                     'vcodec': 'none',
209                 })
210
211             for f in formats:
212                 if f['format_id'].startswith('http'):
213                     f['protocol'] = 'http'
214                 if f['format_id'].startswith('rtmp'):
215                     f['protocol'] = 'rtmp'
216
217         self._check_formats(formats, track_id)
218         self._sort_formats(formats)
219         result['formats'] = formats
220
221         return result
222
223     def _real_extract(self, url):
224         mobj = re.match(self._VALID_URL, url, flags=re.VERBOSE)
225         if mobj is None:
226             raise ExtractorError('Invalid URL: %s' % url)
227
228         track_id = mobj.group('track_id')
229
230         if track_id is not None:
231             info_json_url = 'http://api.soundcloud.com/tracks/' + track_id + '.json?client_id=' + self._CLIENT_ID
232             full_title = track_id
233             token = mobj.group('secret_token')
234             if token:
235                 info_json_url += '&secret_token=' + token
236         elif mobj.group('player'):
237             query = compat_urlparse.parse_qs(compat_urlparse.urlparse(url).query)
238             real_url = query['url'][0]
239             # If the token is in the query of the original url we have to
240             # manually add it
241             if 'secret_token' in query:
242                 real_url += '?secret_token=' + query['secret_token'][0]
243             return self.url_result(real_url)
244         else:
245             # extract uploader (which is in the url)
246             uploader = mobj.group('uploader')
247             # extract simple title (uploader + slug of song title)
248             slug_title = mobj.group('title')
249             token = mobj.group('token')
250             full_title = resolve_title = '%s/%s' % (uploader, slug_title)
251             if token:
252                 resolve_title += '/%s' % token
253
254             self.report_resolve(full_title)
255
256             url = 'http://soundcloud.com/%s' % resolve_title
257             info_json_url = self._resolv_url(url)
258         info = self._download_json(info_json_url, full_title, 'Downloading info JSON')
259
260         return self._extract_info_dict(info, full_title, secret_token=token)
261
262
263 class SoundcloudSetIE(SoundcloudIE):
264     _VALID_URL = r'https?://(?:(?:www|m)\.)?soundcloud\.com/(?P<uploader>[\w\d-]+)/sets/(?P<slug_title>[\w\d-]+)(?:/(?P<token>[^?/]+))?'
265     IE_NAME = 'soundcloud:set'
266     _TESTS = [{
267         'url': 'https://soundcloud.com/the-concept-band/sets/the-royal-concept-ep',
268         'info_dict': {
269             'id': '2284613',
270             'title': 'The Royal Concept EP',
271         },
272         'playlist_mincount': 6,
273     }, {
274         'url': 'https://soundcloud.com/the-concept-band/sets/the-royal-concept-ep/token',
275         'only_matching': True,
276     }]
277
278     def _real_extract(self, url):
279         mobj = re.match(self._VALID_URL, url)
280
281         # extract uploader (which is in the url)
282         uploader = mobj.group('uploader')
283         # extract simple title (uploader + slug of song title)
284         slug_title = mobj.group('slug_title')
285         full_title = '%s/sets/%s' % (uploader, slug_title)
286         url = 'http://soundcloud.com/%s/sets/%s' % (uploader, slug_title)
287
288         token = mobj.group('token')
289         if token:
290             full_title += '/' + token
291             url += '/' + token
292
293         self.report_resolve(full_title)
294
295         resolv_url = self._resolv_url(url)
296         info = self._download_json(resolv_url, full_title)
297
298         if 'errors' in info:
299             msgs = (compat_str(err['error_message']) for err in info['errors'])
300             raise ExtractorError('unable to download video webpage: %s' % ','.join(msgs))
301
302         entries = [self.url_result(track['permalink_url'], 'Soundcloud') for track in info['tracks']]
303
304         return {
305             '_type': 'playlist',
306             'entries': entries,
307             'id': '%s' % info['id'],
308             'title': info['title'],
309         }
310
311
312 class SoundcloudUserIE(SoundcloudIE):
313     _VALID_URL = r'''(?x)
314                         https?://
315                             (?:(?:www|m)\.)?soundcloud\.com/
316                             (?P<user>[^/]+)
317                             (?:/
318                                 (?P<rsrc>tracks|sets|reposts|likes|spotlight)
319                             )?
320                             /?(?:[?#].*)?$
321                     '''
322     IE_NAME = 'soundcloud:user'
323     _TESTS = [{
324         'url': 'https://soundcloud.com/the-akashic-chronicler',
325         'info_dict': {
326             'id': '114582580',
327             'title': 'The Akashic Chronicler (All)',
328         },
329         'playlist_mincount': 111,
330     }, {
331         'url': 'https://soundcloud.com/the-akashic-chronicler/tracks',
332         'info_dict': {
333             'id': '114582580',
334             'title': 'The Akashic Chronicler (Tracks)',
335         },
336         'playlist_mincount': 50,
337     }, {
338         'url': 'https://soundcloud.com/the-akashic-chronicler/sets',
339         'info_dict': {
340             'id': '114582580',
341             'title': 'The Akashic Chronicler (Playlists)',
342         },
343         'playlist_mincount': 3,
344     }, {
345         'url': 'https://soundcloud.com/the-akashic-chronicler/reposts',
346         'info_dict': {
347             'id': '114582580',
348             'title': 'The Akashic Chronicler (Reposts)',
349         },
350         'playlist_mincount': 7,
351     }, {
352         'url': 'https://soundcloud.com/the-akashic-chronicler/likes',
353         'info_dict': {
354             'id': '114582580',
355             'title': 'The Akashic Chronicler (Likes)',
356         },
357         'playlist_mincount': 321,
358     }, {
359         'url': 'https://soundcloud.com/grynpyret/spotlight',
360         'info_dict': {
361             'id': '7098329',
362             'title': 'Grynpyret (Spotlight)',
363         },
364         'playlist_mincount': 1,
365     }]
366
367     _API_BASE = 'https://api.soundcloud.com'
368     _API_V2_BASE = 'https://api-v2.soundcloud.com'
369
370     _BASE_URL_MAP = {
371         'all': '%s/profile/soundcloud:users:%%s' % _API_V2_BASE,
372         'tracks': '%s/users/%%s/tracks' % _API_BASE,
373         'sets': '%s/users/%%s/playlists' % _API_V2_BASE,
374         'reposts': '%s/profile/soundcloud:users:%%s/reposts' % _API_V2_BASE,
375         'likes': '%s/users/%%s/likes' % _API_V2_BASE,
376         'spotlight': '%s/users/%%s/spotlight' % _API_V2_BASE,
377     }
378
379     _TITLE_MAP = {
380         'all': 'All',
381         'tracks': 'Tracks',
382         'sets': 'Playlists',
383         'reposts': 'Reposts',
384         'likes': 'Likes',
385         'spotlight': 'Spotlight',
386     }
387
388     def _real_extract(self, url):
389         mobj = re.match(self._VALID_URL, url)
390         uploader = mobj.group('user')
391
392         url = 'http://soundcloud.com/%s/' % uploader
393         resolv_url = self._resolv_url(url)
394         user = self._download_json(
395             resolv_url, uploader, 'Downloading user info')
396
397         resource = mobj.group('rsrc') or 'all'
398         base_url = self._BASE_URL_MAP[resource] % user['id']
399
400         COMMON_QUERY = {
401             'limit': 50,
402             'client_id': self._CLIENT_ID,
403             'linked_partitioning': '1',
404         }
405
406         query = COMMON_QUERY.copy()
407         query['offset'] = 0
408
409         next_href = base_url + '?' + compat_urllib_parse_urlencode(query)
410
411         entries = []
412         for i in itertools.count():
413             response = self._download_json(
414                 next_href, uploader, 'Downloading track page %s' % (i + 1))
415
416             collection = response['collection']
417             if not collection:
418                 break
419
420             def resolve_permalink_url(candidates):
421                 for cand in candidates:
422                     if isinstance(cand, dict):
423                         permalink_url = cand.get('permalink_url')
424                         if permalink_url and permalink_url.startswith('http'):
425                             return permalink_url
426
427             for e in collection:
428                 permalink_url = resolve_permalink_url((e, e.get('track'), e.get('playlist')))
429                 if permalink_url:
430                     entries.append(self.url_result(permalink_url))
431
432             next_href = response.get('next_href')
433             if not next_href:
434                 break
435
436             parsed_next_href = compat_urlparse.urlparse(response['next_href'])
437             qs = compat_urlparse.parse_qs(parsed_next_href.query)
438             qs.update(COMMON_QUERY)
439             next_href = compat_urlparse.urlunparse(
440                 parsed_next_href._replace(query=compat_urllib_parse_urlencode(qs, True)))
441
442         return {
443             '_type': 'playlist',
444             'id': compat_str(user['id']),
445             'title': '%s (%s)' % (user['username'], self._TITLE_MAP[resource]),
446             'entries': entries,
447         }
448
449
450 class SoundcloudPlaylistIE(SoundcloudIE):
451     _VALID_URL = r'https?://api\.soundcloud\.com/playlists/(?P<id>[0-9]+)(?:/?\?secret_token=(?P<token>[^&]+?))?$'
452     IE_NAME = 'soundcloud:playlist'
453     _TESTS = [{
454         'url': 'http://api.soundcloud.com/playlists/4110309',
455         'info_dict': {
456             'id': '4110309',
457             'title': 'TILT Brass - Bowery Poetry Club, August \'03 [Non-Site SCR 02]',
458             'description': 're:.*?TILT Brass - Bowery Poetry Club',
459         },
460         'playlist_count': 6,
461     }]
462
463     def _real_extract(self, url):
464         mobj = re.match(self._VALID_URL, url)
465         playlist_id = mobj.group('id')
466         base_url = '%s//api.soundcloud.com/playlists/%s.json?' % (self.http_scheme(), playlist_id)
467
468         data_dict = {
469             'client_id': self._CLIENT_ID,
470         }
471         token = mobj.group('token')
472
473         if token:
474             data_dict['secret_token'] = token
475
476         data = compat_urllib_parse_urlencode(data_dict)
477         data = self._download_json(
478             base_url + data, playlist_id, 'Downloading playlist')
479
480         entries = [self.url_result(track['permalink_url'], 'Soundcloud') for track in data['tracks']]
481
482         return {
483             '_type': 'playlist',
484             'id': playlist_id,
485             'title': data.get('title'),
486             'description': data.get('description'),
487             'entries': entries,
488         }
489
490
491 class SoundcloudSearchIE(SearchInfoExtractor, SoundcloudIE):
492     IE_NAME = 'soundcloud:search'
493     IE_DESC = 'Soundcloud search'
494     _MAX_RESULTS = float('inf')
495     _TESTS = [{
496         'url': 'scsearch15:post-avant jazzcore',
497         'info_dict': {
498             'title': 'post-avant jazzcore',
499         },
500         'playlist_count': 15,
501     }]
502
503     _SEARCH_KEY = 'scsearch'
504     _MAX_RESULTS_PER_PAGE = 200
505     _DEFAULT_RESULTS_PER_PAGE = 50
506     _API_V2_BASE = 'https://api-v2.soundcloud.com'
507
508     def _get_collection(self, endpoint, collection_id, **query):
509         limit = min(
510             query.get('limit', self._DEFAULT_RESULTS_PER_PAGE),
511             self._MAX_RESULTS_PER_PAGE)
512         query['limit'] = limit
513         query['client_id'] = self._CLIENT_ID
514         query['linked_partitioning'] = '1'
515         query['offset'] = 0
516         data = compat_urllib_parse_urlencode(query)
517         next_url = '{0}{1}?{2}'.format(self._API_V2_BASE, endpoint, data)
518
519         collected_results = 0
520
521         for i in itertools.count(1):
522             response = self._download_json(
523                 next_url, collection_id, 'Downloading page {0}'.format(i),
524                 'Unable to download API page')
525
526             collection = response.get('collection', [])
527             if not collection:
528                 break
529
530             collection = list(filter(bool, collection))
531             collected_results += len(collection)
532
533             for item in collection:
534                 yield self.url_result(item['uri'], SoundcloudIE.ie_key())
535
536             if not collection or collected_results >= limit:
537                 break
538
539             next_url = response.get('next_href')
540             if not next_url:
541                 break
542
543     def _get_n_results(self, query, n):
544         tracks = self._get_collection('/search/tracks', query, limit=n, q=query)
545         return self.playlist_result(tracks, playlist_title=query)