Adding support for podcasts in currently playing

#54

Author: witnessmenow

src/SpotifyArduino.cpp

@@ -502,11 +502,11 @@ bool SpotifyArduino::transferPlayback(const char *deviceId, bool play)
 
 int SpotifyArduino::getCurrentlyPlaying(processCurrentlyPlaying currentlyPlayingCallback, const char *market)
 {
-    char command[50] = SPOTIFY_CURRENTLY_PLAYING_ENDPOINT;
+    char command[75] = SPOTIFY_CURRENTLY_PLAYING_ENDPOINT;
     if (market[0] != 0)
     {
         char marketBuff[15];
-        sprintf(marketBuff, "?market=%s", market);
+        sprintf(marketBuff, "&market=%s", market);
         strcat(command, marketBuff);
     }
 
@@ -538,8 +538,9 @@ int SpotifyArduino::getCurrentlyPlaying(processCurrentlyPlaying currentlyPlaying
         CurrentlyPlaying current;
 
         //Apply Json Filter: https://arduinojson.org/v6/example/filter/
-        StaticJsonDocument<320> filter;
+        StaticJsonDocument<464> filter;
         filter["is_playing"] = true;
+        filter["currently_playing_type"] = true;
         filter["progress_ms"] = true;
         filter["context"]["uri"] = true;
 
@@ -561,6 +562,16 @@ int SpotifyArduino::getCurrentlyPlaying(processCurrentlyPlaying currentlyPlaying
         filter_item_album_images_0["width"] = true;
         filter_item_album_images_0["url"] = true;
 
+        // Podcast filters
+        JsonObject filter_item_show = filter_item.createNestedObject("show");
+        filter_item_show["name"] = true;
+        filter_item_show["uri"] = true;
+
+        JsonObject filter_item_images_0 = filter_item["images"].createNestedObject();
+        filter_item_images_0["height"] = true;
+        filter_item_images_0["width"] = true;
+        filter_item_images_0["url"] = true;
+
         // Allocate DynamicJsonDocument
         DynamicJsonDocument doc(bufferSize);
 
@@ -578,63 +589,131 @@ int SpotifyArduino::getCurrentlyPlaying(processCurrentlyPlaying currentlyPlaying
 #endif
             JsonObject item = doc["item"];
 
-            int numArtists = item["artists"].size();
-            if (numArtists > SPOTIFY_MAX_NUM_ARTISTS)
+            const char *currently_playing_type = doc["currently_playing_type"];
+
+            current.isPlaying = doc["is_playing"].as<bool>();
+
+            current.progressMs = doc["progress_ms"].as<long>();
+            current.durationMs = item["duration_ms"].as<long>();
+
+            // context may be null
+            if (!doc["context"].isNull())
             {
-                numArtists = SPOTIFY_MAX_NUM_ARTISTS;
+                current.contextUri = doc["context"]["uri"].as<const char *>();
             }
-            current.numArtists = numArtists;
-
-            for (int i = 0; i < current.numArtists; i++)
+            else
             {
-                current.artists[i].artistName = item["artists"][i]["name"].as<const char *>();
-                current.artists[i].artistUri = item["artists"][i]["uri"].as<const char *>();
+                current.contextUri = NULL;
             }
 
-            current.albumName = item["album"]["name"].as<const char *>();
-            current.albumUri = item["album"]["uri"].as<const char *>();
-
-            JsonArray images = item["album"]["images"];
-
-            // Images are returned in order of width, so last should be smallest.
-            int numImages = images.size();
-            int startingIndex = 0;
-            if (numImages > SPOTIFY_NUM_ALBUM_IMAGES)
+            // Check currently playing type
+            if (strcmp(currently_playing_type, "track") == 0)
+            {
+                current.currentlyPlayingType = track;
+            }
+            else if (strcmp(currently_playing_type, "episode") == 0)
             {
-                startingIndex = numImages - SPOTIFY_NUM_ALBUM_IMAGES;
-                current.numImages = SPOTIFY_NUM_ALBUM_IMAGES;
+                current.currentlyPlayingType = episode;
             }
             else
             {
-                current.numImages = numImages;
+                current.currentlyPlayingType = other;
             }
-#ifdef SPOTIFY_DEBUG
-            Serial.print(F("Num Images: "));
-            Serial.println(current.numImages);
-            Serial.println(numImages);
-#endif
 
-            for (int i = 0; i < current.numImages; i++)
+            // If it's a song/track
+            if (current.currentlyPlayingType == track)
             {
-                int adjustedIndex = startingIndex + i;
-                current.albumImages[i].height = images[adjustedIndex]["height"].as<int>();
-                current.albumImages[i].width = images[adjustedIndex]["width"].as<int>();
-                current.albumImages[i].url = images[adjustedIndex]["url"].as<const char *>();
-            }
+                int numArtists = item["artists"].size();
+                if (numArtists > SPOTIFY_MAX_NUM_ARTISTS)
+                {
+                    numArtists = SPOTIFY_MAX_NUM_ARTISTS;
+                }
+                current.numArtists = numArtists;
 
-            current.trackName = item["name"].as<const char *>();
-            current.trackUri = item["uri"].as<const char *>();
+                for (int i = 0; i < current.numArtists; i++)
+                {
+                    current.artists[i].artistName = item["artists"][i]["name"].as<const char *>();
+                    current.artists[i].artistUri = item["artists"][i]["uri"].as<const char *>();
+                }
 
-            current.isPlaying = doc["is_playing"].as<bool>();
+                current.albumName = item["album"]["name"].as<const char *>();
+                current.albumUri = item["album"]["uri"].as<const char *>();
 
-            current.progressMs = doc["progress_ms"].as<long>();
-            current.durationMs = item["duration_ms"].as<long>();
+                JsonArray images = item["album"]["images"];
 
-            // context may be null
-            if( ! doc["context"].isNull() ){
-              current.contextUri = doc["context"]["uri"].as<const char *>();
-            } else {
-              current.contextUri = NULL;
+                // Images are returned in order of width, so last should be smallest.
+                int numImages = images.size();
+                int startingIndex = 0;
+                if (numImages > SPOTIFY_NUM_ALBUM_IMAGES)
+                {
+                    startingIndex = numImages - SPOTIFY_NUM_ALBUM_IMAGES;
+                    current.numImages = SPOTIFY_NUM_ALBUM_IMAGES;
+                }
+                else
+                {
+                    current.numImages = numImages;
+                }
+#ifdef SPOTIFY_DEBUG
+                Serial.print(F("Num Images: "));
+                Serial.println(current.numImages);
+                Serial.println(numImages);
+#endif
+
+                for (int i = 0; i < current.numImages; i++)
+                {
+                    int adjustedIndex = startingIndex + i;
+                    current.albumImages[i].height = images[adjustedIndex]["height"].as<int>();
+                    current.albumImages[i].width = images[adjustedIndex]["width"].as<int>();
+                    current.albumImages[i].url = images[adjustedIndex]["url"].as<const char *>();
+                }
+
+                current.trackName = item["name"].as<const char *>();
+                current.trackUri = item["uri"].as<const char *>();
+            }
+            else if (current.currentlyPlayingType == episode) // Podcast
+            {
+                current.numArtists = 1;
+
+                // Save Podcast as the "track"
+                current.trackName = item["name"].as<const char *>();
+                current.trackUri = item["uri"].as<const char *>();
+
+                // Save Show name as the "artist"
+                current.artists[0].artistName = item["show"]["name"].as<const char *>();
+                current.artists[0].artistUri = item["show"]["uri"].as<const char *>();
+
+                // Leave "album" name blank
+                char blank[1] = "";
+                current.albumName = blank;
+                current.albumUri = blank;
+
+                // Save the episode images as the "album art"
+                JsonArray images = item["images"];
+                // Images are returned in order of width, so last should be smallest.
+                int numImages = images.size();
+                int startingIndex = 0;
+                if (numImages > SPOTIFY_NUM_ALBUM_IMAGES)
+                {
+                    startingIndex = numImages - SPOTIFY_NUM_ALBUM_IMAGES;
+                    current.numImages = SPOTIFY_NUM_ALBUM_IMAGES;
+                }
+                else
+                {
+                    current.numImages = numImages;
+                }
+#ifdef SPOTIFY_DEBUG
+                Serial.print(F("Num Images: "));
+                Serial.println(current.numImages);
+                Serial.println(numImages);
+#endif
+
+                for (int i = 0; i < current.numImages; i++)
+                {
+                    int adjustedIndex = startingIndex + i;
+                    current.albumImages[i].height = images[adjustedIndex]["height"].as<int>();
+                    current.albumImages[i].width = images[adjustedIndex]["width"].as<int>();
+                    current.albumImages[i].url = images[adjustedIndex]["url"].as<const char *>();
+                }
             }
 
             currentlyPlayingCallback(current);

src/SpotifyArduino.h

@@ -61,7 +61,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 #define SPOTIFY_DEVICE_NAME_CHAR_LENGTH 80
 #define SPOTIFY_DEVICE_TYPE_CHAR_LENGTH 30
 
-#define SPOTIFY_CURRENTLY_PLAYING_ENDPOINT "/v1/me/player/currently-playing"
+#define SPOTIFY_CURRENTLY_PLAYING_ENDPOINT "/v1/me/player/currently-playing?additional_types=episode"
 
 #define SPOTIFY_PLAYER_ENDPOINT "/v1/me/player"
 #define SPOTIFY_DEVICES_ENDPOINT "/v1/me/player/devices"
@@ -93,6 +93,13 @@ enum RepeatOptions
   repeat_off
 };
 
+enum SpotifyPlayingType
+{
+  track,
+  episode,
+  other
+};
+
 struct SpotifyImage
 {
   int height;
@@ -153,6 +160,7 @@ struct CurrentlyPlaying
   long progressMs;
   long durationMs;
   const char *contextUri;
+  SpotifyPlayingType currentlyPlayingType;
 };
 
 typedef void (*processCurrentlyPlaying)(CurrentlyPlaying currentlyPlaying);
@@ -195,7 +203,7 @@ class SpotifyArduino
   bool playerNavigate(char *command, const char *deviceId = "");
   bool seek(int position, const char *deviceId = "");
   bool transferPlayback(const char *deviceId, bool play = false);
-    
+
   //Search
   int searchForSong(String query, int limit, processSearch searchCallback, SearchResult results[]);