Add playerctl support (#108)

jlo62 · ErikReider · web-flow · commit fced2ee598a7 · 2025-03-01T15:36:12.000+01:00
* rebase off main * fix 2 unused errors * update to GTK4 * add cargo.lock * resolve merge conflict #2 * cargo fmt * implement Arc for config to avoid cloning often * cargo fmt * Add default config examples * add config files * fix cargo fmt because "version" is deprecated and has been superseeded by "style_edition". 2021 should be equivelent to the onle "One" * resolve conversations * add track_list stuff and fallback to delaying * d * cargo fmt * get rid of ghost changes while rebasing * capitalize to resolve compile issues * Fixed my nits --------- Co-authored-by: Erik Reider <35975961+ErikReider@users.noreply.github.com>
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -42,3 +42,6 @@ blight = "0.7.0"
 anyhow = "1.0.75"
 thiserror = "1.0.49"
 async-channel = "2.3.1"
+mpris = "2.0.1"
+runtime-format = "0.1.3"
+strfmt = "0.2.4"
diff --git a/data/config/backend.toml b/data/config/backend.toml
@@ -0,0 +1 @@
+[input]
diff --git a/data/config/config.toml b/data/config/config.toml
@@ -0,0 +1,19 @@
+[client]
+## style file for the OSD
+# style = /etc/xdg/swayosd/style.css
+
+## on which height to show the OSD
+# top_margin = 0.85
+
+## The maximum volume that can be reached in %
+# max_volume = 150
+
+## show percentage on the right of the OSD
+# show_percentage = true
+
+## set format for the media player OSD
+# playerctl_format = "{artist} - {title}"
+## Available values:
+## artist, albumArtist, title, album, trackNumber, discNumber, autoRating
+
+[server]
diff --git a/data/icons/scalable/status/pause-large-symbolic.svg b/data/icons/scalable/status/pause-large-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><g fill="#222222"><path d="m 13.003906 1 h -3 c -0.554687 0 -1 0.449219 -1 1 v 12 c 0 0.550781 0.445313 1 1 1 h 3 c 0.550782 0 1 -0.449219 1 -1 v -12 c 0 -0.550781 -0.449218 -1 -1 -1 z m 0 0"/><path d="m 6.003906 1 h -3 c -0.554687 0 -1 0.449219 -1 1 v 12 c 0 0.550781 0.445313 1 1 1 h 3 c 0.550782 0 1 -0.449219 1 -1 v -12 c 0 -0.550781 -0.449218 -1 -1 -1 z m 0 0"/></g></svg>
diff --git a/data/icons/scalable/status/play-large-symbolic.svg b/data/icons/scalable/status/play-large-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><path d="m 2.003906 13.492188 v -11 c 0 -1.5 1.265625 -1.492188 1.265625 -1.492188 h 0.132813 c 0.246094 0 0.484375 0.054688 0.699218 0.175781 l 9.796876 5.597657 c 0.433593 0.238281 0.65625 0.730468 0.65625 1.222656 c 0 0.492187 -0.222657 0.984375 -0.65625 1.226562 l -9.796876 5.597656 c -0.214843 0.121094 -0.453124 0.175782 -0.699218 0.171876 h -0.132813 s -1.265625 0 -1.265625 -1.5 z m 0 0" fill="#222222"/></svg>
diff --git a/data/icons/scalable/status/playlist-consecutive-symbolic.svg b/data/icons/scalable/status/playlist-consecutive-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><path d="m 12 1 v 2 h -12 v 2 h 12 v 2 h 1 v -0.007812 c 0.265625 0.003906 0.519531 -0.101563 0.707031 -0.285157 l 2 -2 c 0.390625 -0.390625 0.390625 -1.023437 0 -1.414062 l -2 -2 c -0.1875 -0.183594 -0.441406 -0.289063 -0.707031 -0.285157 v -0.007812 z m 0 8 v 2 h -12 v 2 h 12 v 2 h 1 v -0.007812 c 0.265625 0.003906 0.519531 -0.101563 0.707031 -0.285157 l 2 -2 c 0.390625 -0.390625 0.390625 -1.023437 0 -1.414062 l -2 -2 c -0.1875 -0.183594 -0.441406 -0.289063 -0.707031 -0.285157 v -0.007812 z m 0 0" fill="#222222"/></svg>
diff --git a/data/icons/scalable/status/playlist-shuffle-symbolic.svg b/data/icons/scalable/status/playlist-shuffle-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><path d="m 12 1 v 2 h -3 c -0.859375 0 -1.59375 0.480469 -2.011719 1.007812 c -0.417969 0.523438 -0.648437 1.074219 -0.882812 1.542969 l -0.105469 0.210938 l -0.105469 -0.210938 c -0.191406 -0.382812 -0.386719 -0.816406 -0.671875 -1.25 c -0.414062 -0.632812 -1.207031 -1.300781 -2.222656 -1.300781 h -3 v 2 h 3 c 0.296875 0 0.316406 0.039062 0.550781 0.398438 c 0.164063 0.246093 0.34375 0.625 0.554688 1.050781 l 0.777343 1.550781 l -0.777343 1.550781 c -0.261719 0.523438 -0.476563 0.96875 -0.65625 1.199219 c -0.183594 0.226562 -0.199219 0.25 -0.449219 0.25 h -3 v 2 h 3 c 0.859375 0 1.59375 -0.480469 2.011719 -1.007812 c 0.417969 -0.523438 0.648437 -1.074219 0.882812 -1.542969 l 0.105469 -0.210938 l 0.105469 0.210938 c 0.164062 0.328125 0.335937 0.703125 0.5625 1.078125 c 0.414062 0.6875 1.222656 1.472656 2.332031 1.472656 h 3 v 2 h 1 v -0.007812 c 0.265625 0.003906 0.519531 -0.101563 0.707031 -0.285157 l 2 -2 c 0.390625 -0.390625 0.390625 -1.023437 0 -1.414062 l -2 -2 c -0.1875 -0.183594 -0.441406 -0.289063 -0.707031 -0.285157 v -0.007812 h -1 v 2 h -3 c -0.324219 0 -0.351562 -0.058594 -0.617188 -0.503906 c -0.148437 -0.242188 -0.304687 -0.574219 -0.488281 -0.945313 l -0.777343 -1.550781 l 0.777343 -1.550781 c 0.261719 -0.523438 0.476563 -0.96875 0.65625 -1.199219 c 0.183594 -0.226562 0.199219 -0.25 0.449219 -0.25 h 3 v 2 h 1 v -0.007812 c 0.265625 0.003906 0.519531 -0.101563 0.707031 -0.285157 l 2 -2 c 0.390625 -0.390625 0.390625 -1.023437 0 -1.414062 l -2 -2 c -0.1875 -0.183594 -0.441406 -0.289063 -0.707031 -0.285157 v -0.007812 z m 0 0" fill="#222222"/></svg>
diff --git a/data/icons/scalable/status/seek-backward-large-symbolic.svg b/data/icons/scalable/status/seek-backward-large-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><g fill="#222222"><path d="m 7.003906 4.003906 c -0.183594 -0.003906 -0.359375 0.046875 -0.515625 0.140625 l -5 3 c -0.648437 0.386719 -0.648437 1.328125 0 1.714844 l 5 3 c 0.15625 0.09375 0.332031 0.140625 0.515625 0.140625 v 0.003906 c 1 -0.003906 1 -1 1 -1 v -6 s 0.003906 -1 -1 -1 z m 0 0"/><path d="m 14.003906 4.003906 c -0.183594 -0.003906 -0.359375 0.046875 -0.515625 0.140625 l -5 3 c -0.648437 0.386719 -0.648437 1.328125 0 1.714844 l 5 3 c 0.15625 0.09375 0.332031 0.140625 0.515625 0.140625 v 0.003906 c 1 -0.003906 1 -1 1 -1 v -6 s 0.003906 -1 -1 -1 z m 0 0"/></g></svg>
diff --git a/data/icons/scalable/status/seek-forward-large-symbolic.svg b/data/icons/scalable/status/seek-forward-large-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><g fill="#222222"><path d="m 2.003906 4 c 0.179688 0 0.355469 0.046875 0.511719 0.140625 l 5 3 c 0.648437 0.386719 0.648437 1.328125 0 1.71875 l -5 3 c -0.15625 0.089844 -0.332031 0.140625 -0.511719 0.140625 c -1 0 -1 -1 -1 -1 v -6 s -0.003906 -1 1 -1 z m 0 0"/><path d="m 9.003906 4 c 0.179688 0 0.355469 0.046875 0.511719 0.140625 l 5 3 c 0.648437 0.386719 0.648437 1.328125 0 1.71875 l -5 3 c -0.15625 0.089844 -0.332031 0.140625 -0.511719 0.140625 c -1 0 -1 -1 -1 -1 v -6 s -0.003906 -1 1 -1 z m 0 0"/></g></svg>
diff --git a/data/icons/scalable/status/stop-large-symbolic.svg b/data/icons/scalable/status/stop-large-symbolic.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" height="16px" viewBox="0 0 16 16" width="16px"><path d="m 3.503906 2 h 9 c 0.828125 0 1.5 0.671875 1.5 1.5 v 9 c 0 0.828125 -0.671875 1.5 -1.5 1.5 h -9 c -0.828125 0 -1.5 -0.671875 -1.5 -1.5 v -9 c 0 -0.828125 0.671875 -1.5 1.5 -1.5 z m 0 0" fill="#222222"/></svg>
diff --git a/data/meson.build b/data/meson.build
@@ -70,3 +70,7 @@ style_css = custom_target(
 )
 
 message(style_css.full_path())
+
+install_data(['config/config.toml', 'config/backend.toml'],
+  install_dir : config_path
+)
diff --git a/data/swayosd.gresource.xml b/data/swayosd.gresource.xml
@@ -18,5 +18,13 @@
     <file>icons/scalable/status/source-volume-medium-symbolic.svg</file>
     <file>icons/scalable/status/source-volume-low-symbolic.svg</file>
     <file>icons/scalable/status/source-volume-muted-symbolic.svg</file>
+
+    <file>icons/scalable/status/pause-large-symbolic.svg</file>
+    <file>icons/scalable/status/play-large-symbolic.svg</file>
+    <file>icons/scalable/status/seek-backward-large-symbolic.svg</file>
+    <file>icons/scalable/status/seek-forward-large-symbolic.svg</file>
+    <file>icons/scalable/status/playlist-consecutive-symbolic.svg</file>
+    <file>icons/scalable/status/playlist-shuffle-symbolic.svg</file>
+    <file>icons/scalable/status/stop-large-symbolic.svg</file>
   </gresource>
 </gresources>
diff --git a/rustfmt.toml b/rustfmt.toml
@@ -55,7 +55,7 @@ match_block_trailing_comma = false
 blank_lines_upper_bound = 1
 blank_lines_lower_bound = 0
 edition = "2015"
-version = "One"
+style_edition = "2021"
 inline_attribute_width = 0
 format_generated_files = true
 merge_derives = true
diff --git a/src/argtypes.rs b/src/argtypes.rs
@@ -8,6 +8,7 @@ pub enum ArgTypes {
 	TopMargin = isize::MIN + 1,
 	MaxVolume = isize::MIN + 2,
 	CustomIcon = isize::MIN + 3,
+	Player = isize::MIN + 4,
 	// Other
 	None = 0,
 	CapsLock = 1,
@@ -23,6 +24,7 @@ pub enum ArgTypes {
 	NumLock = 10,
 	ScrollLock = 11,
 	CustomMessage = 13,
+	Playerctl = 14,
 }
 
 impl fmt::Display for ArgTypes {
@@ -46,6 +48,8 @@ impl fmt::Display for ArgTypes {
 			ArgTypes::TopMargin => "TOP-MARGIN",
 			ArgTypes::CustomMessage => "CUSTOM-MESSAGE",
 			ArgTypes::CustomIcon => "CUSTOM-ICON",
+			ArgTypes::Playerctl => "PLAYERCTL",
+			ArgTypes::Player => "PLAYER",
 		};
 		return write!(f, "{}", string);
 	}
@@ -73,6 +77,8 @@ impl str::FromStr for ArgTypes {
 			"TOP-MARGIN" => ArgTypes::TopMargin,
 			"CUSTOM-MESSAGE" => ArgTypes::CustomMessage,
 			"CUSTOM-ICON" => ArgTypes::CustomIcon,
+			"PLAYERCTL" => ArgTypes::Playerctl,
+			"PLAYER" => ArgTypes::Player,
 			other_type => return Err(other_type.to_owned()),
 		};
 		Ok(result)
diff --git a/src/client/main.rs b/src/client/main.rs
@@ -26,7 +26,7 @@ trait Server {
 	async fn handle_action(&self, arg_type: String, data: String) -> zbus::Result<bool>;
 }
 
-pub fn get_proxy() -> zbus::Result<ServerProxyBlocking<'static>> {
+fn get_proxy() -> zbus::Result<ServerProxyBlocking<'static>> {
 	let connection = Connection::session()?;
 	Ok(ServerProxyBlocking::new(&connection)?)
 }
@@ -156,6 +156,16 @@ fn main() -> Result<(), glib::Error> {
 		"Shows brightness osd and raises or loweres all available sources of brightness device",
 		Some("raise|lower|(±)number"),
 	);
+
+	// Control players cmdline arg
+	app.add_main_option(
+		"playerctl",
+		glib::Char::from(0),
+		OptionFlags::NONE,
+		OptionArg::String,
+		"Shows Playerctl osd and runs the playerctl command",
+		Some("play-pause|play|pause|stop|next|prev|shuffle"),
+	);
 	app.add_main_option(
 		"max-volume",
 		glib::Char::from(0),
@@ -172,6 +182,14 @@ fn main() -> Result<(), glib::Error> {
 		"For which device to increase/decrease audio",
 		Some("Pulseaudio device name (pactl list short sinks|sources)"),
 	);
+	app.add_main_option(
+		"player",
+		glib::Char::from(0),
+		OptionFlags::NONE,
+		OptionArg::String,
+		"For which player to run the playerctl commands",
+		Some("auto|all|(playerctl -l)"),
+	);
 
 	app.add_main_option(
 		"custom-message",
diff --git a/src/config/user.rs b/src/config/user.rs
@@ -9,13 +9,14 @@ use std::path::PathBuf;
 #[serde(deny_unknown_fields)]
 pub struct ClientConfig {}
 
-#[derive(Deserialize, Default, Debug)]
+#[derive(Deserialize, Default, Debug, Clone)]
 #[serde(deny_unknown_fields)]
 pub struct ServerConfig {
 	pub style: Option<PathBuf>,
 	pub top_margin: Option<f32>,
 	pub max_volume: Option<u8>,
 	pub show_percentage: Option<bool>,
+	pub playerctl_format: Option<String>,
 }
 
 #[derive(Deserialize, Default, Debug)]
diff --git a/src/global_utils.rs b/src/global_utils.rs
@@ -95,6 +95,19 @@ pub(crate) fn handle_application_args(
 					}
 				}
 			}
+			"playerctl" => {
+				let value = child.value().str().unwrap_or("");
+				match value {
+					"play-pause" | "play" | "pause" | "next" | "prev" | "previous" | "shuffle"
+					| "stop" => (),
+					x => {
+						eprintln!("Unknown Playerctl command: \"{}\"!...", x);
+						return (HandleLocalStatus::FAILURE, actions);
+					}
+				}
+
+				(ArgTypes::Playerctl, Some(value.to_string()))
+			}
 			"device" => {
 				let value = match child.value().str() {
 					Some(v) => v.to_string(),
@@ -125,6 +138,16 @@ pub(crate) fn handle_application_args(
 				};
 				(ArgTypes::CustomIcon, Some(value))
 			}
+			"player" => {
+				let value = match child.value().str() {
+					Some(v) => v.to_string(),
+					None => {
+						eprintln!("--player found but no name given");
+						return (HandleLocalStatus::FAILURE, actions);
+					}
+				};
+				(ArgTypes::Player, Some(value))
+			}
 			"top-margin" => {
 				let value = child.value().str().unwrap_or("").trim();
 				match value.parse::<f32>() {
diff --git a/src/mpris-backend/mod.rs b/src/mpris-backend/mod.rs
diff --git a/src/server/application.rs b/src/server/application.rs
diff --git a/src/server/main.rs b/src/server/main.rs
diff --git a/src/server/osd_window.rs b/src/server/osd_window.rs
diff --git a/src/server/utils.rs b/src/server/utils.rs
