Introduce new WebSockets receiver impl

When enabled, this new receiver will spin up a local WebSockets server
and will send the currently playing song information to any clients that
connect. It's designed with Übersicht in mind, since WebSockets is the
easiest way to efficiently push events into an Übersicht widget, but
I'm sure it'd work for a variety of other purposes too.

Currently the socket is only used in one direction, pushing the current
song info from server to client, but I'll probably extend it to support
sending MPD commands from WebSockets clients as well.

src/mpd_now_playable/config/model.py

@@ -11,6 +11,7 @@ __all__ = (
 	"MpdConfig",
 	"BaseReceiverConfig",
 	"CocoaReceiverConfig",
+	"WebsocketsReceiverConfig",
 )
 
 
@@ -24,8 +25,15 @@ class CocoaReceiverConfig(BaseReceiverConfig):
 	kind: Literal["cocoa"] = field(default="cocoa", repr=False)
 
 
+@dataclass(slots=True, kw_only=True)
+class WebsocketsReceiverConfig(BaseReceiverConfig):
+	kind: Literal["websockets"] = field(default="websockets", repr=False)
+	port: Port
+	host: Optional[Host | tuple[Host, ...]] = None
+
+
 ReceiverConfig = Annotated[
-	CocoaReceiverConfig,
+	CocoaReceiverConfig | WebsocketsReceiverConfig,
 	Field(discriminator="kind"),
 ]
 

src/mpd_now_playable/receivers/websockets/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ('receiver',)
+from .receiver import WebsocketsReceiver as receiver

src/mpd_now_playable/receivers/websockets/receiver.py

@@ -0,0 +1,52 @@
+from pathlib import Path
+
+import ormsgpack
+from websockets import broadcast
+from websockets.server import WebSocketServerProtocol, serve
+
+from ...config.model import WebsocketsReceiverConfig
+from ...player import Player
+from ...song import Song
+from ...song_receiver import DefaultLoopFactory, Receiver
+
+MSGPACK_NULL = ormsgpack.packb(None)
+
+
+def default(value: object) -> object:
+	if isinstance(value, Path):
+		return str(value)
+	raise TypeError
+
+
+class WebsocketsReceiver(Receiver):
+	config: WebsocketsReceiverConfig
+	player: Player
+	connections: set[WebSocketServerProtocol]
+	last_status: bytes = MSGPACK_NULL
+
+	def __init__(self, config: WebsocketsReceiverConfig):
+		self.config = config
+		self.connections = set()
+
+	@classmethod
+	def loop_factory(cls) -> DefaultLoopFactory:
+		return DefaultLoopFactory()
+
+	async def start(self, player: Player) -> None:
+		self.player = player
+		await serve(self.handle, host=self.config.host, port=self.config.port)
+
+	async def handle(self, conn: WebSocketServerProtocol) -> None:
+		self.connections.add(conn)
+		await conn.send(self.last_status)
+		try:
+			await conn.wait_closed()
+		finally:
+			self.connections.remove(conn)
+
+	async def update(self, song: Song | None) -> None:
+		if song is None:
+			self.last_status = MSGPACK_NULL
+		else:
+			self.last_status = ormsgpack.packb(song, default=default)
+		broadcast(self.connections, self.last_status)

src/mpd_now_playable/song/musicbrainz.py

@@ -1,11 +1,14 @@
 from dataclasses import dataclass
 from functools import partial
-from typing import TypedDict
+from typing import Annotated, TypedDict
 from uuid import UUID
 
+from pydantic import Field
+
 from ..tools.types import option_fmap
 
 option_uuid = partial(option_fmap, UUID)
+OptionUUID = Annotated[UUID | None, Field(default=None)]
 
 
 class MusicBrainzTags(TypedDict, total=False):
@@ -44,35 +47,35 @@ class MusicBrainzIds:
 	#: so recording IDs are a much more reliable way to identify a particular
 	#: song.
 	#: https://musicbrainz.org/doc/Recording
-	recording: UUID | None
+	recording: OptionUUID
 
 	#: A MusicBrainz work represents the idea of a particular song or creation
 	#: (it doesn't have to be audio). Each work may have multiple recordings
 	#: (studio versus live, different performers, etc.), with the work ID
 	#: grouping them together.
 	#: https://musicbrainz.org/doc/Work
-	work: UUID | None
+	work: OptionUUID
 
 	#: A MusicBrainz track represents a specific instance of a recording
 	#: appearing as part of some release. For example, if the same song appears
 	#: on both two-CD and four-CD versions of a soundtrack, then it will be
 	#: considered the same "recording" in both cases, but different "tracks".
 	#: https://musicbrainz.org/doc/Track
-	track: UUID | None
+	track: OptionUUID
 
 	#: https://musicbrainz.org/doc/Artist
-	artist: UUID | None
+	artist: OptionUUID
 
 	#: A MusicBrainz release roughly corresponds to an "album", and indeed is
 	#: stored in a tag called MUSICBRAINZ_ALBUMID. The more general name is
 	#: meant to encompass all the different ways music can be released.
 	#: https://musicbrainz.org/doc/Release
-	release: UUID | None
+	release: OptionUUID
 
 	#: Again, the release artist corresponds to an "album artist". These MBIDs
 	#: refer to the same artists in the MusicBrainz database that individual
 	#: recordings' artist MBIDs do.
-	release_artist: UUID | None
+	release_artist: OptionUUID
 
 	#: A MusicBrainz release group roughly corresponds to "all the editions of
 	#: a particular album". For example, if the same album were released on CD,
@@ -81,7 +84,7 @@ class MusicBrainzIds:
 	#: for this tag is relatively new (July 2023) and doesn't seem especially
 	#: reliable, so it might be missing here even if your music has been tagged
 	#: with it. Not sure why. https://musicbrainz.org/doc/Release_Group
-	release_group: UUID | None
+	release_group: OptionUUID
 
 
 def to_brainz(tags: MusicBrainzTags) -> MusicBrainzIds:

src/mpd_now_playable/song/song.py

@@ -2,6 +2,7 @@ from dataclasses import dataclass
 from enum import StrEnum
 from pathlib import Path
 
+from ..tools.schema.define import schema
 from .artwork import Artwork
 from .musicbrainz import MusicBrainzIds
 
@@ -12,21 +13,69 @@ class PlaybackState(StrEnum):
 	stop = "stop"
 
 
+@schema("https://cdn.00dani.me/m/schemata/mpd-now-playable/song-v1.json")
 @dataclass(slots=True)
 class Song:
+	#: Whether MPD is currently playing, paused, or stopped. Pretty simple.
 	state: PlaybackState
+
+	#: The zero-based index of the current song in MPD's queue.
 	queue_index: int
+	#: The total length of MPD's queue - the last song in the queue will have
+	#: the index one less than this, since queue indices are zero-based.
 	queue_length: int
+
+	#: The relative path to the current song inside the music directory. MPD
+	#: itself uses this path as a stable identifier for the audio file in many
+	#: places, so you can safely do the same.
 	file: Path
+
+	#: The song's title, if it's been tagged with one. Currently only one title
+	#: is supported, since it doesn't make a lot of sense to tag a single audio
+	#: file with multiple titles.
 	title: str | None
+
+	#: The song's artists. Will be an empty list if the song has not been
+	#: tagged with an artist, and may contain multiple values if the song has
+	#: been tagged with several artists.
 	artist: list[str]
+	#: The song's composers. Again, this is permitted to be multivalued.
 	composer: list[str]
+	#: The name of the song's containing album, which may be multivalued.
 	album: list[str]
+	#: The album's artists. This is often used to group together songs from a
+	#: single album that featured different artists.
 	album_artist: list[str]
+
+	#: The track number the song has on its album. This is usually one-based,
+	#: but it's just an arbitrary audio tag so a particular album might start
+	#: at zero or do something weird with it.
 	track: int | None
+
+	#: The disc number of the song on its album. As with the track number, this
+	#: is usually one-based, but it doesn't have to be.
 	disc: int | None
+
+	#: The song's genre or genres. These are completely arbitrary descriptions
+	#: and don't follow any particular standard.
 	genre: list[str]
+
+	#: The song's duration as read from its tags, measured in seconds.
+	#: Fractional seconds are allowed.
 	duration: float
+
+	#: How far into the song MPD is, measured in seconds. Fractional seconds
+	#: are allowed. This is usually going to be less than or equal to the
+	#: song's duration, but because the duration is tagged as metadata and this
+	#: value represents the actual elapsed time, it might go higher if the
+	#: song's duration tag is inaccurate.
 	elapsed: float
+
+	#: The song's cover art, if it has any - the art will be available as bytes
+	#: if present, ready to be displayed directly by receivers.
 	art: Artwork
+
+	#: The MusicBrainz IDs associated with the song and with its artist and
+	#: album, which if present are an extremely accurate way to identify a
+	#: given song. They're not always present, though.
 	musicbrainz: MusicBrainzIds

src/mpd_now_playable/tools/schema/generate.py

@@ -45,3 +45,9 @@ class MyGenerateJsonSchema(GenerateJsonSchema):
 
 	def nullable_schema(self, schema: s.NullableSchema) -> JsonSchemaValue:
 		return self.generate_inner(schema["schema"])
+
+if __name__ == '__main__':
+	from ...config.model import Config
+	from ...song import Song
+	write(Config)
+	write(Song)