Add artwork image support (#1)

readme.md

@@ -1,10 +1,21 @@
 # OBS Spotify Mac
 An OBS script to display Spotify track info on macOS
 
-![screenshot](Screen%20Shot%202021-06-21%20at%2002.02.25.png)
-
 # Text Format
 ```
 {n} = Name
 {a} = Artist
-```
+```
+# Artwork Image (Browser)
+```
+Width = 640
+Height = 640
+```
+
+![screenshot](Screenshot%202022-11-24%20at%2014.41.39%402x.png)
+![screenshot](Screenshot%202022-11-24%20at%2014.41.59%402x.png)
+
+# Change log
+- 1.0: Initial release
+- 1.1: Fixed something
+- 1.2: Add artwork image (#1)

spotify.lua

@@ -5,47 +5,60 @@
 
 obs = obslua
 
-source_name = ""
+source_name_text = ""
 format_playing = ""
 format_paused = ""
 interval = 1
+source_name_browser = ""
 
 function update_text(source)
     local result = spotify()
     local text = "[Spofity not running]"
+    local artwork = ""
     if result ~= "" then
         result = split(result, ", ")
         local paused = (result[1] == "paused")
         local format = paused and format_paused or format_playing
         text = format:gsub("{n}", result[2]):gsub("{a}", result[3])
+        artwork = result[4]
     end
 
     local settings = obs.obs_data_create()
-    obs.obs_data_set_string(settings, "text", text)
+    if obs.obs_source_get_id(source) == 'browser_source' then
+        obs.obs_data_set_string(settings, "url", artwork)
+        -- obs.obs_data_set_string(settings, "width", 640)
+        -- obs.obs_data_set_string(settings, "height", 640)
+    else
+        obs.obs_data_set_string(settings, "text", text)
+    end
     obs.obs_source_update(source, settings)
     obs.obs_data_release(settings)
+
 end
 
 function timer()
-    local source = obs.obs_get_source_by_name(source_name) --> obs_source_t
-    if source ~= nil then
-        local current_scene_source = obs.obs_frontend_get_current_scene() --> obs_source_t
-        local current_scene = obs.obs_scene_from_source(current_scene_source) --> obs_scene_t
-        local scene_item = obs.obs_scene_find_source_recursive(current_scene, source_name) --> obs_sceneitem_t
-
-        if (scene_item ~= nil) and obs.obs_sceneitem_visible(scene_item) then
-            update_text(source)
+    for i, source_name in ipairs({source_name_text, source_name_browser}) do
+        local source = obs.obs_get_source_by_name(source_name) --> obs_source_t
+        if source ~= nil then
+            local current_scene_source = obs.obs_frontend_get_current_scene() --> obs_source_t
+            local current_scene = obs.obs_scene_from_source(current_scene_source) --> obs_scene_t
+            local scene_item = obs.obs_scene_find_source_recursive(current_scene, source_name) --> obs_sceneitem_t
+
+            if (scene_item ~= nil) and obs.obs_sceneitem_visible(scene_item) then
+                update_text(source)
+            end
+            obs.obs_source_release(current_scene_source)
         end
-        obs.obs_source_release(current_scene_source)
+        obs.obs_source_release(source)
     end
-    obs.obs_source_release(source)
 end
 
 function restart_timer(settings)
-    source_name = obs.obs_data_get_string(settings, "source_name")
+    source_name_text = obs.obs_data_get_string(settings, "source_name_text")
     format_playing = obs.obs_data_get_string(settings, "format_playing")
     format_paused = obs.obs_data_get_string(settings, "format_paused")
     interval = obs.obs_data_get_int(settings, "interval")
+    source_name_browser = obs.obs_data_get_string(settings, "source_name_browser")
 
     obs.timer_remove(timer)
     obs.timer_add(timer, interval * 1000)
@@ -55,7 +68,13 @@ function spotify()
     local cmd = "osascript -e " .. [['
     if application "Spotify" is running then
         tell application "Spotify"
-            return {the player state, the name of the current track, the artist of the current track}
+            return {¬
+                the player state, ¬
+                the name of the current track, ¬
+                the artist of the current track, ¬
+                the artwork url of the current track, ¬
+                (the player position) / (the (duration of the current track) / 1000) ¬
+                }
         end tell
     else
         error "Spotify not running."
@@ -83,29 +102,35 @@ function script_description()
         <h2>Spotify Mac</h2>
         <h4>Display Now Playing Track Info</h4>
         <p>{n} = Name &nbsp;&nbsp;&nbsp; {a} = Artist</p>
-        <p style="font-size: 11pt;"><i><a href="https://github.com/RayPS/obs-spotify-mac">version 1.1</a></i></p>
+        <p style="font-size: 11pt;"><i><a href="https://github.com/RayPS/obs-spotify-mac">version 1.2</a></i></p>
     </center></body></HTML>]]
 end
 
 function script_properties()
     local props = obs.obs_properties_create()
 
-    local p = obs.obs_properties_add_list(props, "source_name", "Text source", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING)
+    local list_text = obs.obs_properties_add_list(props, "source_name_text", "Text Source", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING)
+    obs.obs_properties_add_int(props, "interval", "Update Interval (s)", 1, 60, 1)
+    obs.obs_properties_add_text(props, "format_playing", "Playing Format", obs.OBS_TEXT_DEFAULT)
+    obs.obs_properties_add_text(props, "format_paused", "Paused Format", obs.OBS_TEXT_DEFAULT)
+    obs.obs_properties_add_text(props, "info_text_artwork", "Artwork Image (640×640):", obs.OBS_TEXT_INFO)
+    local list_browser = obs.obs_properties_add_list(props, "source_name_browser", "Browser Source", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING)
+
     local sources = obs.obs_enum_sources()
     if sources ~= nil then
         for _, source in ipairs(sources) do
             source_id = obs.obs_source_get_unversioned_id(source)
             if source_id == "text_gdiplus" or source_id == "text_ft2_source" then
                 local name = obs.obs_source_get_name(source)
-                obs.obs_property_list_add_string(p, name, name)
+                obs.obs_property_list_add_string(list_text, name, name)
+            elseif source_id == "browser_source" then
+                local name = obs.obs_source_get_name(source)
+                obs.obs_property_list_add_string(list_browser, name, name)
             end
         end
     end
     obs.source_list_release(sources)
 
-    obs.obs_properties_add_int(props, "interval", "Update Interval (s)", 1, 60, 1)
-    obs.obs_properties_add_text(props, "format_playing", "Playing Format", obs.OBS_TEXT_DEFAULT)
-    obs.obs_properties_add_text(props, "format_paused", "Paused Format", obs.OBS_TEXT_DEFAULT)
     return props
 end
 
@@ -118,9 +143,9 @@ end
 
 function script_update(settings)
     print("script_update")
-    if source_name ~= nil then
+    if source_name_text ~= nil then
         restart_timer(settings)
     else
-        print("source_name not set")
+        print("source_name_text not set")
     end
 end