add framerate to playlist and parser

Author: anxdpanic

resources/lib/twitch/api/usher.py

@@ -71,6 +71,7 @@ def live_request(channel):
         q.add_param(keys.FAST_BREAD, Boolean.TRUE)
         q.add_param(keys.CDM, keys.WV)
         q.add_param(keys.REASSIGNMENT_SUPPORTED, Boolean.TRUE)
+        q.add_param(keys.PLAYLIST_INCLUDE_FRAMERATE, Boolean.TRUE)
         q.add_param(keys.RTQOS, keys.CONTROL)
         q.add_param(keys.PLAYER_BACKEND, keys.MEDIAPLAYER)
         url = '?'.join([q.url, urlencode(q.params)])
@@ -91,6 +92,7 @@ def _live(channel, token):
     q.add_param(keys.FAST_BREAD, Boolean.TRUE)
     q.add_param(keys.CDM, keys.WV)
     q.add_param(keys.REASSIGNMENT_SUPPORTED, Boolean.TRUE)
+    q.add_param(keys.PLAYLIST_INCLUDE_FRAMERATE, Boolean.TRUE)
     q.add_param(keys.RTQOS, keys.CONTROL)
     q.add_param(keys.PLAYER_BACKEND, keys.MEDIAPLAYER)
     return q
@@ -120,6 +122,7 @@ def video_request(video_id):
             q.add_param(keys.ALLOW_AUDIO_ONLY, Boolean.TRUE)
             q.add_param(keys.CDM, keys.WV)
             q.add_param(keys.REASSIGNMENT_SUPPORTED, Boolean.TRUE)
+            q.add_param(keys.PLAYLIST_INCLUDE_FRAMERATE, Boolean.TRUE)
             q.add_param(keys.RTQOS, keys.CONTROL)
             q.add_param(keys.PLAYER_BACKEND, keys.MEDIAPLAYER)
             q.add_param(keys.BAKING_BREAD, Boolean.TRUE)
@@ -143,6 +146,7 @@ def _vod(video_id, token):
     q.add_param(keys.ALLOW_AUDIO_ONLY, Boolean.TRUE)
     q.add_param(keys.CDM, keys.WV)
     q.add_param(keys.REASSIGNMENT_SUPPORTED, Boolean.TRUE)
+    q.add_param(keys.PLAYLIST_INCLUDE_FRAMERATE, Boolean.TRUE)
     q.add_param(keys.RTQOS, keys.CONTROL)
     q.add_param(keys.PLAYER_BACKEND, keys.MEDIAPLAYER)
     q.add_param(keys.BAKING_BREAD, Boolean.TRUE)

resources/lib/twitch/keys.py

@@ -82,6 +82,7 @@
 PERIOD = 'period'
 PLATFORM = 'platform'
 PLAYER_BACKEND = 'player_backend'
+PLAYLIST_INCLUDE_FRAMERATE = 'playlist_include_framerate'
 POSITION = 'position'
 POST_ID = 'post_id'
 QUERY = 'query'

resources/lib/twitch/parser.py

@@ -20,12 +20,30 @@
     r'GROUP-ID="(?P<group_id>[^"]*)",'
     r'NAME="(?P<group_name>[^"]*)"[,=\w]*\n'
     r'#EXT-X-STREAM-INF:.*'
-    r'BANDWIDTH=(?P<bandwidth>[0-9]+).*\n('
-    r'?P<url>http.*)')
+    r'BANDWIDTH=(?P<bandwidth>[0-9]+),'
+    r'(?:.*FRAME-RATE=(?P<fps>[0-9.]+))?.*\n'
+    r'(?P<url>http.*)')
 
 _error_pattern = re.compile(r'.*<tr><td><b>error</b></td><td>(?P<message>.+?)</td></tr>.*', re.IGNORECASE)
 
 
+def _find_frame_rate(group_id, group_name):
+    group_id = group_id.lower()
+
+    if group_id == 'audio_only':
+        return None
+    elif group_id == 'chunked':
+        group_id = group_name.lower().replace('(source)', '').strip()
+
+    info = group_id.split('p')
+    if len(info) > 1 and info[1]:
+        fps = float(info[1])
+    else:
+        fps = 30.0
+
+    return fps
+
+
 def m3u8(f):
     def m3u8_wrapper(*args, **kwargs):
         results = f(*args, **kwargs)
@@ -54,13 +72,24 @@ def m3u8_to_dict(string):
     d = dict()
     matches = re.finditer(_m3u_pattern, string)
     for m in matches:
-        name = 'Audio Only' if m.group('group_name') == 'audio_only' else m.group('group_name')
-        name = 'Source' if m.group('group_id') == 'chunked' else name
+        if m.group('group_name') == 'audio_only':
+            name = 'Audio Only'
+        elif m.group('group_id') == 'chunked':
+            name = 'Source'
+        else:
+            name = m.group('group_name')
+
+        if m.group('fps'):
+            fps = float(m.group('fps'))
+        else:
+            fps = _find_frame_rate(m.group('group_id'), m.group('group_name'))
+
         d[m.group('group_id')] = {
             'id': m.group('group_id'),
             'name': name,
             'url': m.group('url'),
-            'bandwidth': int(m.group('bandwidth'))
+            'bandwidth': int(m.group('bandwidth')),
+            'fps': fps
         }
     log.debug('m3u8_to_dict result:\n{0}'.format(d))
     return d
@@ -71,13 +100,24 @@ def m3u8_to_list(string):
     l = list()
     matches = re.finditer(_m3u_pattern, string)
     for m in matches:
-        name = 'Audio Only' if m.group('group_name') == 'audio_only' else m.group('group_name')
-        name = 'Source' if m.group('group_id') == 'chunked' else name
+        if m.group('group_name') == 'audio_only':
+            name = 'Audio Only'
+        elif m.group('group_id') == 'chunked':
+            name = 'Source'
+        else:
+            name = m.group('group_name')
+
+        if m.group('fps'):
+            fps = float(m.group('fps'))
+        else:
+            fps = _find_frame_rate(m.group('group_id'), m.group('group_name'))
+
         l.append({
             'id': m.group('group_id'),
             'name': name,
             'url': m.group('url'),
-            'bandwidth': int(m.group('bandwidth'))
+            'bandwidth': int(m.group('bandwidth')),
+            'fps': fps
         })
 
     log.debug('m3u8_to_list result:\n{0}'.format(l))
@@ -96,11 +136,11 @@ def clip_embed_to_list(response):
 
     if qualities:
         l = [{
-                 'id': item['quality'],
-                 'name': item['quality'],
-                 'url': item['source'],
-                 'bandwidth': -1
-             } for item in qualities]
+            'id': item['quality'],
+            'name': item['quality'],
+            'url': item['source'],
+            'bandwidth': -1
+        } for item in qualities]
         if l:
             l.insert(0, {
                 'id': 'Source',