webplayercontrol 1.0.0__tar.gz

webplayercontrol-1.0.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: webplayercontrol
+Version: 1.0.0
+Summary: An ASGI application that exposes Media Player Remote Interfacing Specification (MPRIS)-compliant media players over the web.
+Author: Christopher Head
+License-Expression: GPL-3.0-only
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Requires-Dist: aioscgi>=2.5.1
+Requires-Dist: dbus-fast>=5.0.22
+Requires-Python: >=3.14
+Project-URL: Repository, https://gitlab.com/Hawk777/webplayercontrol
+Description-Content-Type: text/markdown
+
+What is MPRIS?
+==============
+
+The [Media Player Remote Interfacing
+Specification](https://specifications.freedesktop.org/mpris/latest/), or MPRIS,
+is a standard for remotely controlling media players via D-Bus in a Linux
+system. Media players can expose MPRIS interfaces via D-Bus, and any
+MPRIS-compliant client can control those players (pause, play, advance through
+the playlist, adjust volume, seek, etc.).
+
+
+What is webplayercontrol?
+=========================
+
+Webplayercontrol is a web application (implemented using
+[ASGI](https://asgi.readthedocs.io/en/stable/) that provides a web interface
+for controlling MPRIS-compliant media players. The web interface is optimized
+for cell phone usage. The intention is to use a cell phone to control a media
+player running on a desktop, for example while sitting too far away from the
+desktop to use its own mouse and keyboard.
+
+
+How do I set it up?
+===================
+
+You’ll need an ASGI server. There are lots available to choose from, some which
+are usable on their own and some which expect to have a traditional Web server
+(like Apache, Lighttpd, or Nginx) placed in front of them. Then, once
+everything is installed, run your ASGI server and tell it the application
+callable is `webplayercontrol:main`.
+
+
+What options can I configure?
+=============================
+
+If your server supports [the pathsend
+extension](https://asgi.readthedocs.io/en/stable/extensions.html#path-send),
+you can set the `WEBPLAYERCONTROL_ASSETS` environment variable to the name of a
+directory. The directory will be created, static assets will be extracted into
+it, and the pathsend extension will be used to send those assets.

webplayercontrol-1.0.0/README.md

@@ -0,0 +1,40 @@
+What is MPRIS?
+==============
+
+The [Media Player Remote Interfacing
+Specification](https://specifications.freedesktop.org/mpris/latest/), or MPRIS,
+is a standard for remotely controlling media players via D-Bus in a Linux
+system. Media players can expose MPRIS interfaces via D-Bus, and any
+MPRIS-compliant client can control those players (pause, play, advance through
+the playlist, adjust volume, seek, etc.).
+
+
+What is webplayercontrol?
+=========================
+
+Webplayercontrol is a web application (implemented using
+[ASGI](https://asgi.readthedocs.io/en/stable/) that provides a web interface
+for controlling MPRIS-compliant media players. The web interface is optimized
+for cell phone usage. The intention is to use a cell phone to control a media
+player running on a desktop, for example while sitting too far away from the
+desktop to use its own mouse and keyboard.
+
+
+How do I set it up?
+===================
+
+You’ll need an ASGI server. There are lots available to choose from, some which
+are usable on their own and some which expect to have a traditional Web server
+(like Apache, Lighttpd, or Nginx) placed in front of them. Then, once
+everything is installed, run your ASGI server and tell it the application
+callable is `webplayercontrol:main`.
+
+
+What options can I configure?
+=============================
+
+If your server supports [the pathsend
+extension](https://asgi.readthedocs.io/en/stable/extensions.html#path-send),
+you can set the `WEBPLAYERCONTROL_ASSETS` environment variable to the name of a
+directory. The directory will be created, static assets will be extracted into
+it, and the pathsend extension will be used to send those assets.

webplayercontrol-1.0.0/pyproject.toml

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["uv_build ~= 0.13.4"]
+build-backend = "uv_build"
+
+[dependency-groups]
+ci = ["pylint-gitlab"]
+dev = [
+    "asgi-types >= 0.2.0",
+    "pylint ~= 4.1.3",
+    "pyright ~= 1.1.414",
+    "pytest ~= 9.2.0",
+    "pytest-asyncio ~= 1.4.1",
+    "ruff ~= 0.17.3",
+]
+
+[project]
+name = "webplayercontrol"
+version = "1.0.0"
+dependencies = [
+    "aioscgi >= 2.5.1",
+    "dbus-fast >= 5.0.22",
+]
+requires-python = ">= 3.14"
+license = "GPL-3.0-only"
+description = "An ASGI application that exposes Media Player Remote Interfacing Specification (MPRIS)-compliant media players over the web."
+readme = "README.md"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Multimedia :: Sound/Audio :: Players",
+]
+
+[[project.authors]]
+name = "Christopher Head"
+
+[project.urls]
+Repository = "https://gitlab.com/Hawk777/webplayercontrol"
+
+[tool.pylint.imports]
+allow-reexport-from-package = true
+
+[tool.pylint.messages_control]
+enable = [
+    "deprecated-pragma",
+    "useless-suppression",
+    "use-symbolic-message-instead",
+]
+disable = [
+    "broad-exception-caught",
+    "line-too-long",
+    "too-few-public-methods",
+    "too-many-instance-attributes",
+    "too-many-locals",
+]
+
+[tool.pyright]
+exclude = [".ruff_cache"]
+pythonVersion = "3.14"
+typeCheckingMode = "strict"
+
+[tool.pytest]
+addopts = ["--import-mode=importlib"]
+asyncio_mode = "strict"
+asyncio_default_fixture_loop_scope = "function"
+strict = true
+testpaths = ["tests"]
+
+[tool.ruff]
+src = ["src"]
+target-version = "py314"
+
+[tool.ruff.lint]
+allowed-confusables = ["’"]
+ignore = [
+    "COM812",
+    "CPY001",
+    "D203",
+    "D212",
+    "S101",
+]
+select = ["ALL"]
+
+[tool.uv.build-backend]
+source-include = ["tests/**"]

webplayercontrol-1.0.0/pyproject.toml.orig

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["uv_build ~= 0.13.4"]
+build-backend = "uv_build"
+
+[dependency-groups]
+ci = [
+	"pylint-gitlab",
+]
+dev = [
+	"asgi-types >= 0.2.0",
+	"pylint ~= 4.1.3",
+	"pyright ~= 1.1.414",
+	"pytest ~= 9.2.0",
+	"pytest-asyncio ~= 1.4.1",
+	"ruff ~= 0.17.3",
+]
+
+[project]
+name = "webplayercontrol"
+version = "1.0.0"
+dependencies = [
+	"aioscgi >= 2.5.1",
+	"dbus-fast >= 5.0.22",
+]
+requires-python = ">= 3.14"
+license = "GPL-3.0-only"
+authors = [
+	{ name = "Christopher Head" },
+]
+description = "An ASGI application that exposes Media Player Remote Interfacing Specification (MPRIS)-compliant media players over the web."
+readme = "README.md"
+classifiers = [
+	"Development Status :: 5 - Production/Stable",
+	"Environment :: Web Environment",
+	"Intended Audience :: End Users/Desktop",
+	"Operating System :: POSIX :: Linux",
+	"Programming Language :: Python :: 3",
+	"Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+	"Topic :: Multimedia :: Sound/Audio :: Players",
+]
+urls.Repository = "https://gitlab.com/Hawk777/webplayercontrol"
+
+[tool.pylint.imports]
+allow-reexport-from-package = true
+
+[tool.pylint.messages_control]
+enable = [
+	"deprecated-pragma",
+	"useless-suppression",
+	"use-symbolic-message-instead",
+]
+disable = [
+	"broad-exception-caught",
+	"line-too-long",
+	"too-few-public-methods",
+	"too-many-instance-attributes",
+	"too-many-locals",
+]
+
+[tool.pyright]
+exclude = [".ruff_cache"]
+pythonVersion = "3.14"
+typeCheckingMode = "strict"
+
+[tool.pytest]
+addopts = ["--import-mode=importlib"]
+asyncio_mode = "strict"
+asyncio_default_fixture_loop_scope = "function"
+strict = true
+testpaths = ["tests"]
+
+[tool.ruff]
+src = ["src"]
+target-version = "py314"
+
+[tool.ruff.lint]
+allowed-confusables = ["’"]
+ignore = [
+	"COM812", # missing-trailing-comma
+	"CPY001", # missing-copyright-notice
+	"D203", # one-blank-line-before-class
+	"D212", # multi-line-summary-first-line
+	"S101", # assert
+]
+select = ["ALL"]
+
+[tool.uv.build-backend]
+source-include = ["tests/**"]

webplayercontrol-1.0.0/src/webplayercontrol/__init__.py

@@ -0,0 +1,3 @@
+"""An ASGI application for controlling MPRIS-compliant media players."""
+
+from .main import main as main

webplayercontrol-1.0.0/src/webplayercontrol/assets/common.css

@@ -0,0 +1,12 @@
+html {
+	color: white;
+	background: black;
+}
+
+a, a:active, a:link, a:visited {
+	color: white;
+}
+
+.error-message {
+	color: red;
+}

webplayercontrol-1.0.0/src/webplayercontrol/assets/index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<title>WebPlayerControl</title>
+<link href="{{hash-urlsafe:common.css}}" integrity="sha256-{{hash:common.css}}" rel="stylesheet">
+<script type="module" integrity="sha256-{{hash:index.js}}" src="{{hash-urlsafe:index.js}}"></script>
+</head>
+<body>
+<h1>Select a player to control</h1>
+<ul id="player-list">
+</ul>
+</body>
+</html>

webplayercontrol-1.0.0/src/webplayercontrol/assets/index.js

@@ -0,0 +1,26 @@
+const onLoad = async function () {
+	const playerList = document.getElementById("player-list");
+	try {
+		// Fetch the list of players from the server.
+		const listingResp = await fetch("players/", { headers: { Accept: "application/json" } });
+		if (!listingResp.ok) {
+			throw new Error(`Fetching player list failed: HTTP error ${listingResp.status}`);
+		}
+		const listing = await listingResp.json();
+		for (const [name, display] of listing) {
+			const item = document.createElement("li");
+			const link = document.createElement("a");
+			link.href = `players/${name}/`;
+			link.textContent = display;
+			item.append(link);
+			playerList.append(item);
+		}
+	} catch (exp) {
+		const para = document.createElement("p");
+		para.textContent = exp.toString();
+		para.classList.add("error-message");
+		playerList.parentElement.replaceChild(para, playerList);
+	}
+};
+
+window.addEventListener("load", onLoad);

webplayercontrol-1.0.0/src/webplayercontrol/assets/player.css

@@ -0,0 +1,43 @@
+html {
+	text-align: center;
+}
+
+button {
+	background: black;
+	border: 0;
+	font-size: min(10vw, 35vh);
+}
+
+button:disabled {
+	filter: grayscale(100%);
+}
+
+#status {
+	font-size: 2rem;
+	margin-bottom: 2rem;
+}
+
+#spinner-wrapper {
+	display: inline-block;
+	min-height: 2em;
+	vertical-align: middle;
+}
+
+#spinner {
+	animation: spin 2s linear infinite;
+	border: 0.2em solid #333;
+	border-top: 0.2em solid #888;
+	border-radius: 50%;
+	display: inline-block;
+	width: 1em;
+	height: 1em;
+}
+
+#spinner.off {
+	display: none;
+}
+
+@keyframes spin {
+	0% { transform: rotate(0deg); }
+	100% { transform: rotate(360deg); }
+}

webplayercontrol-1.0.0/src/webplayercontrol/assets/player.html

@@ -0,0 +1,29 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<title>WebPlayerControl</title>
+<link href="../../{{hash-urlsafe:common.css}}" integrity="sha256-{{hash:common.css}}" rel="stylesheet">
+<link href="../../{{hash-urlsafe:player.css}}" integrity="sha256-{{hash:player.css}}" rel="stylesheet">
+<script type="module" integrity="sha256-{{hash:player.js}}" src="../../{{hash-urlsafe:player.js}}"></script>
+</head>
+<body>
+<h1>WebPlayerControl</h1>
+<a href="../..">← Back to player list</a>
+<div id="status">
+	<div id="spinner-wrapper">
+		<div id="spinner"></div>
+	</div>
+	<span id="status-text">Initializing</span>
+</div>
+<div id="buttons">
+<button id="goPrevious" type="button" disabled>⏮️</button>
+<button id="seekBack" type="button" disabled>⏪️</button>
+<button id="stop" type="button" disabled>⏹️</button>
+<button id="pause" type="button" disabled>⏸️</button>
+<button id="play" type="button" disabled>▶️</button>
+<button id="seekForward" type="button" disabled>⏩️</button>
+<button id="goNext" type="button" disabled>⏭️</button>
+</div>
+</body>
+</html>

webplayercontrol-1.0.0/src/webplayercontrol/assets/player.js

@@ -0,0 +1,114 @@
+/*
+ * Capitalizes the first character of a string.
+ */
+const capFirst = function (string) {
+	return string.charAt(0).toUpperCase() + string.slice(1);
+};
+
+/*
+ * Lowercases the first character of a string.
+ */
+const lowerFirst = function (string) {
+	return string.charAt(0).toLowerCase() + string.slice(1);
+};
+
+/*
+ * Display a status message for an error or reconnection.
+ *
+ * All controls are disabled.
+ */
+const showStatus = function (msg, error) {
+	for (const button of document.getElementsByTagName("button")) {
+		button.disabled = true;
+	}
+	const spinner = document.getElementById("spinner");
+	const statusText = document.getElementById("status-text");
+	statusText.textContent = msg;
+	if (error) {
+		spinner.classList.add("off");
+		statusText.classList.add("error-message");
+	} else {
+		spinner.classList.remove("off");
+		statusText.classList.remove("error-message");
+	}
+};
+
+/*
+ * Handles a server-sent event starting with “can”.
+ *
+ * Such an event enables or disables the indicated button.
+ */
+const onCan = function (evt) {
+	const buttonName = lowerFirst(evt.type.slice(3));
+	const button = document.getElementById(buttonName);
+	button.disabled = evt.data === "0";
+};
+
+/*
+ * Handles a button being clicked.
+ */
+const onClick = async function (evt, source) {
+	const buttonName = evt.target.id;
+	const result = await (async () => {
+		try {
+			const resp = await fetch(buttonName, { body: "", method: "POST", mode: "same-origin" });
+			return [resp, null];
+		} catch (err) {
+			if (err instanceof TypeError) {
+				return [null, err];
+			}
+			throw err;
+		}
+	})();
+	const [resp, err] = result;
+	if (resp === null) {
+		source.close();
+		showStatus(`POST to “${buttonName}” failed with ${err.message}`, true);
+	} else if (!resp.ok) {
+		source.close();
+		showStatus(`POST to “${resp.url}” failed with HTTP ${resp.status}`, true);
+	}
+};
+
+/*
+ * Handles an error in the server-sent event connection.
+ *
+ * The problem is displayed and all controls are disabled until the event
+ * stream reconnects (if it is going to do so).
+ */
+const onError = function (evt) {
+	if (evt.target.readyState === EventSource.CONNECTING) {
+		showStatus("SSE reconnecting", false);
+	} else {
+		showStatus("SSE connection failed", true);
+	}
+};
+
+/*
+ * Handles a server-sent “title” event.
+ *
+ * The title is displayed for the user. The loading spinner is also hidden,
+ * since “title” is always the last event in the initial burst on a new
+ * connection.
+ */
+const onTitle = function (evt) {
+	const statusText = document.getElementById("status-text");
+	statusText.textContent = evt.data;
+	const spinner = document.getElementById("spinner");
+	spinner.classList.add("off");
+};
+
+/*
+ * Starts the application.
+ */
+const main = function () {
+	const source = new EventSource("status");
+	source.addEventListener("error", onError);
+	for (const button of document.getElementsByTagName("button")) {
+		source.addEventListener(`can${capFirst(button.id)}`, onCan);
+		button.addEventListener("click", (evt) => onClick(evt, source));
+	}
+	source.addEventListener("title", onTitle);
+};
+
+main();