Changes how things display in the app, and some code changes to accommodate that.

Root category now includes the active episodes (loads quickly), and the
active episodes playlist can now be played at once (slower!).

Author: antonino-u

README.md

@@ -1,6 +1,6 @@
 # Play [Overcast](https://overcast.fm/) podcasts on your Sonos.
 
-* Fast! 
+* Fast!
 * Remembers last played position
 * Syncs play position back to the Overcast service every 30 seconds or when paused/stopped
 * Removes episodes from Overcast when completed
@@ -16,9 +16,10 @@ Usage:
     - SID - some unique SID (255 works if you've not done this before
     - Service Name - some name, `overcast` works
     - Endpoint URL and Secure Endpoint URL: `http://<YOUR_IP>:8140/overcast-sonos`
+    - Presentation map: version = 1, Uri = `http://<YOUR_IP>:8140/presentation_map`
     - Authentication SOAP header policy: "Anonymous"
-    - Check the boxes in the example picture
+    - Check the boxes in the [example screenshot](./customsd_example.png)
 
  1. In your Sonos controller, go to "Add Music Service", then add the service above.
 
- See the [TODO list](./TODO.md) for some nice-to-haves .
+ See the [TODO list](./TODO.md) for some nice-to-haves.

Screen Shot 2016-12-18 at 10.56.14 PM.png

@@ -8,6 +8,32 @@
 logging.basicConfig(level=logging.DEBUG)
 log = logging.getLogger('overcast-sonos')
 
+list_active_episodes_in_root = True
+allow_all_active_episodes_as_playlist = True
+
+
+class customSOAPHandler(SOAPHandler):
+
+    def do_GET(self):
+        log.debug('PATH ==> %s', self.path)
+        if self.path == '/presentation_map':
+            self.send_response(200)
+            self.send_header('Content-type', 'text/xml')
+            self.end_headers()
+            self.wfile.write('''<?xml version="1.0" encoding="UTF-8"?>
+            <Presentation>
+                <PresentationMap type="DisplayType">
+                    <RootNodeDisplayType>
+                        <DisplayMode>LIST</DisplayMode>
+                    </RootNodeDisplayType>
+                </PresentationMap>
+            </Presentation>
+            ''')
+            return
+        else:
+            return SOAPHandler.do_GET(self)
+
+
 dispatcher = SoapDispatcher('overcast-sonos',
                             location='http://localhost:8140/',
                             namespace='http://www.sonos.com/Services/1.1',
@@ -63,30 +89,51 @@ def getSessionId(username, password):
 ###
 
 
-def getMetadata(id, index, count):
-    log.debug('at=getMetadata id=%s index=%s count=%s', id, index, count)
+def getMetadata(id, index, count, recursive=False):
+    log.debug('at=getMetadata id=%s index=%s count=%s recursive=%s', id, index, count, recursive)
 
     if id == 'root':
-        response = {'getMetadataResult': [
-            {'index': 0, 'count': 2, 'total': 2},
-            {'mediaCollection': {
-                'id': 'episodes',
-                'title': 'All Active Episodes',
-                'itemType': 'container',
-                'canPlay': False,
-                'albumArtURI': 'http://is2.mzstatic.com/image/thumb/Purple62/v4/22/c7/93/22c793a7-55a8-e72b-756c-90641e7b96d4/source/175x175bb.jpg',
-            }},
+        response = {'getMetadataResult': []}
+        response['getMetadataResult'].append(
             {'mediaCollection': {
                 'id': 'podcasts',
                 'title': 'Podcasts',
-                'itemType': 'container',
+                'itemType': 'albumList',
                 'canPlay': False,
                 'albumArtURI': 'http://is2.mzstatic.com/image/thumb/Purple62/v4/22/c7/93/22c793a7-55a8-e72b-756c-90641e7b96d4/source/175x175bb.jpg',
-            }},
-        ]}
+            }})
+        response['getMetadataResult'].append(
+                {'mediaCollection': {
+                    'id': 'episodes',
+                    'title': 'All Active Episodes',
+                    'itemType': 'playlist',
+                    'canPlay': allow_all_active_episodes_as_playlist,
+                    'albumArtURI': 'http://is2.mzstatic.com/image/thumb/Purple62/v4/22/c7/93/22c793a7-55a8-e72b-756c-90641e7b96d4/source/175x175bb.jpg',
+                }})
+        if list_active_episodes_in_root:
+            all_episodes = overcast.get_active_episodes()
+            episodes = all_episodes[index:index+count]
+            response['getMetadataResult'].append({'index': index, 'count': len(episodes) + 2, 'total': len(all_episodes) + 2})
+            for episode in episodes:
+                response['getMetadataResult'].append({
+                    'mediaMetadata': {
+                        'id': 'episodes/' + episode['id'],
+                        'title': episode['podcast_title'] + " - " + episode['title'],
+                        'mimeType': episode['audio_type'],
+                        'itemType': 'track',
+                        'trackMetadata': {
+                            'artist': episode['podcast_title'],
+                            'album': episode['podcast_title'],
+                            'albumArtist': episode['podcast_title'],
+                            'albumArtURI': episode['albumArtURI'],
+                            'genreId': 'podcast',
+                            'canResume': True,
+                        }
+                    }
+                })
 
     elif id == 'episodes':
-        all_episodes = overcast.get_active_episodes()
+        all_episodes = overcast.get_active_episodes(get_details=recursive)
         episodes = all_episodes[index:index+count]
         response = {'getMetadataResult': [{'index': index, 'count': len(episodes), 'total': len(all_episodes)}]}
         for episode in episodes:
@@ -101,6 +148,7 @@ def getMetadata(id, index, count):
                         'albumArtist': episode['podcast_title'],
                         'albumArtURI': episode['albumArtURI'],
                         'genreId': 'podcast',
+                        'duration': episode['duration'],
                         'canResume': True,
                     }
                 }
@@ -115,7 +163,7 @@ def getMetadata(id, index, count):
                 'id': 'podcasts/' + podcast['id'],
                 'title': podcast['title'],
                 'albumArtURI': podcast['albumArtURI'],
-                'itemType': 'container',
+                'itemType': 'album',
                 'canPlay': False,
             }})
 
@@ -152,7 +200,7 @@ def getMetadata(id, index, count):
 dispatcher.register_function(
     'getMetadata', getMetadata,
     returns={'getMetadataResult': {'index': int, 'count': int, 'total': int, 'mediaCollection': mediaCollection}},
-    args={'id': str, 'index': int, 'count': int}
+    args={'id': str, 'index': int, 'count': int, 'recursive': bool}
 )
 
 ###
@@ -161,6 +209,7 @@ def getMetadata(id, index, count):
 def getMediaMetadata(id):
     log.debug('at=getMediaMetadata id=%s', id)
     _, episode_id = id.rsplit('/', 1)
+    log.debug('at=getMediaMetadata episode_id=%s', episode_id)
     episode = overcast.get_episode_detail(episode_id)
     response = {'getMediaMetadataResult': {
         'mediaMetadata': {
@@ -204,7 +253,7 @@ def getMediaURI(id):
                         'offsetMillis': episode['offsetMillis']
                     },
                 }
-    log.debug('at=getMediaMetadata response=%s', response)
+    log.debug('at=getMediaURI response=%s', response)
     return response
 
 
@@ -246,7 +295,7 @@ def reportPlaySeconds(id, seconds, offsetMillis, contextId):
 )
 
 
-def reportPlayStatus(id, status, contextId, offsetMillis):
+def reportPlayStatus(id, status, offsetMillis, contextId):
     episode_id = id.rsplit('/', 1)[-1]
     log.debug('at=reportPlayStatus and id=%s, status=%s, contextId=%s, offsetMillis=%d, episode_id=%s', id, status, contextId, offsetMillis, episode_id)
     episode = overcast.get_episode_detail(episode_id)
@@ -273,8 +322,9 @@ def setPlayedSeconds(id, seconds, offsetMillis, contextId):
     args={'id': str, 'seconds': int, 'offsetMillis': int, 'contextId': str}
 )
 
+
 if __name__ == '__main__':
     log.info('at=start')
-    httpd = HTTPServer(("", 8140), SOAPHandler)
+    httpd = HTTPServer(("", 8140), customSOAPHandler)
     httpd.dispatcher = dispatcher
     httpd.serve_forever()

customsd_example.png

@@ -26,21 +26,23 @@ def __init__(self, email, password):
     def _get_html(self, url):
         return lxml.html.fromstring(self.session.get(url).content)
 
-    def get_active_episodes(self):
+    def get_active_episodes(self, get_details=False):
+        active_episodes = []
         doc = self._get_html('https://overcast.fm/podcasts')
-        return [
-            # NOTE: If the hardcoded audio_type causes any problems, just uncomment the line below and comment out the dictionary below it.
-            # self.get_episode_detail(cell.attrib['href'])
-            {
-                'id': urlparse.urljoin('https://overcast.fm', cell.attrib['href']).lstrip('/'),
-                'title': cell.cssselect('div.titlestack div.title')[0].text_content(),
-                'audio_type': 'audio/mpeg',
-                'podcast_title': cell.cssselect('div.titlestack div.caption2')[0].text_content(),
-                'albumArtURI': cell.cssselect('img')[0].attrib['src'],
-            }
-            for cell in doc.cssselect('a.episodecell')
-            if 'href' in cell.attrib
-        ]
+        for cell in doc.cssselect('a.episodecell'):
+            if 'href' in cell.attrib:
+                if get_details:
+                    active_episodes.append(self.get_episode_detail(cell.attrib['href']))
+                else:
+                    active_episodes.append({
+                        'id': urlparse.urljoin('https://overcast.fm', cell.attrib['href']).lstrip('/'),
+                        'title': cell.cssselect('div.titlestack div.title')[0].text_content(),
+                        'audio_type': 'audio/mpeg',
+                        'podcast_title': cell.cssselect('div.titlestack div.caption2')[0].text_content(),
+                        'albumArtURI': cell.cssselect('img')[0].attrib['src'],
+                        'duration': -1,
+                    })
+        return active_episodes
 
     def get_episode_detail(self, episode_id):
         episode_href = urlparse.urljoin('https://overcast.fm', episode_id)