music-assistant-server

1"""
2MusicAssistant PlayerController.
3
4Handles all logic to control supported players,
5which are provided by Player Providers.
6
7Note that the PlayerController has a concept of a 'player' and a 'playerstate'.
8The Player is the actual object that is provided by the provider,
9which incorporates the (unaltered) state of the player (e.g. volume, state, etc)
10and functions for controlling the player (e.g. play, pause, etc).
11
12The playerstate is the (final) state of the player, including any user customizations
13and transformations that are applied to the player.
14The playerstate is the object that is exposed to the outside world (via the API).
15"""
16
17from __future__ import annotations
18
19import asyncio
20import contextlib
21import time
22import weakref
23from collections.abc import AsyncIterator
24from contextlib import suppress
25from typing import TYPE_CHECKING, Any, cast
26
27from music_assistant_models.auth import Scope
28from music_assistant_models.background_task import TaskSchedule
29from music_assistant_models.constants import (
30    PLAYER_CONTROL_FAKE,
31    PLAYER_CONTROL_NATIVE,
32    PLAYER_CONTROL_NONE,
33)
34from music_assistant_models.enums import (
35    EventType,
36    IdentifierType,
37    MediaType,
38    PlaybackState,
39    PlayerFeature,
40    PlayerType,
41    ProviderFeature,
42    ProviderType,
43    SourceControl,
44)
45from music_assistant_models.errors import (
46    AlreadyRegisteredError,
47    InsufficientPermissions,
48    InvalidDataError,
49    MusicAssistantError,
50    PlayerCommandFailed,
51    PlayerUnavailableError,
52    ProviderUnavailableError,
53    UnsupportedFeaturedException,
54)
55from music_assistant_models.media_items import AudioSource
56from music_assistant_models.player import PlayerOptionValueType  # noqa: TC002
57from music_assistant_models.player_control import PlayerControl  # noqa: TC002
58
59from music_assistant.constants import (
60    ATTR_ACTIVE_SOURCE,
61    ATTR_ANNOUNCEMENT_IN_PROGRESS,
62    ATTR_AVAILABLE,
63    ATTR_ENABLED,
64    ATTR_FAKE_MUTE,
65    ATTR_FAKE_POWER,
66    ATTR_FAKE_VOLUME,
67    ATTR_GROUP_MEMBERS,
68    ATTR_GROUP_VOLUME_SNAPSHOT,
69    ATTR_LAST_POLL,
70    ATTR_MUTE_CONTROL,
71    ATTR_MUTE_LOCK,
72    ATTR_POWER_CONTROL,
73    ATTR_POWERED,
74    ATTR_PREVIOUS_VOLUME,
75    ATTR_SUPPORTED_FEATURES,
76    ATTR_VOLUME_CONTROL,
77    CONF_AUTO_PLAY,
78    CONF_CACHED_ARP_MAC,
79    CONF_ENTRY_MAX_VOLUME,
80    CONF_ENTRY_MIN_VOLUME,
81    CONF_GROUP_MEMBERS,
82    CONF_MAX_VOLUME,
83    CONF_MIN_VOLUME,
84    CONF_MUTE_CONTROL,
85    CONF_PLAY_MEDIA_OVERRIDES_GROUP,
86    CONF_PLAYER_DSP,
87    CONF_PLAYERS,
88    CONF_POWER_CONTROL,
89    CONF_PROTOCOL_PARENT_ID,
90    CONF_REPORTED_MAC,
91    CONF_VOLUME_CONTROL,
92    VERBOSE_LOG_LEVEL,
93)
94from music_assistant.controllers.webserver.helpers.auth_middleware import (
95    get_current_user,
96    get_sendspin_player_id,
97    has_scope,
98)
99from music_assistant.helpers.api import api_command
100from music_assistant.helpers.colors import get_palette_for_url
101from music_assistant.helpers.util import (
102    TaskManager,
103    enrich_device_mac_address,
104    is_valid_mac_address,
105)
106from music_assistant.models.core_controller import CoreController
107from music_assistant.models.player import Player, PlayerMedia, PlayerState
108from music_assistant.models.player_provider import PlayerProvider
109from music_assistant.models.plugin import PluginProvider
110
111from .announcements import AnnouncementsMixin
112from .constants import PlayerLockPurpose
113from .helpers import handle_player_command, wait_for_power_on
114from .protocol_linking import ProtocolLinkingMixin
115
116if TYPE_CHECKING:
117    from collections.abc import Callable, Iterator
118
119    from music_assistant_models.config_entries import (
120        ConfigEntry,
121        CoreConfig,
122        PlayerConfig,
123    )
124    from music_assistant_models.player import OutputProtocol
125    from music_assistant_models.player_queue import PlayerQueue
126
127    from music_assistant import MusicAssistant
128    from music_assistant.helpers.json import SerializableType
129
130CACHE_CATEGORY_PLAYER_POWER = 1
131
132# state keys that carry the current_media playback-position anchor; these only
133# change on discrete position events (play/pause/seek/track change/buffer correction)
134POSITION_ANCHOR_KEYS = frozenset(
135    {
136        "current_media.elapsed_time",
137        "current_media.elapsed_time_last_updated",
138    }
139)
140
141# Sentinel used to detect omitted optional arguments where ``None`` is a valid value.
142_SENTINEL: Any = object()
143
144
145class PlayerController(AnnouncementsMixin, ProtocolLinkingMixin, CoreController):
146    """Controller holding all logic to control registered players."""
147
148    domain: str = "players"
149
150    def __init__(self, mass: MusicAssistant) -> None:
151        """Initialize core controller."""
152        super().__init__(mass)
153        self._players: dict[str, Player] = {}
154        self._controls: dict[str, PlayerControl] = {}
155        self.manifest.name = "Player Controller"
156        self.manifest.description = (
157            "Music Assistant's core controller which manages all players from all providers."
158        )
159        self.manifest.icon = "speaker-multiple"
160        self._poll_task: asyncio.Task[None] | None = None
161        self._player_command_locks: dict[str, asyncio.Lock] = {}
162        # Re-entrancy tracking for get_player_lock, keyed on the task object
163        # (weak ref auto-clears entries if a task is GC'd before its finally runs).
164        self._task_held_locks: weakref.WeakKeyDictionary[asyncio.Task[Any], set[str]] = (
165            weakref.WeakKeyDictionary()
166        )
167        # Lock to prevent race conditions during player registration
168        self._register_lock = asyncio.Lock()
169        # Track pending protocol player evaluations (delayed to allow all protocols to register)
170        self._pending_protocol_evaluations: dict[str, asyncio.TimerHandle] = {}
171        # Serialize delayed evaluations to prevent race conditions
172        self._delayed_evaluation_lock = asyncio.Lock()
173        # Subscribers for player state updates (called with player + changed_values)
174        self._state_update_subscribers: list[
175            Callable[[Player, dict[str, tuple[Any, Any]]], None]
176        ] = []
177
178    @contextlib.asynccontextmanager
179    async def get_player_lock(
180        self, player_id: str, purpose: PlayerLockPurpose = PlayerLockPurpose.PLAYBACK
181    ) -> AsyncIterator[None]:
182        """
183        Acquire a purpose-scoped lock for a player, with re-entrant support.
184
185        Tracks lock ownership per asyncio Task so that nested calls within the same
186        task skip re-acquisition (preventing deadlocks), while deferred callbacks
187        (call_later / create_task) correctly acquire a fresh lock.
188
189        If the lock can't be acquired within 30s the body runs anyway, to keep
190        the player responsive when a previous holder is stuck on a hung command.
191
192        :param player_id: The player to lock.
193        :param purpose: Lock category. Commands with different purposes can run
194            concurrently on the same player.
195        """
196        lock_key = f"{purpose.value}_{player_id}"
197        task = asyncio.current_task()
198
199        if task is not None and lock_key in self._task_held_locks.get(task, set()):
200            yield
201            return
202
203        lock = self._player_command_locks.setdefault(lock_key, asyncio.Lock())
204        # Two-stage acquire: a slow-acquire log at 5s and a hard give-up at 30s.
205        # If the previous holder is stuck (e.g. on a dead provider socket), we
206        # proceed without the lock so this player stays responsive.
207        acquired = False
208        try:
209            async with asyncio.timeout(5):
210                await lock.acquire()
211            acquired = True
212        except TimeoutError:
213            self.logger.debug(
214                "Acquiring %s lock for player %s is slow (>5s)", purpose.value, player_id
215            )
216            try:
217                async with asyncio.timeout(25):
218                    await lock.acquire()
219                acquired = True
220            except TimeoutError:
221                self.logger.warning(
222                    "Timed out (30s) acquiring %s lock for player %s — "
223                    "previous holder appears stuck; proceeding without lock",
224                    purpose.value,
225                    player_id,
226                )
227
228        if acquired and task is not None:
229            self._task_held_locks.setdefault(task, set()).add(lock_key)
230        try:
231            yield
232        finally:
233            if acquired:
234                if task is not None and (held := self._task_held_locks.get(task)) is not None:
235                    held.discard(lock_key)
236                    if not held:
237                        del self._task_held_locks[task]
238                lock.release()
239
240    async def get_config_entries(self) -> tuple[ConfigEntry, ...]:
241        """Return Config Entries for the Player Controller."""
242        return ()
243
244    async def setup(self, config: CoreConfig) -> None:
245        """Async initialize of module."""
246        self._repair_protocol_parent_links()
247        self._poll_task = self.mass.create_task(self._poll_players())
248        self.mass.tasks.register_scheduled_task(
249            task_id="fix_group_member_configs",
250            name="Fix sync group member configurations",
251            handler=self._fix_group_member_configs,
252            schedule=TaskSchedule.weekly(
253                days_of_week=[0],
254                hour=4,
255                minute=0,
256            ),
257            initial_delay=300,
258        )
259
260    async def close(self) -> None:
261        """Cleanup on exit."""
262        if self._poll_task and not self._poll_task.done():
263            self._poll_task.cancel()
264        # Cancel all pending protocol evaluations
265        for handle in self._pending_protocol_evaluations.values():
266            handle.cancel()
267        self._pending_protocol_evaluations.clear()
268        for player in self._players.values():
269            if player.sleep_timer_expires_at is not None:
270                self.mass.cancel_timer(self._sleep_timer_task_id(player.player_id))
271
272    async def get_diagnostics(self) -> dict[str, SerializableType]:
273        """Return diagnostics info for this controller to include in diagnostics reports."""
274        players = list(self._players.values())
275        return {
276            "players_synced": sum(player.state.synced_to is not None for player in players),
277            "players_with_active_group": sum(
278                player.state.active_group is not None for player in players
279            ),
280            "announcements_in_progress": sum(
281                bool(player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)) for player in players
282            ),
283            "pending_protocol_evaluations": len(self._pending_protocol_evaluations),
284        }
285
286    async def on_provider_loaded(self, provider: PlayerProvider) -> None:
287        """Handle logic when a provider is loaded."""
288
289    async def on_provider_unload(self, provider: PlayerProvider) -> None:
290        """Handle logic when a provider is (about to get) unloaded."""
291
292    @property
293    def providers(self) -> list[PlayerProvider]:
294        """Return all loaded/running MusicProviders."""
295        return cast("list[PlayerProvider]", self.mass.get_providers(ProviderType.PLAYER))
296
297    def iter_players(
298        self,
299        return_unavailable: bool = True,
300        return_disabled: bool = False,
301        provider_filter: str | None = None,
302        return_protocol_players: bool = False,
303    ) -> Iterator[Player]:
304        """
305        Iterate over all registered players, regardless of who is asking.
306
307        Use this for internal logic - state derivation, bookkeeping and topology
308        lookups - which must stay correct no matter which user's command happened
309        to trigger it. Use :meth:`all_players` for anything presented to a user.
310
311        :param return_unavailable [bool]: Include unavailable players.
312        :param return_disabled [bool]: Include disabled players.
313        :param provider_filter [str]: Optional filter by provider lookup key.
314        :param return_protocol_players [bool]: Include protocol players (hidden by default).
315        """
316        for player in list(self._players.values()):
317            if not (player.state.available or return_unavailable):
318                continue
319            if not (player.state.enabled or return_disabled):
320                continue
321            if not player.initialized.is_set():
322                continue
323            if provider_filter is not None and player.provider.instance_id != provider_filter:
324                continue
325            if not return_protocol_players and player.state.type == PlayerType.PROTOCOL:
326                continue
327            yield player
328
329    def all_players(
330        self,
331        return_unavailable: bool = True,
332        return_disabled: bool = False,
333        provider_filter: str | None = None,
334        return_protocol_players: bool = False,
335    ) -> list[Player]:
336        """
337        Return the registered players the current user is allowed to see.
338
339        Note that this applies user filters for players (for non admin users),
340        which makes it unsuitable for internal logic - use :meth:`iter_players` there.
341
342        :param return_unavailable [bool]: Include unavailable players.
343        :param return_disabled [bool]: Include disabled players.
344        :param provider_filter [str]: Optional filter by provider lookup key.
345        :param return_protocol_players [bool]: Include protocol players (hidden by default).
346
347        :return: List of Player objects.
348        """
349        current_user = get_current_user()
350        user_filter = (
351            current_user.player_filter
352            if current_user and not has_scope(current_user, Scope.ALL)
353            else None
354        )
355        current_sendspin_player = get_sendspin_player_id()
356        return [
357            player
358            for player in self.iter_players(
359                return_unavailable=return_unavailable,
360                return_disabled=return_disabled,
361                provider_filter=provider_filter,
362                return_protocol_players=return_protocol_players,
363            )
364            if not user_filter
365            or player.player_id in user_filter
366            or player.player_id == current_sendspin_player
367        ]
368
369    @api_command("players/all", required_scope=Scope.PLAYERS_READ)
370    def all_player_states(
371        self,
372        return_unavailable: bool = True,
373        return_disabled: bool = False,
374        provider_filter: str | None = None,
375        return_protocol_players: bool = False,
376    ) -> list[PlayerState]:
377        """
378        Return PlayerState for all registered players.
379
380        :param return_unavailable [bool]: Include unavailable players.
381        :param return_disabled [bool]: Include disabled players.
382        :param provider_filter [str]: Optional filter by provider lookup key.
383        :param return_protocol_players [bool]: Include protocol players (hidden by default).
384
385        :return: List of PlayerState objects.
386        """
387        return [
388            player.state
389            for player in self.all_players(
390                return_unavailable=return_unavailable,
391                return_disabled=return_disabled,
392                provider_filter=provider_filter,
393                return_protocol_players=return_protocol_players,
394            )
395        ]
396
397    def get_player(
398        self,
399        player_id: str,
400        raise_unavailable: bool = False,
401    ) -> Player | None:
402        """
403        Return Player by player_id.
404
405        :param player_id [str]: ID of the player.
406        :param raise_unavailable [bool]: Raise if player is unavailable.
407
408        :raises PlayerUnavailableError: If player is unavailable and raise_unavailable is True.
409        :return: Player object or None.
410        """
411        if player := self._players.get(player_id):
412            if (not player.state.available or not player.state.enabled) and raise_unavailable:
413                msg = f"Player {player_id} is not available"
414                raise PlayerUnavailableError(msg)
415            return player
416        if raise_unavailable:
417            msg = f"Player {player_id} is not available"
418            raise PlayerUnavailableError(msg)
419        return None
420
421    @api_command("players/get", required_scope=Scope.PLAYERS_READ)
422    def get_player_state(
423        self,
424        player_id: str,
425        raise_unavailable: bool = False,
426    ) -> PlayerState | None:
427        """
428        Return PlayerState by player_id.
429
430        :param player_id [str]: ID of the player.
431        :param raise_unavailable [bool]: Raise if player is unavailable.
432
433        :raises PlayerUnavailableError: If player is unavailable and raise_unavailable is True.
434        :return: Player object or None.
435        """
436        current_user = get_current_user()
437        user_filter = (
438            current_user.player_filter
439            if current_user and not has_scope(current_user, Scope.ALL)
440            else None
441        )
442        current_sendspin_player = get_sendspin_player_id()
443        if (
444            current_user
445            and user_filter
446            and player_id not in user_filter
447            and player_id != current_sendspin_player
448        ):
449            msg = f"{current_user.username} does not have access to player {player_id}"
450            raise InsufficientPermissions(msg)
451        if player := self.get_player(player_id, raise_unavailable):
452            return player.state
453        return None
454
455    def get_player_by_name(self, name: str) -> Player | None:
456        """
457        Return Player by name.
458
459        Performs case-insensitive matching against the player's state name
460        (the final name visible in clients and API).
461        If multiple players match, logs a warning and returns the first match.
462
463        :param name: Name of the player.
464        :return: Player object or None.
465        """
466        name_normalized = name.strip().lower()
467        matches: list[Player] = []
468
469        for player in list(self._players.values()):
470            if player.state.name.strip().lower() == name_normalized:
471                matches.append(player)
472
473        if not matches:
474            return None
475
476        if len(matches) > 1:
477            player_ids = [p.player_id for p in matches]
478            self.logger.warning(
479                "players/get_by_name: Multiple players found with name '%s': %s - "
480                "returning first match (%s). "
481                "Consider using the players/get API with player_id instead "
482                "for unambiguous lookups.",
483                name,
484                player_ids,
485                matches[0].player_id,
486            )
487
488        return matches[0]
489
490    @api_command("players/get_by_name", required_scope=Scope.PLAYERS_READ)
491    def get_player_state_by_name(self, name: str) -> PlayerState | None:
492        """
493        Return PlayerState by name.
494
495        :param name: Name of the player.
496        :return: PlayerState object or None.
497        """
498        current_user = get_current_user()
499        user_filter = (
500            current_user.player_filter
501            if current_user and not has_scope(current_user, Scope.ALL)
502            else None
503        )
504        current_sendspin_player = get_sendspin_player_id()
505        if player := self.get_player_by_name(name):
506            if (
507                current_user
508                and user_filter
509                and player.player_id not in user_filter
510                and player.player_id != current_sendspin_player
511            ):
512                msg = f"{current_user.username} does not have access to player {player.player_id}"
513                raise InsufficientPermissions(msg)
514            return player.state
515        return None
516
517    @api_command("players/player_controls", required_scope=Scope.PLAYERS_READ)
518    def player_controls(
519        self,
520    ) -> list[PlayerControl]:
521        """Return all registered playercontrols."""
522        return list(self._controls.values())
523
524    @api_command("players/player_control", required_scope=Scope.PLAYERS_READ)
525    def get_player_control(
526        self,
527        control_id: str,
528    ) -> PlayerControl | None:
529        """
530        Return PlayerControl by control_id.
531
532        :param control_id: ID of the player control.
533        :return: PlayerControl object or None.
534        """
535        if control := self._controls.get(control_id):
536            return control
537        return None
538
539    @api_command("players/sleep_timer/get", required_scope=Scope.PLAYERS_READ)
540    def get_sleep_timer(self, player_id: str) -> float | None:
541        """
542        Return the active sleep timer expiry timestamp for the player.
543
544        :param player_id: Player ID to check.
545        """
546        player = self._get_player_with_redirect(player_id)
547        return player.sleep_timer_expires_at
548
549    @api_command("players/sleep_timer/set", required_scope=Scope.PLAYERS_CONTROL)
550    def set_sleep_timer(self, player_id: str, seconds: int) -> float:
551        """
552        Set a sleep timer for the player.
553
554        :param player_id: Player ID to set the timer for.
555        :param seconds: Delay in seconds before playback is stopped.
556        """
557        if seconds <= 0:
558            msg = "Sleep timer duration must be greater than zero seconds"
559            raise InvalidDataError(msg)
560        player = self._get_player_with_redirect(player_id)
561        try:
562            # guard against absurd durations that overflow the float timestamp math
563            expires_at = time.time() + seconds
564        except OverflowError:
565            msg = "Sleep timer duration is too large to schedule"
566            raise InvalidDataError(msg) from None
567        player.set_sleep_timer_expires_at(expires_at)
568        player.update_state()
569        self._signal_sleep_timer_updated(player, expires_at)
570        self.mass.call_later(
571            seconds,
572            self._handle_sleep_timer_expired,
573            player.player_id,
574            task_id=self._sleep_timer_task_id(player.player_id),
575        )
576        return expires_at
577
578    @api_command("players/sleep_timer/clear", required_scope=Scope.PLAYERS_CONTROL)
579    def clear_sleep_timer(self, player_id: str) -> None:
580        """
581        Clear the active sleep timer for the player.
582
583        :param player_id: Player ID to clear the timer for.
584        """
585        player = self._get_player_with_redirect(player_id)
586        self._clear_sleep_timer(player)
587
588    # Player commands
589
590    @api_command("players/cmd/stop", required_scope=Scope.PLAYERS_CONTROL)
591    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
592    async def cmd_stop(self, player_id: str) -> None:
593        """
594        Send STOP command to given player.
595
596        - player_id: player_id of the player to handle the command.
597        """
598        player = self._get_player_with_redirect(player_id)
599        # Redirect to queue controller if it is active (skip if already in queue command context)
600        if active_queue := self.get_active_queue(player):
601            await self.mass.player_queues.stop(active_queue.queue_id)
602            return
603        # Delegate to internal handler for actual implementation
604        await self._handle_cmd_stop(player.player_id)
605
606    @api_command("players/cmd/play", required_scope=Scope.PLAYERS_CONTROL)
607    @handle_player_command
608    async def cmd_play(self, player_id: str) -> None:
609        """
610        Send PLAY (unpause) command to given player.
611
612        - player_id: player_id of the player to handle the command.
613        """
614        player = self._get_player_with_redirect(player_id)
615        if player.state.playback_state == PlaybackState.PLAYING:
616            self.logger.info(
617                "Ignore PLAY request to player %s: player is already playing", player.state.name
618            )
619            return
620        # player is not paused: check for queue redirect, then delegate to internal handler
621        if player.state.playback_state != PlaybackState.PAUSED:
622            source = player.state.active_source
623            if active_queue := self.mass.player_queues.get(source or player_id):
624                await self.mass.player_queues.resume(active_queue.queue_id)
625                return
626
627        # Delegate to internal handler for actual implementation
628        await self._handle_cmd_play(player.player_id)
629
630    @api_command("players/cmd/pause", required_scope=Scope.PLAYERS_CONTROL)
631    @handle_player_command
632    async def cmd_pause(self, player_id: str) -> None:
633        """
634        Send PAUSE command to given player.
635
636        - player_id: player_id of the player to handle the command.
637        """
638        player = self._get_player_with_redirect(player_id)
639        # Redirect to queue controller if it is active (skip if already in queue command context)
640        if active_queue := self.get_active_queue(player):
641            await self.mass.player_queues.pause(active_queue.queue_id)
642            return
643        # Delegate to internal handler for actual implementation
644        await self._handle_cmd_pause(player.player_id)
645
646    @api_command("players/cmd/play_pause", required_scope=Scope.PLAYERS_CONTROL)
647    async def cmd_play_pause(self, player_id: str) -> None:
648        """
649        Toggle play/pause on given player.
650
651        - player_id: player_id of the player to handle the command.
652        """
653        player = self._get_player_with_redirect(player_id)
654        if player.state.playback_state == PlaybackState.PLAYING:
655            await self.cmd_pause(player.player_id)
656        else:
657            await self.cmd_play(player.player_id)
658
659    @api_command("players/cmd/resume", required_scope=Scope.PLAYERS_CONTROL)
660    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
661    async def cmd_resume(
662        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
663    ) -> None:
664        """
665        Send RESUME command to given player.
666
667        Resume (or restart) playback on the player.
668
669        :param player_id: player_id of the player to handle the command.
670        :param source: Optional source to resume.
671        :param media: Optional media to resume.
672        """
673        await self._handle_cmd_resume(player_id, source, media)
674
675    @api_command("players/cmd/seek", required_scope=Scope.PLAYERS_CONTROL)
676    @handle_player_command
677    async def cmd_seek(self, player_id: str, position: int) -> None:
678        """
679        Handle SEEK command for given player.
680
681        - player_id: player_id of the player to handle the command.
682        - position: position in seconds to seek to in the current playing item.
683        """
684        player = self._get_player_with_redirect(player_id)
685        # If an AudioSource is the active queue item, proxy the seek to the plugin
686        if active := self._get_active_audio_source(player):
687            audio_source, plugin_prov = active
688            if audio_source.can_seek:
689                await plugin_prov.on_source_control(
690                    audio_source.item_id, SourceControl.SEEK, position
691                )
692                return
693        # Redirect to queue controller if it is active
694        if active_queue := self.get_active_queue(player):
695            await self.mass.player_queues.seek(active_queue.queue_id, position)
696            return
697        # handle command on player/source directly
698        active_source = next((x for x in player.source_list if x.id == player.active_source), None)
699        if active_source and not active_source.can_seek:
700            msg = (
701                f"The active source ({active_source.name}) on player "
702                f"{player.display_name} does not support seeking"
703            )
704            raise PlayerCommandFailed(msg)
705        if PlayerFeature.SEEK not in player.supported_features:
706            msg = f"Player {player.display_name} does not support seeking"
707            raise UnsupportedFeaturedException(msg)
708        # handle command on player directly
709        await player.seek(position)
710
711    @api_command("players/cmd/next", required_scope=Scope.PLAYERS_CONTROL)
712    @handle_player_command
713    async def cmd_next_track(self, player_id: str) -> None:
714        """Handle NEXT TRACK command for given player."""
715        player = self._get_player_with_redirect(player_id)
716        active_source_id = player.state.active_source or player.player_id
717        # If an AudioSource is the active queue item, proxy next to the plugin
718        if active := self._get_active_audio_source(player):
719            audio_source, plugin_prov = active
720            if audio_source.can_next_previous:
721                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.NEXT)
722                return
723        # Redirect to queue controller if it is active
724        if active_queue := self.get_active_queue(player):
725            await self.mass.player_queues.next(active_queue.queue_id)
726            return
727        if PlayerFeature.NEXT_PREVIOUS in player.state.supported_features:
728            # player has some other source active and native next/previous support
729            active_source = next(
730                (x for x in player.state.source_list if x.id == active_source_id), None
731            )
732            if active_source and active_source.can_next_previous:
733                await player.next_track()
734                return
735            msg = "This action is (currently) unavailable for this source."
736            raise PlayerCommandFailed(msg)
737        # Player does not support next/previous feature
738        msg = f"Player {player.state.name} does not support skipping to the next track."
739        raise UnsupportedFeaturedException(msg)
740
741    @api_command("players/cmd/previous", required_scope=Scope.PLAYERS_CONTROL)
742    @handle_player_command
743    async def cmd_previous_track(self, player_id: str) -> None:
744        """Handle PREVIOUS TRACK command for given player."""
745        player = self._get_player_with_redirect(player_id)
746        active_source_id = player.state.active_source or player.player_id
747        # If an AudioSource is the active queue item, proxy previous to the plugin
748        if active := self._get_active_audio_source(player):
749            audio_source, plugin_prov = active
750            if audio_source.can_next_previous:
751                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PREVIOUS)
752                return
753        # Redirect to queue controller if it is active
754        if active_queue := self.get_active_queue(player):
755            await self.mass.player_queues.previous(active_queue.queue_id)
756            return
757        if PlayerFeature.NEXT_PREVIOUS in player.state.supported_features:
758            # player has some other source active and native next/previous support
759            active_source = next(
760                (x for x in player.state.source_list if x.id == active_source_id), None
761            )
762            if active_source and active_source.can_next_previous:
763                await player.previous_track()
764                return
765            msg = "This action is (currently) unavailable for this source."
766            raise PlayerCommandFailed(msg)
767        # Player does not support next/previous feature
768        msg = f"Player {player.state.name} does not support skipping to the previous track."
769        raise UnsupportedFeaturedException(msg)
770
771    @api_command("players/cmd/power", required_scope=Scope.PLAYERS_CONTROL)
772    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
773    async def cmd_power(self, player_id: str, powered: bool) -> None:
774        """
775        Send POWER command to given player.
776
777        :param player_id: player_id of the player to handle the command.
778        :param powered: bool if player should be powered on or off.
779        """
780        # Power is serialized with PLAYBACK because powering on a sync/group player
781        # forms the group (and powering off dissolves it) - this must not race with
782        # play_media / cmd_resume / cmd_set_members on the same player.
783        await self._handle_cmd_power(player_id, powered)
784
785    @api_command("players/cmd/volume_set", required_scope=Scope.PLAYERS_CONTROL)
786    @handle_player_command(lock=PlayerLockPurpose.VOLUME)
787    async def cmd_volume_set(self, player_id: str, volume_level: int) -> None:
788        """
789        Send VOLUME_SET command to given player.
790
791        :param player_id: player_id of the player to handle the command.
792        :param volume_level: volume level (0..100) to set on the player.
793        """
794        await self._handle_cmd_volume_set(player_id, volume_level)
795        # individual child volume change invalidates any cached group volume snapshot
796        # skip for group players since _handle_cmd_volume_set redirects those to
797        # set_group_volume which creates/uses the snapshot itself
798        if (player := self.get_player(player_id)) and player.type != PlayerType.GROUP:
799            self._invalidate_group_volume_snapshot(player_id)
800
801    @api_command("players/cmd/volume_up", required_scope=Scope.PLAYERS_CONTROL)
802    @handle_player_command
803    async def cmd_volume_up(self, player_id: str) -> None:
804        """
805        Send VOLUME_UP command to given player.
806
807        - player_id: player_id of the player to handle the command.
808        """
809        if not (player := self.get_player(player_id)):
810            return
811        if player.type == PlayerType.GROUP:
812            await self.cmd_group_volume_up(player_id)
813            return
814        current_volume = player.state.volume_level or 0
815        if current_volume < 10 or current_volume > 90:
816            step_size = 1
817        elif current_volume < 30 or current_volume > 70:
818            step_size = 2
819        else:
820            step_size = 3
821        new_volume = min(100, current_volume + step_size)
822        await self.cmd_volume_set(player_id, new_volume)
823
824    @api_command("players/cmd/volume_down", required_scope=Scope.PLAYERS_CONTROL)
825    @handle_player_command
826    async def cmd_volume_down(self, player_id: str) -> None:
827        """
828        Send VOLUME_DOWN command to given player.
829
830        - player_id: player_id of the player to handle the command.
831        """
832        if not (player := self.get_player(player_id)):
833            return
834        if player.type == PlayerType.GROUP:
835            await self.cmd_group_volume_down(player_id)
836            return
837        current_volume = player.state.volume_level or 0
838        if current_volume < 10 or current_volume > 90:
839            step_size = 1
840        elif current_volume < 30 or current_volume > 70:
841            step_size = 2
842        else:
843            step_size = 3
844        new_volume = max(0, current_volume - step_size)
845        await self.cmd_volume_set(player_id, new_volume)
846
847    @api_command("players/cmd/group_volume", required_scope=Scope.PLAYERS_CONTROL)
848    @handle_player_command
849    async def cmd_group_volume(
850        self,
851        player_id: str,
852        volume_level: int,
853    ) -> None:
854        """
855        Handle adjusting the overall/group volume to a playergroup (or synced players).
856
857        Will set a new (overall) volume level to a group player or syncgroup.
858
859        :param player_id: Player ID of group player or syncleader to handle the command.
860        :param volume_level: Volume level (0..100) to set to the group.
861        """
862        player = self.get_player(player_id, True)
863        assert player is not None  # for type checker
864        if player.state.type == PlayerType.GROUP or player.state.group_members:
865            # dedicated group player or sync leader
866            await self.set_group_volume(player, volume_level)
867            return
868        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
869            # redirect to sync leader
870            await self.set_group_volume(sync_leader, volume_level)
871            return
872        # treat as normal player volume change
873        await self.cmd_volume_set(player_id, volume_level)
874
875    @api_command("players/cmd/group_volume_up", required_scope=Scope.PLAYERS_CONTROL)
876    @handle_player_command
877    async def cmd_group_volume_up(self, player_id: str) -> None:
878        """
879        Send VOLUME_UP command to given playergroup.
880
881        - player_id: player_id of the player to handle the command.
882        """
883        group_player_state = self.get_player_state(player_id, True)
884        assert group_player_state
885        cur_volume = group_player_state.group_volume
886        if cur_volume is None:
887            return
888        if cur_volume < 10 or cur_volume > 90:
889            step_size = 1
890        elif cur_volume < 30 or cur_volume > 70:
891            step_size = 2
892        else:
893            step_size = 3
894        new_volume = min(100, cur_volume + step_size)
895        await self.cmd_group_volume(player_id, new_volume)
896
897    @api_command("players/cmd/group_volume_down", required_scope=Scope.PLAYERS_CONTROL)
898    @handle_player_command
899    async def cmd_group_volume_down(self, player_id: str) -> None:
900        """
901        Send VOLUME_DOWN command to given playergroup.
902
903        - player_id: player_id of the player to handle the command.
904        """
905        group_player_state = self.get_player_state(player_id, True)
906        assert group_player_state
907        cur_volume = group_player_state.group_volume
908        if cur_volume is None:
909            return
910        if cur_volume < 10 or cur_volume > 90:
911            step_size = 1
912        elif cur_volume < 30 or cur_volume > 70:
913            step_size = 2
914        else:
915            step_size = 3
916        new_volume = max(0, cur_volume - step_size)
917        await self.cmd_group_volume(player_id, new_volume)
918
919    @api_command("players/cmd/group_volume_mute", required_scope=Scope.PLAYERS_CONTROL)
920    @handle_player_command
921    async def cmd_group_volume_mute(self, player_id: str, muted: bool) -> None:
922        """
923        Handle muting a playergroup (or synced players) as a whole.
924
925        A group player or syncleader mutes all of its members, a synced player is
926        redirected to its syncleader and an ungrouped player is muted on its own.
927
928        :param player_id: Player ID of the player to handle the command.
929        :param muted: bool if the group should be muted.
930        """
931        player = self.get_player(player_id, True)
932        assert player is not None  # for type checker
933        if player.state.type == PlayerType.GROUP or player.state.group_members:
934            # dedicated group player or sync leader
935            await self._mute_group_members(player, muted)
936            return
937        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
938            # redirect to sync leader
939            await self._mute_group_members(sync_leader, muted)
940            return
941        # treat as normal player mute
942        await self.cmd_volume_mute(player_id, muted)
943
944    @api_command("players/cmd/volume_mute", required_scope=Scope.PLAYERS_CONTROL)
945    @handle_player_command(lock=PlayerLockPurpose.VOLUME)
946    async def cmd_volume_mute(self, player_id: str, muted: bool) -> None:
947        """
948        Send VOLUME_MUTE command to given player.
949
950        - player_id: player_id of the player to handle the command.
951        - muted: bool if player should be muted.
952        """
953        player = self.get_player(player_id, True)
954        assert player
955
956        if player.type == PlayerType.GROUP:
957            # redirect to special group mute control
958            await self.cmd_group_volume_mute(player_id, muted)
959            return
960
961        # clearing the mute lock may not depend on mute support, otherwise a lock set
962        # while the player still had a mute control would outlive a control change
963        if not muted:
964            player.extra_data.pop(ATTR_MUTE_LOCK, None)
965
966        mute_control = player.mute_control
967        if mute_control == PLAYER_CONTROL_NONE:
968            raise UnsupportedFeaturedException(
969                f"Player {player.state.name} does not support muting"
970            )
971
972        # Set mute lock for players in a group
973        # This prevents auto-unmute when group volume changes
974        had_mute_lock = ATTR_MUTE_LOCK in player.extra_data
975        if muted and self._is_in_group(player.state):
976            player.extra_data[ATTR_MUTE_LOCK] = True
977
978        try:
979            await self._handle_cmd_volume_mute(player, mute_control, muted)
980        except Exception:
981            # a mute that did not happen may not leave a lock behind, but a lock
982            # earned by an earlier successful mute must survive
983            if not had_mute_lock:
984                player.extra_data.pop(ATTR_MUTE_LOCK, None)
985            raise
986
987    @handle_player_command
988    async def play_media(self, player_id: str, media: PlayerMedia) -> None:
989        """
990        Handle PLAY MEDIA on given player.
991
992        :param player_id: player_id of the player to handle the command.
993        :param media: The Media that needs to be played on the player.
994        """
995        # An explicit play_media on a captured player honors the player's
996        # CONF_PLAY_MEDIA_OVERRIDES_GROUP preference (default: True) — the
997        # player is released from its group/sync first, then plays the media
998        # standalone. With the preference off, behavior falls back to the
999        # legacy "redirect to group leader" path below.
1000        # Note: the release step runs outside the PLAYBACK lock to avoid an
1001        # AB-BA cycle with cmd_set_members(group), which acquires lock(group)
1002        # then lock(sync_leader) via the sync_group provider.
1003        target_player = self.get_player(player_id, True)
1004        if target_player is not None and (
1005            target_player.state.synced_to or target_player.state.active_group
1006        ):
1007            override = bool(
1008                self.mass.config.get_raw_player_config_value(
1009                    target_player.player_id,
1010                    CONF_PLAY_MEDIA_OVERRIDES_GROUP,
1011                    True,
1012                )
1013            )
1014            if override:
1015                await self._release_player_for_play_media(target_player)
1016                async with self.get_player_lock(
1017                    target_player.player_id, PlayerLockPurpose.PLAYBACK
1018                ):
1019                    await self._handle_play_media(target_player.player_id, media)
1020                return
1021        player = self._get_player_with_redirect(player_id)
1022        async with self.get_player_lock(player.player_id, PlayerLockPurpose.PLAYBACK):
1023            await self._handle_play_media(player.player_id, media)
1024
1025    @api_command("players/cmd/select_sound_mode", required_scope=Scope.PLAYERS_CONTROL)
1026    @handle_player_command
1027    async def select_sound_mode(self, player_id: str, sound_mode: str) -> None:
1028        """
1029        Handle SELECT SOUND MODE command on given player.
1030
1031        - player_id: player_id of the player to handle the command
1032        - sound_mode: The ID of the sound mode that needs to be activated/selected.
1033        """
1034        player = self.get_player(player_id, True)
1035        assert player is not None  # for type checking
1036
1037        if PlayerFeature.SELECT_SOUND_MODE not in player.supported_features:
1038            raise UnsupportedFeaturedException(
1039                f"Player {player.display_name} does not support sound mode selection"
1040            )
1041
1042        prev_sound_mode = player.active_sound_mode
1043        if sound_mode == prev_sound_mode:
1044            return
1045
1046        # basic check if sound mode is valid for player
1047        if not any(x for x in player.sound_mode_list if x.id == sound_mode):
1048            raise PlayerCommandFailed(
1049                f"{sound_mode} is an invalid sound_mode for player {player.display_name}"
1050            )
1051
1052        # forward to player
1053        await player.select_sound_mode(sound_mode)
1054
1055    @api_command("players/cmd/set_option", required_scope=Scope.PLAYERS_CONTROL)
1056    @handle_player_command
1057    async def set_option(
1058        self, player_id: str, option_key: str, option_value: PlayerOptionValueType
1059    ) -> None:
1060        """
1061        Handle SET_OPTION command on given player.
1062
1063        - player_id: player_id of the player to handle the command
1064        - option_key: The key of the player option that needs to be activated/selected.
1065        - option_value: The new value of the player option.
1066        """
1067        player = self.get_player(player_id, True)
1068        assert player is not None  # for type checking
1069
1070        if PlayerFeature.OPTIONS not in player.supported_features:
1071            raise UnsupportedFeaturedException(
1072                f"Player {player.display_name} does not support set_option"
1073            )
1074
1075        prev_player_option = next((x for x in player.options if x.key == option_key), None)
1076        if not prev_player_option:
1077            return
1078        if prev_player_option.value == option_value:
1079            return
1080
1081        if prev_player_option.read_only:
1082            raise UnsupportedFeaturedException(
1083                f"Player {player.display_name} option {option_key} is read-only"
1084            )
1085
1086        # forward to player
1087        await player.set_option(option_key=option_key, option_value=option_value)
1088
1089    @api_command("players/cmd/select_source", required_scope=Scope.PLAYERS_CONTROL)
1090    @handle_player_command
1091    async def select_source(self, player_id: str, source: str | None) -> None:
1092        """
1093        Handle SELECT SOURCE command on given player.
1094
1095        - player_id: player_id of the player to handle the command.
1096        - source: The ID of the source that needs to be activated/selected.
1097        """
1098        if source is None:
1099            source = player_id  # default to MA queue source
1100        player = self.get_player(player_id, True)
1101        assert player is not None  # for type checking
1102        # If player is currently grouped, handle it so the source switch can proceed.
1103        # This allows external sources (e.g. Spotify Connect, AirPlay) to take over a grouped player.
1104        if player.state.active_group and (
1105            group_player := self.get_player(player.state.active_group)
1106        ):
1107            if player_id in group_player.state.static_group_members:
1108                # player is a static member of a permanent group - stop the group
1109                # and power it off if supported, rather than removing the member
1110                await self._handle_cmd_stop(group_player.player_id)
1111                if group_player.state.power_control != PLAYER_CONTROL_NONE:
1112                    await self._handle_cmd_power(group_player.player_id, False)
1113            else:
1114                await self.cmd_ungroup(player_id)
1115        elif player.state.synced_to:
1116            await self.cmd_ungroup(player_id)
1117        # Delegate to internal handler for actual implementation
1118        await self._handle_select_source(player_id, source)
1119
1120    async def deselect_source(self, player_id: str) -> None:
1121        """
1122        Deselect the current source and stop the player.
1123
1124        Use this when an external source (plugin/receiver) disconnects and the player
1125        should stop playback rather than switch to another source.
1126
1127        :param player_id: player_id of the player to stop and deselect.
1128        """
1129        player = self.get_player(player_id, raise_unavailable=False)
1130        if not player:
1131            return
1132        with suppress(PlayerCommandFailed, PlayerUnavailableError, RuntimeError):
1133            await self._handle_cmd_stop(player_id)
1134
1135    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
1136    async def enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
1137        """
1138        Handle enqueuing of a next media item on the player.
1139
1140        :param player_id: player_id of the player to handle the command.
1141        :param media: The Media that needs to be enqueued on the player.
1142        :raises UnsupportedFeaturedException: if the player does not support enqueueing.
1143        :raises PlayerUnavailableError: if the player is not available.
1144        """
1145        # Note: No group redirect needed here as enqueue doesn't use _get_player_with_redirect
1146        # Delegate to internal handler for actual implementation
1147        await self._handle_enqueue_next_media(player_id, media)
1148
1149    @api_command("players/cmd/set_members", required_scope=Scope.PLAYERS_CONTROL)
1150    async def cmd_set_members(
1151        self,
1152        target_player: str,
1153        player_ids_to_add: list[str] | None = None,
1154        player_ids_to_remove: list[str] | None = None,
1155    ) -> None:
1156        """
1157        Join/unjoin given player(s) to/from target player.
1158
1159        Will add the given player(s) to the target player (sync leader or group player).
1160
1161        :param target_player: player_id of the syncgroup leader or group player.
1162        :param player_ids_to_add: List of player_id's to add to the target player.
1163        :param player_ids_to_remove: List of player_id's to remove from the target player.
1164
1165        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1166        :raises PlayerUnavailableError: if the target player is not available.
1167        """
1168        parent_player: Player | None = self.get_player(target_player, True)
1169        assert parent_player is not None  # for type checking
1170        if PlayerFeature.SET_MEMBERS not in parent_player.state.supported_features:
1171            msg = f"Player {parent_player.name} does not support group commands"
1172            raise UnsupportedFeaturedException(msg)
1173
1174        # if the target player is a member of an active group player (e.g. a syncgroup),
1175        # redirect the command to that group player so it can manage the member change
1176        if (
1177            parent_player.type != PlayerType.GROUP
1178            and parent_player.state.active_group
1179            and (group_player := self.get_player(parent_player.state.active_group))
1180            and group_player.type == PlayerType.GROUP
1181            and PlayerFeature.SET_MEMBERS in group_player.state.supported_features
1182        ):
1183            self.logger.debug(
1184                "Redirecting set_members from %s to its group player %s",
1185                parent_player.name,
1186                group_player.name,
1187            )
1188            await self.cmd_set_members(
1189                parent_player.state.active_group, player_ids_to_add, player_ids_to_remove
1190            )
1191            return
1192
1193        if parent_player.synced_to:
1194            # handle edge case: target player is already synced itself to another player
1195            # automatically ungroup it first and wait for state to propagate
1196            await self._auto_ungroup_if_synced(parent_player, "setting members")
1197
1198        # Use lock for playback commands to prevent protocol switches from
1199        # racing with concurrent play_media / play_index / resume calls.
1200        async with self.get_player_lock(parent_player.player_id, PlayerLockPurpose.PLAYBACK):
1201            await self._handle_set_members(parent_player, player_ids_to_add, player_ids_to_remove)
1202
1203    @api_command("players/cmd/group", required_scope=Scope.PLAYERS_CONTROL)
1204    @handle_player_command
1205    async def cmd_group(self, player_id: str, target_player: str) -> None:
1206        """
1207        Handle GROUP command for given player.
1208
1209        Join/add the given player(id) to the given (leader) player/sync group.
1210        If the target player itself is already synced to another player, this may fail.
1211        If the player can not be synced with the given target player, this may fail.
1212
1213        NOTE: This is a convenience helper for cmd_set_members.
1214
1215        :param player_id: player_id of the player to handle the command.
1216        :param target_player: player_id of the syncgroup leader or group player.
1217
1218        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1219        :raises PlayerCommandFailed: if the target player is already synced to another player.
1220        :raises PlayerUnavailableError: if the target player is not available.
1221        :raises PlayerCommandFailed: if the player is already grouped to another player.
1222        """
1223        await self.cmd_set_members(target_player, player_ids_to_add=[player_id])
1224
1225    @api_command("players/cmd/group_many", required_scope=Scope.PLAYERS_CONTROL)
1226    async def cmd_group_many(self, target_player: str, child_player_ids: list[str]) -> None:
1227        """
1228        Join given player(s) to target player.
1229
1230        Will add the given player(s) to the target player (sync leader or group player).
1231        This is a (deprecated) alias for cmd_set_members.
1232        """
1233        await self.cmd_set_members(target_player, player_ids_to_add=child_player_ids)
1234
1235    @api_command("players/cmd/ungroup", required_scope=Scope.PLAYERS_CONTROL)
1236    @handle_player_command
1237    async def cmd_ungroup(self, player_id: str) -> None:
1238        """
1239        Handle UNGROUP command for given player.
1240
1241        Remove the given player from any (sync)groups it currently is synced to.
1242        If the player is not currently grouped to any other player,
1243        this will silently be ignored.
1244        """
1245        if not (player := self.get_player(player_id)):
1246            self.logger.warning("Player %s is not available", player_id)
1247            return
1248
1249        # Ungroup on a group player is interpreted as 'release the captured
1250        # session entirely'. This avoids the "Cannot remove static member"
1251        # error path when transfer_queue or HA's unjoin asks us to release a
1252        # group that has static members.
1253        if player.state.type == PlayerType.GROUP:
1254            if player.state.power_control != PLAYER_CONTROL_NONE:
1255                await self._handle_cmd_power(player.player_id, False)
1256            else:
1257                await self._handle_cmd_stop(player.player_id)
1258            return
1259
1260        if player.state.active_group:
1261            group = self.get_player(player.state.active_group)
1262            is_static_member = group is not None and player_id in group.state.static_group_members
1263            if is_static_member:
1264                # Static members can't be released individually — recurse so
1265                # the group-player branch above stops/dissolves the session.
1266                if group is not None:
1267                    await self.cmd_ungroup(group.player_id)
1268                return
1269            # dynamic or non-static member — remove just this player
1270            await self.cmd_set_members(player.state.active_group, player_ids_to_remove=[player_id])
1271            return
1272
1273        if player.state.synced_to:
1274            # player is a sync member
1275            await self.cmd_set_members(player.state.synced_to, player_ids_to_remove=[player_id])
1276            return
1277
1278        if player.state.group_members:
1279            # player is a sync leader (a non-group player with synced followers).
1280            # Remove only the leader itself: _handle_set_members will either transfer
1281            # leadership to a remaining member (keeping playback alive) or, when no
1282            # members remain / nothing is playing, dissolve the group and stop.
1283            await self.cmd_set_members(player.player_id, player_ids_to_remove=[player.player_id])
1284            return
1285        # unjoin from any dynamic sync groups if we're currently in one (edge case)
1286        # this is in particular used for the Home Assistant integration which does
1287        # not have a set_members command and only supports a single unjoin command
1288        for player in self.iter_players(False):
1289            if not player.state.group_members or player.state.synced_to:
1290                continue
1291            if PlayerFeature.SET_MEMBERS not in player.state.supported_features:
1292                continue
1293            if player_id in player.state.static_group_members:
1294                continue
1295            if player_id in player.state.group_members:
1296                await self.cmd_set_members(player.player_id, player_ids_to_remove=[player_id])
1297                return
1298
1299    @api_command("players/cmd/ungroup_many", required_scope=Scope.PLAYERS_CONTROL)
1300    async def cmd_ungroup_many(self, player_ids: list[str]) -> None:
1301        """Handle UNGROUP command for all the given players."""
1302        for player_id in list(player_ids):
1303            await self.cmd_ungroup(player_id)
1304
1305    @api_command("players/create_group_player", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1306    async def create_group_player(
1307        self, provider: str, name: str, members: list[str], dynamic: bool = True
1308    ) -> Player:
1309        """
1310        Create a new (permanent) Group Player.
1311
1312        :param provider: The provider (id) to create the group player for.
1313        :param name: Name of the new group player.
1314        :param members: List of player ids to add to the group.
1315        :param dynamic: Whether the group is dynamic (members can change).
1316        """
1317        if not (provider_instance := self.mass.get_provider(provider)):
1318            raise ProviderUnavailableError(f"Provider {provider} not found")
1319        provider_instance = cast("PlayerProvider", provider_instance)
1320        if ProviderFeature.CREATE_GROUP_PLAYER not in provider_instance.supported_features:
1321            raise UnsupportedFeaturedException(
1322                f"Provider {provider} does not support creating group players"
1323            )
1324        return await provider_instance.create_group_player(name, members, dynamic)
1325
1326    @api_command("players/remove_group_player", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1327    async def remove_group_player(self, player_id: str) -> None:
1328        """Remove a group player."""
1329        if not (player := self.get_player(player_id)):
1330            # we simply permanently delete the player by wiping its config
1331            self.mass.config.remove(f"players/{player_id}")
1332            return
1333        if player.state.type != PlayerType.GROUP:
1334            raise UnsupportedFeaturedException(f"Player {player.state.name} is not a group player")
1335        player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1336        await player.provider.remove_group_player(player_id)
1337
1338    @api_command("players/add_currently_playing_to_favorites", required_scope=Scope.LIBRARY_WRITE)
1339    async def add_currently_playing_to_favorites(self, player_id: str) -> None:
1340        """
1341        Add the currently playing item/track on given player to the favorites.
1342
1343        This tries to resolve the currently playing media to an actual media item
1344        and add that to the favorites in the library. Will raise an error if the
1345        player is not currently playing anything or if the currently playing media
1346        can not be resolved to a media item.
1347        """
1348        player = self._get_player_with_redirect(player_id)
1349        # handle mass player queue active
1350        if mass_queue := self.get_active_queue(player):
1351            if not (current_item := mass_queue.current_item) or not current_item.media_item:
1352                raise PlayerCommandFailed("No current item to add to favorites")
1353            # if we're playing a radio station, try to resolve the currently playing track
1354            if current_item.media_item.media_type == MediaType.RADIO:
1355                if not (
1356                    (streamdetails := mass_queue.current_item.streamdetails)
1357                    and (stream_title := streamdetails.stream_title)
1358                    and " - " in stream_title
1359                ):
1360                    # no stream title available, so we can't resolve the track
1361                    # this can happen if the radio station does not provide metadata
1362                    # or there's a commercial break
1363                    # Possible future improvement could be to actually detect the song with a
1364                    # shazam-like approach.
1365                    raise PlayerCommandFailed("No current item to add to favorites")
1366                # send the streamtitle into a global search query
1367                search_artist, search_title_title = stream_title.split(" - ", 1)
1368                # strip off any additional comments in the title (such as from Radio Paradise)
1369                search_title_title = search_title_title.split(" | ")[0].strip()
1370                if track := await self.mass.music.get_track_by_name(
1371                    search_title_title, search_artist
1372                ):
1373                    # we found a track, so add it to the favorites
1374                    await self.mass.music.add_item_to_favorites(track)
1375                    return
1376                # we could not resolve the track, so raise an error
1377                raise PlayerCommandFailed("No current item to add to favorites")
1378
1379            # else: any other media item, just add it to the favorites directly
1380            await self.mass.music.add_item_to_favorites(current_item.media_item)
1381            return
1382
1383        # guard for player with no active source
1384        if not player.state.active_source:
1385            raise PlayerCommandFailed("Player has no active source")
1386        # handle other source active using the current_media with uri
1387        if current_media := player.state.current_media:
1388            # prefer the uri of the current media item
1389            if current_media.uri:
1390                with suppress(MusicAssistantError):
1391                    await self.mass.music.add_item_to_favorites(current_media.uri)
1392                    return
1393            # fallback to search based on artist and title (and album if available)
1394            if current_media.artist and current_media.title:
1395                if track := await self.mass.music.get_track_by_name(
1396                    current_media.title,
1397                    current_media.artist,
1398                    current_media.album,
1399                ):
1400                    # we found a track, so add it to the favorites
1401                    await self.mass.music.add_item_to_favorites(track)
1402                    return
1403        # if we reach here, we could not resolve the currently playing item
1404        raise PlayerCommandFailed("No current item to add to favorites")
1405
1406    async def register(self, player: Player) -> None:
1407        """Register a player on the Player Controller."""
1408        if self.mass.closing:
1409            return
1410
1411        # Use lock to prevent race conditions during concurrent player registrations
1412        async with self._register_lock:
1413            player_id = player.player_id
1414
1415            if player_id in self._players:
1416                msg = f"Player {player_id} is already registered!"
1417                raise AlreadyRegisteredError(msg)
1418
1419            # ignore disabled players
1420            if not player.state.enabled:
1421                return
1422
1423            conf_base = f"{CONF_PLAYERS}/{player_id}/values"
1424            if player.type not in (PlayerType.GROUP, PlayerType.STEREO_PAIR):
1425                # Save the original MAC reported by the provider (before ARP enrichment)
1426                reported_mac = player.device_info.identifiers.get(IdentifierType.MAC_ADDRESS)
1427
1428                # Try to use cached ARP MAC from config for fast matching on restart.
1429                # This allows protocol linking to work immediately even if ARP is slow/fails.
1430                cached_arp_mac: str | None = self.mass.config.get(
1431                    f"{conf_base}/{CONF_CACHED_ARP_MAC}", None
1432                )
1433                if cached_arp_mac and is_valid_mac_address(cached_arp_mac):
1434                    player.device_info.add_identifier(IdentifierType.MAC_ADDRESS, cached_arp_mac)
1435
1436                # Enrich device MAC address via ARP if needed
1437                # (handles invalid MACs, locally-administered MACs, and missing MACs)
1438                await enrich_device_mac_address(player.device_info, self.logger)
1439
1440                # Cache the resolved MAC for fast matching on subsequent restarts
1441                current_mac = player.device_info.identifiers.get(IdentifierType.MAC_ADDRESS)
1442                if (
1443                    current_mac
1444                    and is_valid_mac_address(current_mac)
1445                    and current_mac != cached_arp_mac
1446                ):
1447                    self.mass.config.set(f"{conf_base}/{CONF_CACHED_ARP_MAC}", current_mac)
1448
1449                # Store original reported MAC if it differs from the resolved MAC.
1450                # This enables multi-MAC matching for devices with multiple interfaces
1451                # (e.g., WiFi + Ethernet) where ARP resolves one interface but the
1452                # protocol reports the other.
1453                if reported_mac and is_valid_mac_address(reported_mac) and current_mac:
1454                    if reported_mac.upper() != current_mac.upper():
1455                        player.extra_data["reported_mac"] = reported_mac
1456                        self.mass.config.set(f"{conf_base}/{CONF_REPORTED_MAC}", reported_mac)
1457                    else:
1458                        # Provider's reported MAC matches the resolved MAC; clear any stale
1459                        # stored reported MAC to avoid false-positive multi-MAC matches.
1460                        self.mass.config.set(f"{conf_base}/{CONF_REPORTED_MAC}", None)
1461                elif not reported_mac or not is_valid_mac_address(reported_mac):
1462                    # Restore reported MAC from config on restart only when the provider
1463                    # did not supply a usable MAC address.
1464                    cached_reported_mac: str | None = self.mass.config.get(
1465                        f"{conf_base}/{CONF_REPORTED_MAC}", None
1466                    )
1467                    if cached_reported_mac and is_valid_mac_address(cached_reported_mac):
1468                        if current_mac and cached_reported_mac.upper() == current_mac.upper():
1469                            # Cached value matches the resolved MAC; clear stale entry.
1470                            self.mass.config.set(f"{conf_base}/{CONF_REPORTED_MAC}", None)
1471                        else:
1472                            player.extra_data["reported_mac"] = cached_reported_mac
1473
1474            # restore 'fake' power state from cache if available.
1475            # Group players intentionally do NOT restore their fake-power
1476            # state across restarts: at boot there is no sync session yet, so
1477            # a restored 'powered=True' would put the group in an inconsistent
1478            # 'active without captured session' state where children appear
1479            # owned by a group that has no leader. Users who want their
1480            # 'group captured' state preserved across restarts would need
1481            # explicit session restoration which is out of scope here.
1482            if player.type != PlayerType.GROUP:
1483                cached_value = await self.mass.cache.get(
1484                    key=player.player_id,
1485                    provider=self.domain,
1486                    category=CACHE_CATEGORY_PLAYER_POWER,
1487                    default=False,
1488                )
1489                if cached_value is not None:
1490                    player.extra_data[ATTR_FAKE_POWER] = cached_value
1491
1492            # finally actually register it
1493
1494            # Despite the fact that the player is not fully ready yet
1495            # (config not loaded, protocol links not evaluated),
1496            # we already add it to the _players dict here because we
1497            # want to make sure the player is available in the controller
1498            # during the rest of the registration process
1499            # (such as when fetching config or evaluating protocol links).
1500            # We use the 'initialized' attribute to indicate that the player
1501            # is still in the process of being registered so we can filter it out where needed.
1502            self._players[player_id] = player
1503            # update state to ensure player.state reflects the final attributes
1504            # (e.g. player type) set after super().__init__() in the player subclass,
1505            # before we fetch config (which relies on state.type for entry resolution)
1506            player.update_state(signal_event=False)
1507            # ensure we fetch and set the latest/full config for the player
1508            player_config = await self.mass.config.get_player_config(player_id)
1509            player.set_config(player_config)
1510            # update state again now that config is loaded
1511            player.update_state(signal_event=False)
1512            self._save_underlying_player_id(player)
1513            # call hook after the player is registered and config is set
1514            await player.on_config_updated()
1515
1516            # Handle protocol linking
1517            self._evaluate_protocol_links(player)
1518
1519            # now we're ready to signal the player is added and available
1520            player.set_initialized()
1521            self.logger.info(
1522                "Player (type %s) registered: %s/%s",
1523                player.state.type.value,
1524                player_id,
1525                player.state.name,
1526            )
1527            # signal event that a player was added
1528            if player.state.type != PlayerType.PROTOCOL:
1529                self.mass.signal_event(
1530                    EventType.PLAYER_ADDED, object_id=player.player_id, data=player
1531                )
1532            # register playerqueue for this player (if not a protocol player)
1533            if player.state.type != PlayerType.PROTOCOL:
1534                await self.mass.player_queues.on_player_register(player)
1535
1536        # Schedule debounced update of all players since can_group_with values may change
1537        # when a new player is added (provider IDs expand to include the new player)
1538        self._schedule_update_all_players(2)
1539
1540    async def register_or_update(self, player: Player) -> None:
1541        """Register a new player on the controller or update existing one."""
1542        if self.mass.closing:
1543            return
1544
1545        if player.player_id in self._players:
1546            self._players[player.player_id] = player
1547            player.update_state()
1548            # the derived-transport edge may have been set/revoked after the
1549            # initial registration (e.g. via a bridge claim)
1550            self._save_underlying_player_id(player)
1551            # Also schedule update when replacing existing player
1552            self._schedule_update_all_players()
1553            return
1554
1555        await self.register(player)
1556
1557    def trigger_player_update(
1558        self, player_id: str, force_update: bool = False, debounce_delay: float = 0.25
1559    ) -> None:
1560        """Trigger a (debounced) update for the given player."""
1561        if self.mass.closing:
1562            return
1563        if not (player := self.get_player(player_id)):
1564            return
1565        # mark dirty right away (not at execution): a trigger means state the player
1566        # derives from changed, and a direct update_state call may come in before
1567        # the debounced one runs
1568        player.mark_state_dirty()
1569        task_id = f"player_update_state_{player_id}"
1570        self.mass.call_later(
1571            debounce_delay,
1572            player.update_state,
1573            force_update=force_update,
1574            task_id=task_id,
1575        )
1576
1577    async def unregister(self, player_id: str, permanent: bool = False) -> None:
1578        """
1579        Unregister a player from the player controller.
1580
1581        Called (by a PlayerProvider) when a player is removed or no longer available
1582        (for a longer period of time). This will remove the player from the player
1583        controller and optionally remove the player's config from the mass config.
1584        If the player is not registered, this will silently be ignored.
1585
1586        :param player_id: Player ID of the player to unregister.
1587        :param permanent: If True, remove the player permanently by deleting its config.
1588                          If False, the player config will not be removed.
1589        """
1590        player = self._players.get(player_id)
1591        if player is None:
1592            return
1593        del self._players[player_id]
1594        # clean up all lock entries for this player
1595        for prefix in [p.value for p in PlayerLockPurpose]:
1596            self._player_command_locks.pop(f"{prefix}_{player_id}", None)
1597        if handle := self._pending_protocol_evaluations.pop(player_id, None):
1598            handle.cancel()
1599        self._clear_sleep_timer(player)
1600        self.mass.player_queues.on_player_remove(player_id, permanent=permanent)
1601        await player.on_unload()
1602        if permanent:
1603            # player permanent removal: cleanup protocol links, delete config
1604            # and signal PLAYER_REMOVED event
1605            await self._cleanup_player_memberships(player_id)
1606            self._cleanup_protocol_links(player)
1607            self.delete_player_config(player_id)
1608            self.logger.info("Player removed: %s", player.name)
1609            if player.state.type != PlayerType.PROTOCOL:
1610                self.mass.signal_event(EventType.PLAYER_REMOVED, player_id)
1611        else:
1612            # temporary unavailable: mark player as unavailable
1613            # note: the player will be re-registered later if it comes back online
1614            player.state.available = False
1615            self.logger.info("Player unavailable: %s", player.name)
1616            if player.state.type != PlayerType.PROTOCOL:
1617                self.mass.signal_event(
1618                    EventType.PLAYER_UPDATED, object_id=player.player_id, data=player.state
1619                )
1620        # Schedule debounced update of all players since can_group_with values may change
1621        self._schedule_update_all_players()
1622
1623    @api_command("players/remove", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1624    async def remove(self, player_id: str) -> None:
1625        """
1626        Remove a player from a provider.
1627
1628        Can only be called when a PlayerProvider supports ProviderFeature.REMOVE_PLAYER.
1629        """
1630        player = self.get_player(player_id)
1631        if player is None:
1632            # we simply permanently delete the player config since it is not registered
1633            self.delete_player_config(player_id)
1634            return
1635        if player.state.type == PlayerType.GROUP:
1636            # Handle group player removal
1637            player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1638            await player.provider.remove_group_player(player_id)
1639            return
1640        player.provider.check_feature(ProviderFeature.REMOVE_PLAYER)
1641        await player.provider.remove_player(player_id)
1642        # check for group memberships that need to be updated
1643        if player.state.active_group and (
1644            group_player := self.mass.players.get_player(player.state.active_group)
1645        ):
1646            # try to remove from the group
1647            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1648                await group_player.set_members(
1649                    player_ids_to_remove=[player_id],
1650                )
1651        # We removed the player and can now clean up its config
1652        self.delete_player_config(player_id)
1653
1654    def delete_player_config(self, player_id: str) -> None:
1655        """
1656        Permanently delete a player's configuration.
1657
1658        Should only be called for players that are not registered by the player controller.
1659        """
1660        # we simply permanently delete the player by wiping its config
1661        conf_key = f"{CONF_PLAYERS}/{player_id}"
1662        dsp_conf_key = f"{CONF_PLAYER_DSP}/{player_id}"
1663        for key in (conf_key, dsp_conf_key):
1664            self.mass.config.remove(key)
1665
1666    def scale_volume_to_device(self, player_id: str, logical_volume: int) -> int:
1667        """Scale logical volume (0-100) to device volume (min_volume-max_volume)."""
1668        min_volume, max_volume = self._get_volume_limits(player_id)
1669        if min_volume == 0 and max_volume == 100:
1670            return logical_volume
1671        # Scale: logical 0 -> min_volume, logical 100 -> max_volume
1672        return min_volume + (logical_volume * (max_volume - min_volume)) // 100
1673
1674    def scale_volume_from_device(self, player_id: str, device_volume: int) -> int:
1675        """Scale device volume (min_volume-max_volume) to logical volume (0-100)."""
1676        min_volume, max_volume = self._get_volume_limits(player_id)
1677        if min_volume == 0 and max_volume == 100:
1678            return device_volume
1679        volume_range = max_volume - min_volume
1680        if volume_range == 0:
1681            return 0
1682        # Scale to 0-100 without clamping so that out-of-range device volumes
1683        # produce distinct logical values, ensuring state change detection triggers
1684        # volume limit enforcement
1685        return ((device_volume - min_volume) * 100) // volume_range
1686
1687    def on_player_position_jumped(self, player: Player) -> None:
1688        """
1689        Handle a discrete jump of a player's corrected playback position.
1690
1691        Called by a Player when its corrected position moved significantly
1692        outside regular playback progression (seek or buffer correction). This
1693        is not an event by itself: it re-bases the active queue's timing on the
1694        fresh position and nudges related players so derived positions stay in
1695        sync; current_media then re-anchors from the corrected queue time on
1696        the follow-up update, which emits the actual update event.
1697        """
1698        if self.mass.closing:
1699            return
1700        self.mass.player_queues.on_player_elapsed_time_corrected(player)
1701        self.trigger_player_update(player.player_id)
1702        self._forward_state_update(player, {})
1703
1704    def signal_player_state_update(
1705        self,
1706        player: Player,
1707        changed_values: dict[str, tuple[Any, Any]],
1708        force_update: bool = False,
1709        skip_forward: bool = False,
1710        media_position_jumped: bool = False,
1711    ) -> None:
1712        """
1713        Signal a player state update.
1714
1715        Called by a Player when its state has changed.
1716        This will update the player state in the controller and signal the event bus.
1717        """
1718        player_id = player.player_id
1719        if self.mass.closing:
1720            return
1721
1722        # ignore updates for disabled players
1723        if not player.state.enabled and ATTR_ENABLED not in changed_values:
1724            return
1725
1726        # The current_media position anchor only changes on discrete events
1727        # (play/pause/seek/track change/buffer correction), so a change set holding
1728        # only anchor keys represents a position correction rather than a regular
1729        # state change.
1730        non_anchor_keys = changed_values.keys() - POSITION_ANCHOR_KEYS
1731        if len(non_anchor_keys) == 0 and not force_update:
1732            if not media_position_jumped:
1733                # anchor adoption without a significant corrected-position change
1734                return
1735            # current_media's corrected position jumped (seek or buffer correction
1736            # reached the current media): emit the full player update below so
1737            # consumers see the fresh position
1738
1739        if self.logger.isEnabledFor(VERBOSE_LOG_LEVEL):
1740            self.logger.log(
1741                VERBOSE_LOG_LEVEL,
1742                "Player state updated for %s: changed fields: %s",
1743                player.name,
1744                ", ".join(changed_values.keys()),
1745            )
1746
1747        # signal update to the playerqueue
1748        if player.state.type != PlayerType.PROTOCOL:
1749            self.mass.call_later(
1750                0.5,
1751                self.mass.player_queues.on_player_update,
1752                player,
1753                changed_values,
1754                task_id=f"queue_on_player_update_{player.player_id}",
1755            )
1756
1757        # Kick async palette extraction on cold cache. On transition prefetch
1758        # the next queue item too. Skip players that mirror another player's media
1759        # (grouped/synced members, protocol children): their current_media - palette
1760        # included - is taken wholesale from the owner, so resolving it per member is
1761        # wasted work that also produces duplicate state updates across the group.
1762        if (
1763            not self._mirrors_parent_media(player)
1764            and (current_media := player.state.current_media)
1765            and current_media.image_url
1766        ):
1767            if current_media.palette is None:
1768                self._schedule_palette_fetch(player_id, current_media.image_url)
1769            if "current_media.image_url" in changed_values or "current_media" in changed_values:
1770                self._schedule_next_queue_item_palette_prefetch(player_id, current_media)
1771
1772        # handle DSP reload of the leader when grouping/ungrouping
1773        if ATTR_GROUP_MEMBERS in changed_values:
1774            prev_group_members, new_group_members = changed_values[ATTR_GROUP_MEMBERS]
1775            self._handle_group_dsp_change(player, prev_group_members or [], new_group_members)
1776            # Removed group members also need to be updated since they are no longer part
1777            # of this group and are available for playback again
1778            removed_members = set(prev_group_members or []) - set(new_group_members or [])
1779            for _removed_player_id in removed_members:
1780                if removed_player := self.get_player(_removed_player_id):
1781                    removed_player.refresh_state()
1782
1783        # detect when active_source changes to
1784        # something external while we have a grouped protocol active
1785        if ATTR_ACTIVE_SOURCE in changed_values:
1786            task_id = f"external_source_takeover_{player_id}"
1787            self.mass.call_later(
1788                5,
1789                self._check_external_source_takeover,
1790                player,
1791                task_id=task_id,
1792            )
1793        # only steer into the (relatively expensive) membership cleanup when a field
1794        # that can require an unsync actually changed - this runs on every state tick
1795        if changed_values.keys() & {ATTR_AVAILABLE, ATTR_ENABLED, ATTR_POWERED}:
1796            self._handle_membership_cleanup_on_state_change(player, changed_values)
1797
1798        # enforce volume limits when volume changes externally
1799        if "volume_level" in changed_values:
1800            self._enforce_volume_limits(player)
1801        # dispatch to internal state update subscribers (with changed_values)
1802        self._dispatch_state_update_subscribers(player, changed_values)
1803
1804        # signal player update on the eventbus
1805        if player.state.type != PlayerType.PROTOCOL:
1806            self.mass.signal_event(EventType.PLAYER_UPDATED, object_id=player_id, data=player)
1807
1808        # signal a separate PlayerOptionsUpdated event
1809        if options := changed_values.get("options"):
1810            self.mass.signal_event(
1811                EventType.PLAYER_OPTIONS_UPDATED, object_id=player_id, data=options
1812            )
1813        # signal player config update event if playerfeatures changed
1814        # this is temporary needed for the Home Assistant integration which only
1815        # re-evalues the entity's supported features on a PLAYER_CONFIG_UPDATED event.
1816        # TODO: Remove this temporary workaround once the HA integration is updated to
1817        # also re-evaluate supported features on PLAYER_UPDATED events.
1818        if changed_values.keys() & {
1819            ATTR_SUPPORTED_FEATURES,
1820            ATTR_MUTE_CONTROL,
1821            ATTR_VOLUME_CONTROL,
1822            ATTR_POWER_CONTROL,
1823        }:
1824            self.mass.signal_event(
1825                EventType.PLAYER_CONFIG_UPDATED, object_id=player_id, data=player.config
1826            )
1827
1828        if not skip_forward or force_update:
1829            self._forward_state_update(player, changed_values)
1830
1831        # trigger update of all players in a provider if group related fields changed
1832        # this ensures that calculated fields like can_group_with are updated on all players
1833        if any(key in changed_values for key in ("group_members", "synced_to", "available")):
1834            for prov_player in player.provider.players:
1835                self.trigger_player_update(prov_player.player_id, debounce_delay=2)
1836
1837    async def register_player_control(self, player_control: PlayerControl) -> None:
1838        """Register a new PlayerControl on the controller."""
1839        if self.mass.closing:
1840            return
1841        control_id = player_control.id
1842
1843        if control_id in self._controls:
1844            msg = f"PlayerControl {control_id} is already registered"
1845            raise AlreadyRegisteredError(msg)
1846
1847        # make sure that the playercontrol's provider is set to the instance_id
1848        prov = self.mass.get_provider(player_control.provider)
1849        if not prov or prov.instance_id != player_control.provider:
1850            raise RuntimeError(f"Invalid provider ID given: {player_control.provider}")
1851
1852        self._controls[control_id] = player_control
1853
1854        self.logger.info(
1855            "PlayerControl registered: %s/%s",
1856            control_id,
1857            player_control.name,
1858        )
1859
1860        # always call update to update any attached players etc.
1861        self.update_player_control(player_control.id, include_configured=True)
1862
1863    async def register_or_update_player_control(self, player_control: PlayerControl) -> None:
1864        """Register a new playercontrol on the controller or update existing one."""
1865        if self.mass.closing:
1866            return
1867        if player_control.id in self._controls:
1868            self._controls[player_control.id] = player_control
1869            self.update_player_control(player_control.id, include_configured=True)
1870            return
1871        await self.register_player_control(player_control)
1872
1873    def update_player_control(self, control_id: str, include_configured: bool = False) -> None:
1874        """
1875        Refresh the players that use the given player control.
1876
1877        :param control_id: The control whose state or availability changed.
1878        :param include_configured: Also refresh the players that select this control in their
1879            config but do not currently resolve to it. Needed when a control (re)appears,
1880            because such a player has already fallen back to another control and would
1881            otherwise never pick this one back up.
1882        """
1883        if self.mass.closing:
1884            return
1885        # update all players that are using this control
1886        for player in list(self._players.values()):
1887            if control_id in (
1888                player.state.power_control,
1889                player.state.volume_control,
1890                player.state.mute_control,
1891            ) or (
1892                include_configured and control_id in self._configured_control_ids(player.player_id)
1893            ):
1894                self.mass.loop.call_soon(player.refresh_state)
1895
1896    def remove_player_control(self, control_id: str) -> None:
1897        """Remove a player_control from the player manager."""
1898        control = self._controls.pop(control_id, None)
1899        if control is None:
1900            return
1901        self.logger.info("PlayerControl removed: %s", control.name)
1902        # players configured to use this control still resolve to it until they are
1903        # refreshed, so let them fall back to their remaining options right away
1904        self.update_player_control(control_id)
1905
1906    def get_player_provider(self, player_id: str) -> PlayerProvider:
1907        """Return PlayerProvider for given player."""
1908        player = self._players[player_id]
1909        assert player  # for type checker
1910        return player.provider
1911
1912    def get_active_queue(self, player: Player) -> PlayerQueue | None:
1913        """Return the current active queue for a player (if any)."""
1914        # account for player that is synced (sync child)
1915        if player.state.synced_to and player.state.synced_to != player.player_id:
1916            if sync_leader := self.get_player(player.state.synced_to):
1917                return self.get_active_queue(sync_leader)
1918        # handle active group player
1919        if player.state.active_group and player.state.active_group != player.player_id:
1920            if group_player := self.get_player(player.state.active_group):
1921                return self.get_active_queue(group_player)
1922        # active_source may be filled queue id (or None)
1923        active_source = player.state.active_source or player.player_id
1924        if active_queue := self.mass.player_queues.get(active_source):
1925            return active_queue
1926        # handle active protocol player with parent player queue
1927        if player.type == PlayerType.PROTOCOL and player.protocol_parent_id:
1928            if parent_player := self.mass.players.get_player(player.protocol_parent_id):
1929                return self.get_active_queue(parent_player)
1930        return None
1931
1932    async def set_group_volume(self, group_player: Player, volume_level: int) -> None:
1933        """
1934        Set the overall volume for a player group or synced players.
1935
1936        Uses interpolation to adjust all child volumes while preserving their
1937        relative balance. A snapshot of child volumes is cached on first call and
1938        used as the reference point for subsequent adjustments.
1939
1940        :param group_player: The group player or sync leader.
1941        :param volume_level: Target volume level (0..100).
1942        """
1943        cur_volume = group_player.state.group_volume
1944        if cur_volume is None:
1945            return
1946
1947        children: list[Player] = []
1948        for child_player in self.iter_group_members(
1949            group_player, only_powered=True, exclude_self=False
1950        ):
1951            if child_player.state.volume_control == PLAYER_CONTROL_NONE:
1952                continue
1953            children.append(child_player)
1954        if not children:
1955            return
1956
1957        # cache a snapshot of child volumes on the group player as reference for interpolation.
1958        # scaling up: each child interpolates from its snapshot value toward 100.
1959        # scaling down: each child interpolates from its snapshot value toward 0.
1960        # this ensures the relative balance is preserved and all children converge
1961        # to 0 and 100 at the extremes. the snapshot is invalidated when a child's
1962        # individual volume changes or group membership changes.
1963        snapshot: dict[str, int] | None = group_player.extra_data.get(ATTR_GROUP_VOLUME_SNAPSHOT)
1964        if snapshot is None or not all(c.player_id in snapshot for c in children):
1965            snapshot = {c.player_id: c.state.volume_level or 0 for c in children}
1966            group_player.extra_data[ATTR_GROUP_VOLUME_SNAPSHOT] = snapshot
1967
1968        base_group = max(snapshot.values())
1969
1970        coros = []
1971        for child_player in children:
1972            child_base = snapshot.get(child_player.player_id, 0)
1973            if volume_level >= base_group:
1974                # scaling up: interpolate each child from snapshot toward 100
1975                if base_group >= 100:
1976                    new_child_volume = child_base
1977                else:
1978                    progress = (volume_level - base_group) / (100 - base_group)
1979                    new_child_volume = round(child_base + (100 - child_base) * progress)
1980            elif base_group == 0:
1981                new_child_volume = 0
1982            else:
1983                # scaling down: interpolate each child from snapshot toward 0
1984                progress = volume_level / base_group
1985                new_child_volume = round(child_base * progress)
1986            new_child_volume = max(0, min(100, new_child_volume))
1987            coros.append(self._handle_cmd_volume_set(child_player.player_id, new_child_volume))
1988        await asyncio.gather(*coros)
1989
1990        # notify active AudioSource once at the group level to prevent
1991        # feedback loops from per-child callbacks with different volume values
1992        if active := self._get_active_audio_source(group_player):
1993            audio_source, plugin_prov = active
1994            active_queue = self.get_active_queue(group_player)
1995            if active_queue is not None and active_queue.queue_id == group_player.player_id:
1996                await plugin_prov.on_volume_change(audio_source.item_id, volume_level)
1997
1998    def iter_group_members(
1999        self,
2000        group_player: Player,
2001        only_powered: bool = False,
2002        only_playing: bool = False,
2003        active_only: bool = False,
2004        exclude_self: bool = True,
2005    ) -> Iterator[Player]:
2006        """Get (child) players attached to a group player or syncgroup."""
2007        for child_id in list(group_player.state.group_members):
2008            if child_player := self.get_player(child_id, False):
2009                if not child_player.state.available or not child_player.state.enabled:
2010                    continue
2011                if only_powered and child_player.state.powered is False:
2012                    continue
2013                if active_only and child_player.state.active_group != group_player.player_id:
2014                    continue
2015                if exclude_self and child_player.player_id == group_player.player_id:
2016                    continue
2017                if only_playing and child_player.state.playback_state not in (
2018                    PlaybackState.PLAYING,
2019                    PlaybackState.PAUSED,
2020                ):
2021                    continue
2022                yield child_player
2023
2024    def subscribe_player_state_update(
2025        self,
2026        callback: Callable[[Player, dict[str, tuple[Any, Any]]], None],
2027    ) -> Callable[[], None]:
2028        """
2029        Subscribe to player state update notifications.
2030
2031        The callback receives the Player and a dict of changed values
2032        (mapping attribute name to a (previous, new) tuple).
2033
2034        :param callback: Function to invoke for each player state update.
2035        :return: An unsubscribe function.
2036        """
2037        self._state_update_subscribers.append(callback)
2038
2039        def _unsub() -> None:
2040            with suppress(ValueError):
2041                self._state_update_subscribers.remove(callback)
2042
2043        return _unsub
2044
2045    @contextlib.asynccontextmanager
2046    async def wait_for_player_update(
2047        self,
2048        player_id: str,
2049        attribute_name: str | None = None,
2050        attribute_value: Any = _SENTINEL,
2051        timeout: float = 5.0,
2052    ) -> AsyncIterator[None]:
2053        """
2054        Async context manager that waits for a player state update.
2055
2056        Subscribes to player state updates on entry, runs the body (typically
2057        the action that triggers the expected update), then waits for a
2058        matching update on exit. If ``attribute_name`` and ``attribute_value``
2059        are both provided and the current value already matches at entry, the
2060        wait is skipped.
2061
2062        Example::
2063
2064            async with mass.players.wait_for_player_update(
2065                player_id, attribute_name="playback_state",
2066                attribute_value=PlaybackState.IDLE, timeout=5,
2067            ):
2068                await mass.players._handle_cmd_stop(player_id)
2069
2070        :param player_id: The player ID to wait for.
2071        :param attribute_name: Optional state attribute to watch for changes
2072            (e.g. ``"playback_state"``). If omitted, any state change satisfies
2073            the wait.
2074        :param attribute_value: Optional value the watched attribute must reach.
2075            Only meaningful in combination with ``attribute_name``.
2076        :param timeout: Maximum time to wait in seconds.
2077        """
2078        update_event = asyncio.Event()
2079
2080        def _on_state_update(player: Player, changed_values: dict[str, tuple[Any, Any]]) -> None:
2081            if player.player_id != player_id:
2082                return
2083            if attribute_name is None:
2084                update_event.set()
2085                return
2086            if attribute_name not in changed_values:
2087                return
2088            if attribute_value is _SENTINEL:
2089                update_event.set()
2090                return
2091            _prev, new_val = changed_values[attribute_name]
2092            if new_val == attribute_value:
2093                update_event.set()
2094
2095        # short-circuit when the desired value is already the current state
2096        already_satisfied = (
2097            attribute_name is not None
2098            and attribute_value is not _SENTINEL
2099            and (player := self.get_player(player_id)) is not None
2100            and getattr(player.state, attribute_name, _SENTINEL) == attribute_value
2101        )
2102
2103        unsub = self.subscribe_player_state_update(_on_state_update)
2104        try:
2105            yield
2106            if already_satisfied:
2107                return
2108            try:
2109                async with asyncio.timeout(timeout):
2110                    await update_event.wait()
2111            except TimeoutError:
2112                self.logger.debug(
2113                    "Timed out waiting for player update on %s (attr=%s value=%s)",
2114                    player_id,
2115                    attribute_name,
2116                    attribute_value,
2117                )
2118        finally:
2119            unsub()
2120
2121    async def on_player_config_change(self, config: PlayerConfig, changed_keys: set[str]) -> None:
2122        """Call (by config manager) when the configuration of a player changes."""
2123        min_vol_changed = f"values/{CONF_MIN_VOLUME}" in changed_keys
2124        max_vol_changed = f"values/{CONF_MAX_VOLUME}" in changed_keys
2125        if min_vol_changed or max_vol_changed:
2126            raw_min = config.get_value(CONF_MIN_VOLUME)
2127            raw_max = config.get_value(CONF_MAX_VOLUME)
2128            min_vol = int(cast("int", raw_min)) if raw_min is not None else 0
2129            max_vol = int(cast("int", raw_max)) if raw_max is not None else 100
2130            if min_vol > max_vol:
2131                msg = "Minimum volume cannot exceed maximum volume"
2132                raise InvalidDataError(msg)
2133        player = self.get_player(config.player_id)
2134        player_provider = self.mass.get_provider(config.provider)
2135        player_disabled = ATTR_ENABLED in changed_keys and not config.enabled
2136        player_enabled = ATTR_ENABLED in changed_keys and config.enabled
2137
2138        if player_disabled and player and player.state.available:
2139            # edge case: ensure that the player is powered off if the player gets disabled
2140            if player.state.power_control != PLAYER_CONTROL_NONE:
2141                await self._handle_cmd_power(config.player_id, False)
2142            elif player.state.playback_state != PlaybackState.IDLE:
2143                await self.cmd_stop(config.player_id)
2144
2145        # signal player provider that the player got enabled/disabled
2146        if (player_enabled or player_disabled) and player_provider:
2147            assert isinstance(player_provider, PlayerProvider)  # for type checking
2148            # Collect linked protocol IDs to cascade the enable/disable to.
2149            # Without this, a disabled native parent leaves its linked protocols
2150            # registered after restart; they then fail to find their parent and
2151            # get wrapped in a fresh Universal Player.
2152            cascade_protocol_ids: list[str] = []
2153            parent_is_protocol = player.state.type == PlayerType.PROTOCOL if player else False
2154            if not parent_is_protocol:
2155                if player and player.linked_output_protocols:
2156                    cascade_protocol_ids = [
2157                        link.output_protocol_id for link in player.linked_output_protocols
2158                    ]
2159                else:
2160                    cascade_protocol_ids = self._get_cached_protocol_ids(config.player_id)
2161            if player_disabled:
2162                player_provider.on_player_disabled(config.player_id)
2163            elif player_enabled:
2164                player_provider.on_player_enabled(config.player_id)
2165            for protocol_id in cascade_protocol_ids:
2166                protocol_raw = self.mass.config.get(f"{CONF_PLAYERS}/{protocol_id}")
2167                if not protocol_raw:
2168                    continue
2169                if bool(protocol_raw.get("enabled", True)) == bool(player_enabled):
2170                    continue
2171                self.mass.create_task(
2172                    self.mass.config.save_player_config(
2173                        protocol_id, {ATTR_ENABLED: bool(player_enabled)}
2174                    )
2175                )
2176            return  # enabling/disabling a player will be handled by the provider
2177
2178        if not player:
2179            return  # guard against player not being registered (yet)
2180
2181        resume_queue: PlayerQueue | None = (
2182            self.mass.player_queues.get(player.state.active_source)
2183            if player.state.active_source
2184            else None
2185        )
2186
2187        # ensure player state gets updated with any updated config
2188        player.set_config(config)
2189        await player.on_config_updated()
2190        player.update_state()
2191        # if the PlayerQueue was playing, restart playback
2192        if resume_queue and resume_queue.state == PlaybackState.PLAYING:
2193            requires_restart = any(
2194                v for v in config.values.values() if v.key in changed_keys and v.requires_reload
2195            )
2196            if requires_restart:
2197                # always stop first to ensure the player uses the new config
2198                await self.mass.player_queues.stop(resume_queue.queue_id)
2199                self.mass.call_later(
2200                    1, self.mass.player_queues.resume, resume_queue.queue_id, False
2201                )
2202
2203    async def on_player_dsp_change(self, player_id: str) -> None:
2204        """Call (by config manager) when the DSP settings of a player change."""
2205        # signal player provider that the config changed
2206        if not (player := self.get_player(player_id)):
2207            return
2208        if player.state.playback_state == PlaybackState.PLAYING:
2209            self.logger.info("Restarting playback of Player %s after DSP change", player_id)
2210            # this will restart the queue stream/playback
2211            if self.get_active_queue(player):
2212                self.mass.call_later(
2213                    0, self.mass.player_queues.resume, player.state.active_source, False
2214                )
2215                return
2216            # if the player is not using a queue, we need to stop and start playback
2217            await self.cmd_stop(player_id)
2218            await self.cmd_play(player_id)
2219
2220    def schedule_active_output_protocol_clear(self, player: Player) -> None:
2221        """
2222        Clear the player's active output protocol once it stops playing.
2223
2224        A device may keep reporting PLAYING for a short while after a stop
2225        command, so the clear is deferred until the player reports IDLE (with a
2226        timeout as fallback). Starting a new session cancels the pending clear
2227        (see Player.set_active_output_protocol).
2228
2229        :param player: The player whose active output protocol must be cleared.
2230        """
2231        # Deduplicated per player via task_id: if a clear is already pending we
2232        # keep it, so the single tracked task stays cancellable by a new session.
2233        self.mass.create_task(
2234            self._clear_active_output_protocol_when_idle(player),
2235            task_id=f"clear_active_protocol_{player.player_id}",
2236        )
2237
2238    def __iter__(self) -> Iterator[Player]:
2239        """Iterate over all players."""
2240        return iter(self._players.values())
2241
2242    async def _release_player_for_play_media(self, player: Player) -> None:
2243        """
2244        Release a captured player so a play_media command can target it directly.
2245
2246        :param player: The captured player to release.
2247        """
2248        # Strategy is picked from how the player is currently captured:
2249        #   synced_to            → unsync this player (cmd_ungroup)
2250        #   dynamic group member → remove from group via cmd_set_members
2251        #   static group member  → dissolve the whole group (power off if it
2252        #                          has a real power control, otherwise stop)
2253        # In every branch we wait for the relevant state attribute to actually
2254        # clear before returning. Providers (Sonos in particular) reject a
2255        # play_media on a player whose synced_to/active_group is still set
2256        # locally even though the release command has been acknowledged.
2257        if player.state.synced_to:
2258            self.logger.debug(
2259                "Unsyncing %s from %s to honor explicit play_media target",
2260                player.state.name,
2261                player.state.synced_to,
2262            )
2263            async with self.wait_for_player_update(
2264                player.player_id,
2265                attribute_name="synced_to",
2266                attribute_value=None,
2267                timeout=5,
2268            ):
2269                await self.cmd_ungroup(player.player_id)
2270            return
2271        if not player.state.active_group:
2272            return
2273        group = self.get_player(player.state.active_group)
2274        if group is None:
2275            return
2276        is_dynamic_member = (
2277            PlayerFeature.SET_MEMBERS in group.state.supported_features
2278            and player.player_id not in group.state.static_group_members
2279        )
2280        if is_dynamic_member:
2281            self.logger.debug(
2282                "Removing %s from dynamic group %s to honor explicit play_media target",
2283                player.state.name,
2284                group.state.name,
2285            )
2286            async with self.wait_for_player_update(
2287                player.player_id,
2288                attribute_name="active_group",
2289                attribute_value=None,
2290                timeout=5,
2291            ):
2292                await self.cmd_set_members(group.player_id, player_ids_to_remove=[player.player_id])
2293            return
2294        # static member: a single member can't be released, so the whole
2295        # group must dissolve. Prefer cmd_power when an explicit power
2296        # control is set so the user-visible state stays consistent.
2297        async with self.wait_for_player_update(
2298            player.player_id,
2299            attribute_name="active_group",
2300            attribute_value=None,
2301            timeout=5,
2302        ):
2303            if group.state.power_control != PLAYER_CONTROL_NONE and group.state.powered:
2304                self.logger.debug(
2305                    "Powering off %s to honor explicit play_media target on %s",
2306                    group.state.name,
2307                    player.state.name,
2308                )
2309                await self._handle_cmd_power(group.player_id, False)
2310            else:
2311                self.logger.debug(
2312                    "Stopping %s to honor explicit play_media target on %s",
2313                    group.state.name,
2314                    player.state.name,
2315                )
2316                await self._handle_cmd_stop(group.player_id)
2317
2318    def _mirrors_parent_media(self, player: Player) -> bool:
2319        """
2320        Return True if the player's current_media is taken from another player.
2321
2322        Grouped/synced members and protocol children mirror their parent's
2323        current_media (palette included), so they must not resolve it themselves.
2324
2325        :param player: The player to check.
2326        """
2327        state = player.state
2328        # a self-referential active_group/synced_to is not a real parent (mirror the
2329        # != self guard in Player.__final_current_media), so it must not skip resolution
2330        parent_id = state.active_group or state.synced_to
2331        if parent_id and parent_id != player.player_id:
2332            return True
2333        return state.type == PlayerType.PROTOCOL and player.protocol_parent_id is not None
2334
2335    def _schedule_palette_fetch(
2336        self, player_id: str, image_url: str | None, *, trigger_update: bool = True
2337    ) -> None:
2338        """
2339        Kick off an async palette extraction for an image URL.
2340
2341        :param player_id: Player the palette is scoped to (used for task dedup).
2342        :param image_url: Image URL to extract from. No-op when empty or already cached.
2343        :param trigger_update: When True, re-emit player state once palette is ready
2344                               (current track). When False, only warm the cache (prefetch).
2345        """
2346        if not image_url:
2347            return
2348        # Key the task on the image (not just the player) so a track change always
2349        # schedules a fetch for the new image instead of being dropped by an in-flight
2350        # fetch for the previous one; repeated schedules for the same image still dedupe.
2351        slot = "current" if trigger_update else "next"
2352        self.mass.create_task(
2353            self._fetch_palette(player_id, image_url, trigger_update=trigger_update),
2354            task_id=f"palette_fetch_{player_id}_{slot}_{image_url}",
2355            abort_existing=False,
2356        )
2357
2358    async def _fetch_palette(self, player_id: str, image_url: str, *, trigger_update: bool) -> None:
2359        palette = await get_palette_for_url(self.mass, image_url)
2360        if palette is None or not trigger_update:
2361            return  # prefetch only warms the cache controller; nothing to attach
2362        player = self.get_player(player_id)
2363        if player is None:
2364            return
2365        current = player.state.current_media
2366        if current is None or current.image_url != image_url:
2367            return  # media changed while fetching
2368        # Carry the palette on player state so the (sync) serialization reads it back.
2369        player.set_resolved_palette(image_url, palette)
2370        # Avoid trigger_player_update so a concurrent state-change debounce
2371        # doesn't cancel our timer via the shared player_update_state task_id.
2372        self.mass.call_later(
2373            0,
2374            player.update_state,
2375            force_update=True,
2376            task_id=f"palette_player_update_{player_id}",
2377        )
2378
2379    def _schedule_next_queue_item_palette_prefetch(
2380        self, player_id: str, current_media: PlayerMedia
2381    ) -> None:
2382        """Warm the palette cache for the next queue item so it's hot at transition."""
2383        queue_id, item_id = current_media.source_id, current_media.queue_item_id
2384        if not queue_id or not item_id:
2385            return
2386        next_item = self.mass.player_queues.get_next_item(queue_id, item_id)
2387        if next_item is None or not next_item.image:
2388            return
2389        next_url = self.mass.metadata.get_image_url(
2390            next_item.image, size=512, prefer_stream_server=True
2391        )
2392        self._schedule_palette_fetch(player_id, next_url, trigger_update=False)
2393
2394    def _configured_control_ids(self, player_id: str) -> set[str]:
2395        """Return the player control ids the given player's config selects."""
2396        return {
2397            str(value)
2398            for conf_key in (CONF_POWER_CONTROL, CONF_VOLUME_CONTROL, CONF_MUTE_CONTROL)
2399            if (value := self.mass.config.get_raw_player_config_value(player_id, conf_key))
2400        }
2401
2402    def _get_volume_limits(self, player_id: str) -> tuple[int, int]:
2403        """Get the configured min/max volume limits for a player."""
2404        min_volume = int(
2405            cast(
2406                "int",
2407                self.mass.config.get_raw_player_config_value(
2408                    player_id, CONF_MIN_VOLUME, CONF_ENTRY_MIN_VOLUME.default_value
2409                ),
2410            )
2411        )
2412        max_volume = int(
2413            cast(
2414                "int",
2415                self.mass.config.get_raw_player_config_value(
2416                    player_id, CONF_MAX_VOLUME, CONF_ENTRY_MAX_VOLUME.default_value
2417                ),
2418            )
2419        )
2420        return min_volume, max_volume
2421
2422    def _enforce_volume_limits(self, player: Player) -> None:
2423        """Clamp device volume to min/max range when changed externally."""
2424        player_id = player.player_id
2425        min_volume, max_volume = self._get_volume_limits(player_id)
2426        if min_volume == 0 and max_volume == 100:
2427            return
2428        # state.volume_level is the resolved logical volume, available for all
2429        # volume control types; a device volume outside the configured range
2430        # surfaces here as a value outside 0-100 (scaling does not clamp)
2431        logical_volume = player.state.volume_level
2432        if logical_volume is None or 0 <= logical_volume <= 100:
2433            return
2434        clamped = max(0, min(100, logical_volume))
2435        # correct via the regular volume-set path so scaling and redirection apply
2436        self.mass.create_task(self._handle_cmd_volume_set(player_id, clamped))
2437
2438    def _forward_state_update(
2439        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2440    ) -> None:
2441        """Forward a player state update to related players (groups, sync parent, protocols)."""
2442        # TODO: make this fan-out change-aware (skip relatives that derive nothing from
2443        # the changed fields) once reverse indexes for synced_to/active_group exist.
2444        # Propagate group or sync-leader updates to child players.
2445        if player.state.group_members:
2446            for child_player in self.iter_group_members(player, exclude_self=True):
2447                if player.type == PlayerType.GROUP:
2448                    child_player.on_group_updated(player, changed_values)
2449                else:
2450                    child_player.on_sync_parent_updated(player, changed_values)
2451        # update/signal group player(s) when a member updates. A sync leader is a member of the
2452        # group player that formed the sync group and gaining members of its own does not change
2453        # that: a group player mirrors its leader, so it depends on exactly these updates.
2454        for group_player in self._get_player_groups(player):
2455            group_player.on_group_member_updated(player, changed_values)
2456
2457        # update/signal manually sync-parent player when child updates
2458        if (_sync_parent_id := player.state.synced_to) and (
2459            _sync_parent := self.get_player(_sync_parent_id)
2460        ):
2461            self.trigger_player_update(_sync_parent.player_id)
2462        # If this is a protocol player, forward the state update to the parent player
2463        if (
2464            player.type == PlayerType.PROTOCOL
2465            and player.protocol_parent_id
2466            and (_protocol_parent := self.mass.players.get_player(player.protocol_parent_id))
2467        ):
2468            _protocol_parent.on_protocol_player_updated(player, changed_values)
2469        # If this is a parent player with linked protocols, forward state updates
2470        # to linked protocol players so their state reflects parent dependencies
2471        if player.state.type != PlayerType.PROTOCOL and player.linked_output_protocols:
2472            for linked in player.linked_output_protocols:
2473                if protocol_player := self.mass.players.get_player(linked.output_protocol_id):
2474                    protocol_player.on_protocol_parent_updated(player, changed_values)
2475
2476    def _invalidate_group_volume_snapshot(self, player_id: str) -> None:
2477        """Clear the cached group volume snapshot for all groups this player belongs to."""
2478        player = self.get_player(player_id)
2479        if not player:
2480            return
2481        if player.state.group_members:
2482            player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2483        for group_player in self._get_player_groups(player):
2484            group_player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2485        if player.state.synced_to and (leader := self.get_player(player.state.synced_to)):
2486            leader.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2487
2488    def _dispatch_state_update_subscribers(
2489        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2490    ) -> None:
2491        """Notify all internal subscribers of a player state update."""
2492        for subscriber in list(self._state_update_subscribers):
2493            try:
2494                subscriber(player, changed_values)
2495            except Exception:
2496                self.logger.exception(
2497                    "Error in player state update subscriber for %s", player.player_id
2498                )
2499
2500    async def _wait_for_playback_state(
2501        self,
2502        player: Player,
2503        wanted_state: PlaybackState,
2504        timeout: float,
2505        minimal_time: float = 0,
2506    ) -> None:
2507        """Wait for a player to reach a playback state, with optional minimum wait time."""
2508        start_timestamp = time.time()
2509        async with self.wait_for_player_update(
2510            player.player_id,
2511            attribute_name="playback_state",
2512            attribute_value=wanted_state,
2513            timeout=timeout,
2514        ):
2515            pass
2516        elapsed = time.time() - start_timestamp
2517        if elapsed < minimal_time:
2518            await asyncio.sleep(minimal_time - elapsed)
2519
2520    async def _clear_active_output_protocol_when_idle(self, player: Player) -> None:
2521        """Wait for the player to stop playing, then clear its active output protocol."""
2522        await self._wait_for_playback_state(player, PlaybackState.IDLE, timeout=10)
2523        player.set_active_output_protocol(None)
2524
2525    def _handle_membership_cleanup_on_state_change(
2526        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2527    ) -> None:
2528        """Detach a player from its (sync)groups when a state change requires it."""
2529        # A player that became unavailable or disabled can no longer be commanded,
2530        # so we drop it from its parent group/leader directly.
2531        became_inactive = (
2532            ATTR_AVAILABLE in changed_values and changed_values[ATTR_AVAILABLE][1] is False
2533        ) or (ATTR_ENABLED in changed_values and changed_values[ATTR_ENABLED][1] is False)
2534        if became_inactive and (player.state.active_group or player.state.synced_to):
2535            self.mass.create_task(self._cleanup_player_memberships(player.player_id))
2536
2537        # A player whose power was turned off outside of an MA power command (e.g. its
2538        # linked power control was switched off directly) must be unsynced too. We act
2539        # only on an explicit on->off transition, leaving players without power control
2540        # (powered == None) untouched. The player is still reachable here, so we route
2541        # through cmd_ungroup which also transfers leadership when it is a sync leader.
2542        if (
2543            changed_values.get(ATTR_POWERED) == (True, False)
2544            and player.state.type == PlayerType.PLAYER
2545            and (player.state.synced_to or player.state.active_group or player.state.group_members)
2546        ):
2547            self.mass.create_task(self.cmd_ungroup(player.player_id))
2548
2549    async def _cleanup_player_memberships(self, player_id: str) -> None:
2550        """Ensure a player is detached from any groups or syncgroups."""
2551        if not (player := self.get_player(player_id)):
2552            return
2553        with suppress(UnsupportedFeaturedException, PlayerCommandFailed, PlayerUnavailableError):
2554            if parent_id := (player.state.active_group or player.state.synced_to):
2555                # the player is part of a (permanent) groupplayer and the user tries to ungroup
2556                if parent_player := self.get_player(parent_id):
2557                    await self._handle_set_members(parent_player, player_ids_to_remove=[player_id])
2558                return
2559
2560    def _get_player_with_redirect(self, player_id: str) -> Player:
2561        """Get player with check if playback related command should be redirected."""
2562        player = self.get_player(player_id, True)
2563        assert player is not None  # for type checking
2564        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
2565            self.logger.info(
2566                "Player %s is synced to %s and can not accept "
2567                "playback related commands itself, "
2568                "redirected the command to the sync leader.",
2569                player.name,
2570                sync_leader.name,
2571            )
2572            return sync_leader
2573        if player.state.active_group and (
2574            active_group := self.get_player(player.state.active_group)
2575        ):
2576            self.logger.info(
2577                "Player %s is part of a playergroup and can not accept "
2578                "playback related commands itself, "
2579                "redirected the command to the group leader.",
2580                player.name,
2581            )
2582            return active_group
2583        return player
2584
2585    def _get_active_audio_source(self, player: Player) -> tuple[AudioSource, PluginProvider] | None:
2586        """
2587        Return the active AudioSource and its owning PluginProvider for a player.
2588
2589        Returns None when the player's active queue item is not a MediaType.AUDIO_SOURCE
2590        or when the owning plugin provider is no longer available.
2591
2592        :param player: The player whose active queue to inspect.
2593        """
2594        active_queue = self.get_active_queue(player)
2595        if active_queue is None:
2596            return None
2597        current_item = active_queue.current_item
2598        if current_item is None or current_item.media_item is None:
2599            return None
2600        media_item = current_item.media_item
2601        # isinstance check defends against a non-AudioSource subclass that
2602        # somehow has media_type=AUDIO_SOURCE set (mutated or constructed wrong)
2603        # — the media_type guard alone would let it through and crash later.
2604        if not isinstance(media_item, AudioSource):
2605            return None
2606        provider = self.mass.get_provider(media_item.provider)
2607        if not isinstance(provider, PluginProvider):
2608            return None
2609        # Belt-and-suspenders: a queue item carrying media_type=AUDIO_SOURCE
2610        # can only have come from a provider that declared the feature, but
2611        # a feature flag flipped off at runtime (provider reload, config
2612        # change) would leave on_source_control / on_volume_change raising
2613        # NotImplementedError out of cmd_play / cmd_pause. Skip cleanly.
2614        if ProviderFeature.AUDIO_SOURCE not in provider.supported_features:
2615            return None
2616        return media_item, provider
2617
2618    def _get_player_groups(self, player: Player) -> Iterator[Player]:
2619        """
2620        Return all group players the given player is a member of.
2621
2622        :param player: The player to look up the group memberships for.
2623        """
2624        # A group player mirrors its members, so it is also included while unavailable -
2625        # skipping it there is exactly how its state goes stale.
2626        player_id = player.player_id
2627        for _player in self.iter_players():
2628            if _player.player_id == player_id:
2629                continue
2630            if _player.state.type != PlayerType.GROUP:
2631                continue
2632            if player_id in _player.state.group_members:
2633                yield _player
2634
2635    # Protocol linking methods are provided by ProtocolLinkingMixin (protocol_linking.py)
2636
2637    def _repair_protocol_parent_links(self) -> None:
2638        """
2639        Repair protocol parent links in player configs on startup.
2640
2641        Scans player configs with a protocol_parent_id set and clears parent_ids
2642        that point to player configs that no longer exist (e.g., deleted universal
2643        players). A valid parent link also proves the player is a protocol child,
2644        so a stale player_type (left behind by an aborted registration) is healed.
2645        """
2646        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
2647        for player_id, player_config in all_player_configs.items():
2648            values = player_config.get("values") or {}
2649            parent_id = values.get(CONF_PROTOCOL_PARENT_ID)
2650            if not parent_id:
2651                continue
2652            # Check if parent config still exists
2653            parent_config = all_player_configs.get(parent_id)
2654            if not parent_config:
2655                self.logger.debug(
2656                    "Clearing stale protocol_parent_id %s for %s (parent config deleted)",
2657                    parent_id,
2658                    player_id,
2659                )
2660                conf_key = f"{CONF_PLAYERS}/{player_id}/values/{CONF_PROTOCOL_PARENT_ID}"
2661                self.mass.config.set(conf_key, None)
2662                continue
2663            if player_config.get("player_type") != PlayerType.PROTOCOL.value:
2664                self.logger.info(
2665                    "Repairing player type of %s - linked as protocol child of %s",
2666                    player_id,
2667                    parent_id,
2668                )
2669                self.mass.config.set_player_type(player_id, PlayerType.PROTOCOL)
2670
2671    async def _fix_group_member_configs(self) -> None:
2672        """
2673        Fix stale protocol player IDs in sync group member configs.
2674
2675        When a sync group references a protocol player ID instead of
2676        the parent player ID, correct it using the cached protocol parent mapping.
2677        """
2678        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
2679        total_fixes = 0
2680        fixed_groups: list[str] = []
2681
2682        for group_id, group_config in list(all_player_configs.items()):
2683            if group_config.get("provider") != "sync_group":
2684                continue
2685            old_members: list[str] = group_config.get("values", {}).get(CONF_GROUP_MEMBERS, [])
2686            if not old_members:
2687                continue
2688
2689            new_members: list[str] = []
2690            changes = 0
2691            for member_id in old_members:
2692                parent_id = self._get_cached_protocol_parent_id(member_id)
2693                corrected_id = parent_id or member_id
2694                if corrected_id != member_id:
2695                    changes += 1
2696                    self.logger.debug(
2697                        "Sync group %s: corrected member %s -> %s",
2698                        group_id,
2699                        member_id,
2700                        corrected_id,
2701                    )
2702                if corrected_id not in new_members:
2703                    new_members.append(corrected_id)
2704
2705            if changes:
2706                self.mass.config.set_raw_player_config_value(
2707                    group_id, CONF_GROUP_MEMBERS, new_members
2708                )
2709                total_fixes += changes
2710                fixed_groups.append(group_id)
2711
2712        for group_id in fixed_groups:
2713            if (group_player := self.get_player(group_id)) and group_player.available:
2714                await group_player.on_config_updated()
2715
2716        if total_fixes:
2717            self.logger.info(
2718                "Fixed %d stale member reference(s) across %d sync group(s)",
2719                total_fixes,
2720                len(fixed_groups),
2721            )
2722
2723    async def _poll_players(self) -> None:
2724        """Background task that polls players for updates."""
2725        while True:
2726            for player in list(self._players.values()):
2727                # if the player is playing, update elapsed time every tick
2728                # to ensure the queue has accurate details
2729                player_playing = player.state.playback_state == PlaybackState.PLAYING
2730                if player_playing and player.type != PlayerType.PROTOCOL:
2731                    self.mass.call_later(
2732                        0.5,
2733                        self.mass.player_queues.on_player_update,
2734                        player,
2735                        {"corrected_elapsed_time": (None, player.state.corrected_elapsed_time)},
2736                        task_id=f"queue_on_player_update_{player.player_id}",
2737                    )
2738                # Poll player;
2739                if not player.needs_poll:
2740                    continue
2741                try:
2742                    last_poll: float = player.extra_data[ATTR_LAST_POLL]
2743                except KeyError:
2744                    last_poll = 0.0
2745                if (self.mass.loop.time() - last_poll) < player.poll_interval:
2746                    continue
2747                player.extra_data[ATTR_LAST_POLL] = self.mass.loop.time()
2748                try:
2749                    await player.poll()
2750                except Exception as err:
2751                    self.logger.warning(
2752                        "Error while requesting latest state from player %s: %s",
2753                        player.state.name,
2754                        str(err),
2755                        exc_info=err if self.logger.isEnabledFor(10) else None,
2756                    )
2757                # Yield to event loop to prevent blocking
2758                await asyncio.sleep(0)
2759            await asyncio.sleep(1)
2760
2761    def _handle_group_dsp_change(
2762        self, player: Player, prev_group_members: list[str], new_group_members: list[str]
2763    ) -> None:
2764        """Handle DSP reload when group membership changes."""
2765        # reset cached group volume snapshot since membership changed
2766        player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2767        prev_child_count = len(prev_group_members)
2768        new_child_count = len(new_group_members)
2769        is_player_group = player.state.type == PlayerType.GROUP
2770
2771        # handle special case for PlayerGroups: since there are no leaders,
2772        # DSP still always work with a single player in the group.
2773        multi_device_dsp_threshold = 1 if is_player_group else 0
2774
2775        prev_is_multiple_devices = prev_child_count > multi_device_dsp_threshold
2776        new_is_multiple_devices = new_child_count > multi_device_dsp_threshold
2777
2778        if prev_is_multiple_devices == new_is_multiple_devices:
2779            return  # no change in multi-device status
2780
2781        supports_multi_device_dsp = (
2782            PlayerFeature.MULTI_DEVICE_DSP in player.state.supported_features
2783        )
2784
2785        dsp_enabled: bool
2786        if player.state.type == PlayerType.GROUP:
2787            # Since player groups do not have leaders, we will use the only child
2788            # that was in the group before and after the change
2789            if prev_is_multiple_devices:
2790                if childs := new_group_members:
2791                    # We shrank the group from multiple players to a single player
2792                    # So the now only child will control the DSP
2793                    dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2794                else:
2795                    dsp_enabled = False
2796            elif childs := prev_group_members:
2797                # We grew the group from a single player to multiple players,
2798                # let's see if the previous single player had DSP enabled
2799                dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2800            else:
2801                dsp_enabled = False
2802        else:
2803            dsp_enabled = self.mass.config.get_player_dsp_config(player.player_id).enabled
2804
2805        if dsp_enabled and not supports_multi_device_dsp:
2806            # We now know that the group configuration has changed so:
2807            # - multi-device DSP is not supported
2808            # - we switched from a group with multiple players to a single player
2809            #   (or vice versa)
2810            # - the leader has DSP enabled
2811            self.mass.create_task(self.mass.players.on_player_dsp_change(player.player_id))
2812
2813    def _check_external_source_takeover(self, player: Player) -> None:
2814        """
2815        Handle when an external source takes over playback on a player.
2816
2817        When a player has an active grouped output protocol (e.g., AirPlay group) and
2818        an external source (e.g., Spotify Connect, TV input) takes over playback,
2819        we need to clear the active output protocol and ungroup the protocol players.
2820
2821        This prevents the situation where the player appears grouped via protocol
2822        but is actually playing from a different source.
2823
2824        :param player: The player whose active_source changed.
2825        """
2826        # Only relevant for non-protocol players
2827        if player.type == PlayerType.PROTOCOL:
2828            return
2829
2830        # Not a takeover if the player is not actively playing
2831        if player.playback_state != PlaybackState.PLAYING:
2832            return
2833
2834        # Only relevant if we have an active output protocol (not native)
2835        if not player.active_output_protocol or player.active_output_protocol == "native":
2836            return
2837
2838        new_source = player.state.active_source
2839
2840        # Check if new source is external (not MA-managed)
2841        if self._is_ma_managed_source(player, new_source):
2842            return
2843
2844        # Get the active protocol player
2845        protocol_player = self.get_player(player.active_output_protocol)
2846        if not protocol_player:
2847            return
2848
2849        # If the source matches the active protocol's domain, it's expected - not a takeover
2850        # e.g., source "airplay" when using AirPlay protocol is normal
2851        if new_source and new_source.lower() == protocol_player.provider.domain.lower():
2852            return
2853
2854        if (
2855            new_source
2856            and new_source.lower() in ("airplay", "cast", "chromecast", "network")
2857            and protocol_player.provider.domain.lower() == "sendspin"
2858        ):
2859            # Special case for Sendspin bridge: if the new source matches cast or airplay and the
2860            # active protocol is Sendspin, we consider this a normal behavior and not a takeover
2861            return
2862
2863        # Confirmed external source takeover
2864        self.logger.info(
2865            "External source '%s' took over on %s while playing via protocol %s - "
2866            "clearing active output protocol and ungrouping",
2867            new_source,
2868            player.display_name,
2869            protocol_player.provider.domain,
2870        )
2871
2872        # Set active output protocol to native
2873        player.set_active_output_protocol("native")
2874
2875        # Ungroup the protocol player (async task)
2876        self.mass.create_task(protocol_player.ungroup())
2877
2878    def _is_ma_managed_source(self, player: Player, source: str | None) -> bool:
2879        """
2880        Check if a source is managed by Music Assistant.
2881
2882        MA-managed sources include:
2883        - None (=autodetect, no source explicitly set by player)
2884        - The player's own ID (MA queue)
2885        - Any active queue ID
2886        - Any plugin source ID
2887
2888        :param player: The player to check.
2889        :param source: The source ID to check.
2890        :return: True if the source is MA-managed, False if external.
2891        """
2892        if source is None:
2893            return True
2894
2895        # Player's own ID means MA queue is active
2896        if source == player.player_id:
2897            return True
2898
2899        # Check if it's a known queue ID
2900        return self.mass.player_queues.get(source) is not None
2901
2902    def _schedule_update_all_players(self, delay: float = 2.0) -> None:
2903        """
2904        Schedule a debounced update of all players' state.
2905
2906        Used when a new player is registered to ensure all existing players
2907        update their dynamic properties (like can_group_with) that may have changed.
2908
2909        :param delay: Delay in seconds before triggering updates (default 2.0).
2910        """
2911        if self.mass.closing:
2912            return
2913
2914        for player in self.all_players(
2915            return_unavailable=True,
2916            return_disabled=False,
2917            return_protocol_players=True,
2918        ):
2919            self.trigger_player_update(player.player_id, debounce_delay=delay)
2920
2921    async def _auto_ungroup_if_synced(self, player: Player, log_context: str) -> None:
2922        """
2923        Automatically ungroup a player if it's synced to another player.
2924
2925        :param player: The player to check and potentially ungroup.
2926        :param log_context: Additional context for the log message (e.g., target player name).
2927        """
2928        if not player.state.synced_to and not player.state.active_group:
2929            return
2930        self.logger.info(
2931            "Player %s is already synced to %s, ungrouping it first before %s",
2932            player.name,
2933            player.state.synced_to or player.state.active_group,
2934            log_context,
2935        )
2936        # Use internal _handle_set_members to avoid deadlocking on the play lock
2937        # (we're already inside a cmd_set_members chain that holds a play lock).
2938        synced_to = player.state.synced_to or player.state.active_group
2939        if synced_to and (parent := self.get_player(synced_to)):
2940            try:
2941                async with self.wait_for_player_update(player.player_id, timeout=5):
2942                    await self._handle_set_members(parent, player_ids_to_remove=[player.player_id])
2943            except asyncio.CancelledError:
2944                raise
2945            except Exception:
2946                self.logger.warning(
2947                    "Failed to auto-ungroup %s from %s, proceeding anyway",
2948                    player.name,
2949                    synced_to,
2950                )
2951
2952    async def _handle_set_members(
2953        self,
2954        parent_player: Player,
2955        player_ids_to_add: list[str] | None = None,
2956        player_ids_to_remove: list[str] | None = None,
2957    ) -> None:
2958        """
2959        Handle the actual set_members logic.
2960
2961        Skips permission checks and locking (internal use only).
2962
2963        :param parent_player: The parent player to add/remove members to/from.
2964        :param player_ids_to_add: List of player_id's to add to the parent player.
2965        :param player_ids_to_remove: List of player_id's to remove from the parent player.
2966        """
2967        target_player = parent_player.player_id
2968        # handle the sync leader being removed from itself: either transfer leadership
2969        # to a remaining member (keeping playback alive) or dissolve the group entirely
2970        should_stop = False
2971        if player_ids_to_remove and target_player in player_ids_to_remove:
2972            remaining_members = [
2973                m
2974                for m in parent_player.state.group_members
2975                if m != target_player
2976                and m not in player_ids_to_remove
2977                and (member := self.get_player(m))
2978                and member.state.available
2979            ]
2980            active_queue = self.get_active_queue(parent_player)
2981            if remaining_members and active_queue and active_queue.state != PlaybackState.IDLE:
2982                # transfer leadership to a remaining member instead of dissolving
2983                await self._transfer_ad_hoc_leadership(parent_player, remaining_members)
2984                return
2985            self.logger.info(
2986                "Dissolving sync group of player %s as it is being removed from itself",
2987                parent_player.name,
2988            )
2989            player_ids_to_add = None
2990            player_ids_to_remove = [
2991                x for x in parent_player.state.group_members if x != target_player
2992            ]
2993            should_stop = True
2994        # filter all player ids on compatibility and availability
2995        final_player_ids_to_add: list[str] = []
2996        for child_player_id in player_ids_to_add or []:
2997            if child_player_id == target_player:
2998                continue
2999            if child_player_id in final_player_ids_to_add:
3000                continue
3001            if (
3002                not (child_player := self.get_player(child_player_id))
3003                or not child_player.state.available
3004            ):
3005                self.logger.warning("Player %s is not available", child_player_id)
3006                continue
3007
3008            # check if player can be synced/grouped with the target player
3009            # state.can_group_with already handles all expansion and translation
3010            if child_player_id not in parent_player.state.can_group_with:
3011                self.logger.warning(
3012                    "Player %s can not be grouped with %s",
3013                    child_player.name,
3014                    parent_player.name,
3015                )
3016                continue
3017
3018            if (
3019                child_player.state.synced_to
3020                and child_player.state.synced_to == target_player
3021                and child_player_id in parent_player.state.group_members
3022            ):
3023                continue  # already synced to this target
3024
3025            # also skip if the child is part of this group via its sync leader
3026            # (e.g. synced to the sync leader of this syncgroup)
3027            if (
3028                child_player.state.active_group == target_player
3029                and child_player_id in parent_player.state.group_members
3030            ):
3031                continue
3032
3033            # handle edge case: child player is synced to a different player
3034            # automatically ungroup it first and wait for state to propagate
3035            # but not if the child is already part of this group (via its sync leader)
3036            if child_player.state.synced_to and target_player not in {
3037                child_player.state.synced_to,
3038                child_player.state.active_group,
3039            }:
3040                await self._auto_ungroup_if_synced(child_player, f"joining {parent_player.name}")
3041
3042            # power on the player if needed
3043            if (
3044                not child_player.state.powered
3045                and child_player.state.power_control != PLAYER_CONTROL_NONE
3046            ):
3047                await self._handle_cmd_power(child_player.player_id, True)
3048            # if we reach here, all checks passed
3049            final_player_ids_to_add.append(child_player_id)
3050
3051        # process player ids to remove and filter out invalid/unavailable players and edge cases
3052        final_player_ids_to_remove: list[str] = []
3053        if player_ids_to_remove:
3054            for child_player_id in player_ids_to_remove:
3055                if child_player_id in parent_player.state.group_members:
3056                    final_player_ids_to_remove.append(child_player_id)
3057                    continue
3058                # also accept the removal if the child player itself reports
3059                # being synced to this parent - handles race conditions where the
3060                # parent's group_members state is stale/not yet updated
3061                child_player = self.get_player(child_player_id)
3062                if child_player and child_player.state.synced_to == target_player:
3063                    final_player_ids_to_remove.append(child_player_id)
3064                    continue
3065
3066        # Forward command to the appropriate player after all (base) sanity checks
3067        # GROUP players (sync_group, universal_group) manage their own members internally
3068        # and don't need protocol translation - call their set_members directly
3069        if (
3070            parent_player.type == PlayerType.GROUP
3071            and PlayerFeature.SET_MEMBERS in parent_player.state.supported_features
3072        ):
3073            await parent_player.set_members(
3074                player_ids_to_add=final_player_ids_to_add,
3075                player_ids_to_remove=final_player_ids_to_remove,
3076            )
3077            return
3078        # For regular players, handle protocol selection and translation
3079        await self._handle_set_members_with_protocols(
3080            parent_player, final_player_ids_to_add, final_player_ids_to_remove
3081        )
3082
3083        if should_stop:
3084            # Stop playback on the player if it is being removed from itself
3085            await self._handle_cmd_stop(parent_player.player_id)
3086
3087    async def _handle_set_members_with_protocols(
3088        self,
3089        parent_player: Player,
3090        player_ids_to_add: list[str],
3091        player_ids_to_remove: list[str],
3092    ) -> None:
3093        """
3094        Handle set_members considering protocol and native members.
3095
3096        Skips permission checks, locking, and all redirect logic (internal use only).
3097        Translates visible player IDs to protocol player IDs when appropriate,
3098        and forwards to the correct player's set_members.
3099
3100        :param parent_player: The parent player to add/remove members to/from.
3101        :param player_ids_to_add: List of visible player IDs to add as members.
3102        :param player_ids_to_remove: List of visible player IDs to remove from members.
3103        """
3104        # Get parent's active protocol domain and player if available
3105        parent_protocol_domain = None
3106        parent_protocol_player = None
3107        if (
3108            parent_player.active_output_protocol
3109            and parent_player.active_output_protocol != "native"
3110        ):
3111            parent_protocol_player = self.get_player(parent_player.active_output_protocol)
3112            if parent_protocol_player:
3113                parent_protocol_domain = parent_protocol_player.provider.domain
3114
3115        self.logger.debug(
3116            "set_members on %s: active_protocol=%s, adding=%s, removing=%s",
3117            parent_player.state.name,
3118            parent_protocol_domain or "none",
3119            player_ids_to_add,
3120            player_ids_to_remove,
3121        )
3122
3123        # Translate members to add
3124        (
3125            protocol_members_to_add,
3126            native_members_to_add,
3127            parent_protocol_player,
3128            parent_protocol_domain,
3129        ) = self._translate_members_for_protocols(
3130            parent_player, player_ids_to_add, parent_protocol_player, parent_protocol_domain
3131        )
3132
3133        self.logger.debug(
3134            "Translated members: protocol=%s (domain=%s), native=%s",
3135            protocol_members_to_add,
3136            parent_protocol_domain,
3137            native_members_to_add,
3138        )
3139
3140        # Translate members to remove
3141        protocol_members_to_remove, native_members_to_remove = (
3142            self._translate_members_to_remove_for_protocols(
3143                parent_player, player_ids_to_remove, parent_protocol_player, parent_protocol_domain
3144            )
3145        )
3146
3147        # Forward protocol members to protocol player's set_members
3148        if (protocol_members_to_add or protocol_members_to_remove) and parent_protocol_player:
3149            await self._forward_protocol_set_members(
3150                parent_player,
3151                parent_protocol_player,
3152                protocol_members_to_add,
3153                protocol_members_to_remove,
3154            )
3155
3156        # Forward native members to parent player's set_members
3157        if native_members_to_add or native_members_to_remove:
3158            filtered_native_add = self._filter_native_members(native_members_to_add, parent_player)
3159            # For removal, allow protocol players if they're actually in the parent's group_members
3160            # This handles native protocol players (e.g., native AirPlay) where group_members
3161            # contains protocol player IDs
3162            filtered_native_remove = [
3163                pid
3164                for pid in native_members_to_remove
3165                if (p := self.get_player(pid))
3166                and (p.type != PlayerType.PROTOCOL or pid in parent_player.group_members)
3167            ]
3168            self.logger.debug(
3169                "Native grouping on %s: filtered_add=%s, filtered_remove=%s",
3170                parent_player.state.name,
3171                filtered_native_add,
3172                filtered_native_remove,
3173            )
3174            if filtered_native_add or filtered_native_remove:
3175                if PlayerFeature.SET_MEMBERS not in parent_player.state.supported_features:
3176                    return
3177                self.logger.info(
3178                    "Calling set_members on native player %s with add=%s, remove=%s",
3179                    parent_player.state.name,
3180                    filtered_native_add,
3181                    filtered_native_remove,
3182                )
3183                await parent_player.set_members(
3184                    player_ids_to_add=filtered_native_add or None,
3185                    player_ids_to_remove=filtered_native_remove or None,
3186                )
3187
3188    async def _transfer_ad_hoc_leadership(
3189        self, leader: Player, remaining_members: list[str]
3190    ) -> None:
3191        """
3192        Transfer leadership of an ad-hoc sync group to a remaining member.
3193
3194        Called when the sync leader of an ad-hoc group is unjoined while other
3195        members remain and playback is active. The queue is moved to a newly
3196        selected leader, the remaining members are regrouped under it and playback
3197        resumes at the saved position (accepting a brief audio gap).
3198
3199        :param leader: The current sync leader being removed from the group.
3200        :param remaining_members: Available group members (excluding the leader)
3201            that should keep playing under a new leader.
3202        """
3203        active_queue = self.get_active_queue(leader)
3204        was_playing = active_queue is not None and active_queue.state == PlaybackState.PLAYING
3205        new_leader_id = self._select_ad_hoc_leader(leader, remaining_members)
3206        self.logger.info(
3207            "Transferring leadership of %s to %s (%s remaining member(s))",
3208            leader.name,
3209            new_leader_id,
3210            len(remaining_members),
3211        )
3212        # Move the queue to the new leader. transfer_queue frees the new leader from
3213        # the old leader's group and stops the old leader; the playback position
3214        # survives because stop() stores it in resume_pos.
3215        await self.mass.player_queues.transfer_queue(
3216            leader.player_id, new_leader_id, auto_play=False
3217        )
3218        # regroup the other remaining members under the new leader
3219        other_members = [m for m in remaining_members if m != new_leader_id]
3220        if other_members:
3221            await self.cmd_set_members(new_leader_id, player_ids_to_add=other_members)
3222        if was_playing:
3223            await self.mass.player_queues.resume(new_leader_id)
3224
3225    def _select_ad_hoc_leader(self, leader: Player, remaining_members: list[str]) -> str:
3226        """
3227        Pick the new leader for an ad-hoc sync group leadership transfer.
3228
3229        Prefers a remaining member that supports the protocol the group is currently
3230        playing on, so the other members can be regrouped under it; falls back to the
3231        first remaining member. The members' own ``can_group_with`` is unusable here
3232        because it is empty while they are still synced to the old leader.
3233
3234        :param leader: The current sync leader being removed.
3235        :param remaining_members: Candidate member player_ids, already filtered for
3236            availability. Must not be empty.
3237        """
3238        active_domain: str | None = None
3239        if leader.active_output_protocol and leader.active_output_protocol != "native":
3240            if protocol_player := self.get_player(leader.active_output_protocol):
3241                active_domain = protocol_player.provider.domain
3242        if active_domain:
3243            for member_id in remaining_members:
3244                member = self.get_player(member_id)
3245                if member is None:
3246                    continue
3247                if member.provider.domain == active_domain or any(
3248                    protocol.protocol_domain == active_domain and protocol.available
3249                    for protocol in member.linked_output_protocols
3250                ):
3251                    return member_id
3252        return remaining_members[0]
3253
3254    def _clear_sleep_timer(self, player: Player) -> None:
3255        """
3256        Clear the active sleep timer for the player.
3257
3258        :param player: Player to clear the timer for.
3259        """
3260        self.mass.cancel_timer(self._sleep_timer_task_id(player.player_id))
3261        if player.sleep_timer_expires_at is not None:
3262            player.set_sleep_timer_expires_at(None)
3263            player.update_state()
3264            self._signal_sleep_timer_updated(player, None)
3265
3266    async def _handle_sleep_timer_expired(self, player_id: str) -> None:
3267        """
3268        Stop playback when a player's sleep timer expires.
3269
3270        :param player_id: Player ID whose sleep timer expired.
3271        """
3272        player = self.get_player(player_id)
3273        if player is None or player.sleep_timer_expires_at is None:
3274            return
3275        player.set_sleep_timer_expires_at(None)
3276        player.update_state()
3277        self._signal_sleep_timer_updated(player, None)
3278        await self.cmd_stop(player_id)
3279
3280    def _signal_sleep_timer_updated(self, player: Player, expires_at: float | None) -> None:
3281        """
3282        Signal a sleep timer change for the player on the event bus.
3283
3284        :param player: Player whose sleep timer changed.
3285        :param expires_at: New expiry timestamp, or None when the timer was cleared.
3286        """
3287        if player.state.type == PlayerType.PROTOCOL:
3288            return
3289        self.mass.signal_event(
3290            EventType.PLAYER_SLEEP_TIMER_UPDATED,
3291            object_id=player.player_id,
3292            data=expires_at,
3293        )
3294
3295    @staticmethod
3296    def _sleep_timer_task_id(player_id: str) -> str:
3297        """
3298        Return the scheduled task ID for a player's sleep timer.
3299
3300        :param player_id: Player ID to build the task ID for.
3301        """
3302        return f"player_sleep_timer_{player_id}"
3303
3304    # Private command handlers (no permission checks)
3305
3306    async def _handle_cmd_resume(
3307        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
3308    ) -> None:
3309        """
3310        Handle resume playback command.
3311
3312        Skips permission checks and locking (internal use only).
3313        """
3314        player = self._get_player_with_redirect(player_id)
3315        source = source or player.state.active_source
3316        media = media or player.state.current_media
3317        # power on the player if needed
3318        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3319            await self._handle_cmd_power(player.player_id, True)
3320        # Redirect to queue controller if it is active
3321        if active_queue := self.mass.player_queues.get(source or player_id):
3322            await self.mass.player_queues.resume(active_queue.queue_id)
3323            return
3324        # try to handle command on player directly
3325        # TODO: check if player has an active source with native resume support
3326        active_source = next((x for x in player.state.source_list if x.id == source), None)
3327        if (
3328            player.state.playback_state in (PlaybackState.IDLE, PlaybackState.PAUSED)
3329            and active_source
3330            and active_source.can_play_pause
3331            and PlayerFeature.PAUSE in player.state.supported_features
3332        ):
3333            # player has some other source active and native resume support
3334            await player.play()
3335            return
3336        if active_source and not active_source.passive:
3337            await self.select_source(player_id, active_source.id)
3338            return
3339        if media:
3340            # try to re-play the current media item
3341            await player.play_media(media)
3342            return
3343        # fallback: just try to resume queue playback
3344        await self.mass.player_queues.resume(player.player_id)
3345
3346    async def _handle_cmd_power(
3347        self, player_id: str, powered: bool, skip_auto_play: bool = False
3348    ) -> None:
3349        """
3350        Handle player power on/off command.
3351
3352        Skips permission checks and locking (internal use only).
3353
3354        :param player_id: The player ID to power on/off.
3355        :param powered: True to power on, False to power off.
3356        :param skip_auto_play: If True, skip auto-play on power on.
3357        """
3358        player = self.get_player(player_id, True)
3359        assert player is not None  # for type checking
3360        player_state = player.state
3361
3362        if player_state.powered == powered:
3363            self.logger.debug(
3364                "Ignoring power %s command for player %s: already in state %s",
3365                "ON" if powered else "OFF",
3366                player_state.name,
3367                "ON" if player_state.powered else "OFF",
3368            )
3369            return  # nothing to do
3370
3371        # ungroup player at power off
3372        player_was_sync_child = bool(player.state.synced_to or player.state.active_group)
3373        if (
3374            (player_was_sync_child or player.group_members)
3375            and player.type == PlayerType.PLAYER
3376            and not powered
3377        ):
3378            # ungroup player if it is synced (or is a sync leader itself)
3379            await self.cmd_ungroup(player_id)
3380
3381        # always stop player at power off
3382        if (
3383            not powered
3384            and not player_was_sync_child
3385            and player_state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
3386        ):
3387            # wait for the stop command to process and prevent race conditions
3388            async with self.wait_for_player_update(player_id, timeout=5):
3389                await self._handle_cmd_stop(player_id)
3390
3391        # power off all synced childs when player is a sync leader
3392        elif not powered and player_state.type == PlayerType.PLAYER and player_state.group_members:
3393            async with TaskManager(self.mass) as tg:
3394                for member in self.iter_group_members(player, True):
3395                    if member.power_control == PLAYER_CONTROL_NONE:
3396                        continue
3397                    tg.create_task(self._handle_cmd_power(member.player_id, False))
3398
3399        # handle actual power command
3400        if player_state.power_control == PLAYER_CONTROL_NONE:
3401            self.logger.debug(
3402                "Player %s does not support power control, ignoring power command",
3403                player_state.name,
3404            )
3405            return
3406        if player_state.power_control == PLAYER_CONTROL_NATIVE:
3407            # player supports power command natively: forward to player provider
3408            await player.power(powered)
3409            if powered:
3410                await wait_for_power_on(self.logger, player)
3411        elif player_state.power_control == PLAYER_CONTROL_FAKE:
3412            # user wants to use fake power control - so we (optimistically) update the state
3413            # and store the state in the cache
3414            player.extra_data[ATTR_FAKE_POWER] = powered
3415            # Group players need to actively form/dissolve their session when the
3416            # user toggles fake power — otherwise the toggle would only update the
3417            # cosmetic state without ever capturing or releasing the members.
3418            if player_state.type == PlayerType.GROUP:
3419                await player.power(powered)
3420            player.update_state()  # trigger update of the player state
3421            if player_state.type != PlayerType.GROUP:
3422                # see register(): group fake-power is intentionally not persisted
3423                # because there is no session to restore at boot.
3424                await self.mass.cache.set(
3425                    key=player_id,
3426                    data=powered,
3427                    provider=self.domain,
3428                    category=CACHE_CATEGORY_PLAYER_POWER,
3429                )
3430        # handle external player control
3431        elif player_control := self._controls.get(player.state.power_control):
3432            control_name = player_control.name
3433            self.logger.debug("Redirecting power command to PlayerControl %s", control_name)
3434            if not player_control.supports_power:
3435                raise UnsupportedFeaturedException(
3436                    f"Player control {control_name} is not available"
3437                )
3438            if powered:
3439                assert player_control.power_on is not None  # for type checking
3440                await player_control.power_on()
3441                await wait_for_power_on(self.logger, player, player_control)
3442            else:
3443                assert player_control.power_off is not None  # for type checking
3444                await player_control.power_off()
3445        # always trigger a state update to update the UI
3446        player.refresh_state()
3447
3448        # handle 'auto play on power on' feature
3449        if (
3450            not skip_auto_play
3451            and not player_state.active_group
3452            and not player_state.synced_to
3453            and powered
3454            and player.config.get_value(CONF_AUTO_PLAY)
3455            and player_state.active_source in (None, player_id)
3456            and not player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)
3457        ):
3458            await self.mass.player_queues.resume(player_id)
3459
3460    async def _handle_cmd_volume_set(self, player_id: str, volume_level: int) -> None:
3461        """
3462        Handle Player volume set command.
3463
3464        Skips permission checks and locking (internal use only).
3465
3466        :param player_id: player_id of the player to handle the command.
3467        :param volume_level: logical volume level (0..100) to set on the player.
3468        """
3469        player = self.get_player(player_id, True)
3470        assert player is not None  # for type checker
3471
3472        # Clamp logical volume to 0-100
3473        volume_level = max(0, min(100, volume_level))
3474
3475        if player.type == PlayerType.GROUP:
3476            # redirect to special group volume control
3477            await self.cmd_group_volume(player_id, volume_level)
3478            return
3479
3480        # Check if player has mute lock (set when individually muted in a group)
3481        # If locked, don't auto-unmute when volume changes
3482        has_mute_lock = self._has_active_mute_lock(player)
3483        if (
3484            not has_mute_lock
3485            # the live value is what cmd_volume_mute checks, so a control change that
3486            # has not reached the player state yet may not send us into a failing unmute
3487            and player.mute_control not in (PLAYER_CONTROL_NONE, PLAYER_CONTROL_FAKE)
3488            and player.state.volume_muted
3489        ):
3490            # if player is muted and not locked, we unmute it first
3491            # skip this for fake mute since it uses volume to simulate mute
3492            self.logger.debug(
3493                "Unmuting player %s before setting volume",
3494                player.state.name,
3495            )
3496            await self.cmd_volume_mute(player_id, False)
3497
3498        if (
3499            has_mute_lock
3500            and player.mute_control == PLAYER_CONTROL_FAKE
3501            and player.extra_data.get(ATTR_FAKE_MUTE)
3502        ):
3503            # a locked player stays silent, the volume it holds is the one
3504            # that gets restored once it is unmuted again
3505            volume_level = 0
3506        else:
3507            # always reset fake mute when controlling volume
3508            player.extra_data.pop(ATTR_FAKE_MUTE, None)
3509
3510        # Scale logical volume (0-100) to device volume (min_volume-max_volume)
3511        device_volume = self.scale_volume_to_device(player_id, volume_level)
3512
3513        # Notify the active AudioSource of a volume change.
3514        # Only fire if this player is the direct owner of its queue,
3515        # not when it merely inherits active_source from a parent group —
3516        # group volume changes handle the callback once at the group level.
3517        if active := self._get_active_audio_source(player):
3518            audio_source, plugin_prov = active
3519            active_queue = self.get_active_queue(player)
3520            if active_queue is not None and active_queue.queue_id == player.player_id:
3521                await plugin_prov.on_volume_change(audio_source.item_id, volume_level)
3522
3523        # Handle native volume control support
3524        if player.volume_control == PLAYER_CONTROL_NATIVE:
3525            # player supports volume command natively: forward to player
3526            await player.volume_set(device_volume)
3527            return
3528        # Handle fake volume control support
3529        if player.volume_control == PLAYER_CONTROL_FAKE:
3530            # user wants to use fake volume control - so we (optimistically) update the state
3531            # and store the state in the cache. Fake volume uses the logical volume (no scaling).
3532            player.extra_data[ATTR_FAKE_VOLUME] = volume_level
3533            player.update_state()
3534            return
3535        # player has no volume support at all
3536        if player.volume_control == PLAYER_CONTROL_NONE:
3537            raise UnsupportedFeaturedException(
3538                f"Player {player.state.name} does not support volume control"
3539            )
3540        # handle external player control
3541        if player_control := self._controls.get(player.state.volume_control):
3542            control_name = player_control.name
3543            self.logger.debug("Redirecting volume command to PlayerControl %s", control_name)
3544            if not player_control.supports_volume:
3545                raise UnsupportedFeaturedException(
3546                    f"Player control {control_name} is not available"
3547                )
3548            assert player_control.volume_set is not None
3549            # forward the already-scaled device volume; the external control sets the
3550            # raw device volume and does not apply min/max scaling of its own
3551            await player_control.volume_set(device_volume)
3552            return
3553        if protocol_player := self.get_player(player.state.volume_control):
3554            # redirect to protocol player volume control.
3555            # forward the already-scaled device volume so the min/max limits configured
3556            # on this (user-facing) player are honored; the protocol player has no
3557            # limits of its own, so its scaling is an identity pass-through.
3558            self.logger.debug(
3559                "Redirecting volume command to protocol player %s",
3560                protocol_player.provider.manifest.name,
3561            )
3562            await self._handle_cmd_volume_set(protocol_player.player_id, device_volume)
3563            return
3564
3565    @staticmethod
3566    def _is_in_group(state: PlayerState) -> bool:
3567        """Check if the player with the given state is currently grouped with other players."""
3568        # a sync leader has neither synced_to nor active_group set, but it does lead its
3569        # own group_members, which stays empty for a player that is not grouped at all
3570        return bool(state.synced_to or state.active_group or state.group_members)
3571
3572    def _has_active_mute_lock(self, player: Player) -> bool:
3573        """
3574        Check if the given player holds a mute lock that still applies to it.
3575
3576        A lock is only earned inside a group and only holds for as long as the player
3577        is still grouped, so it can not outlive the group it was earned in.
3578
3579        :param player: The player to check, which may be a protocol player.
3580        """
3581        if player.extra_data.get(ATTR_MUTE_LOCK) and self._is_in_group(player.state):
3582            return True
3583        # cmd_volume_mute stores the lock on the parent player, while the volume command
3584        # may arrive with the protocol player ID (e.g. during group volume changes)
3585        if player.protocol_parent_id and (parent := self.get_player(player.protocol_parent_id)):
3586            return bool(parent.extra_data.get(ATTR_MUTE_LOCK)) and self._is_in_group(parent.state)
3587        return False
3588
3589    async def _mute_group_members(self, group_player: Player, muted: bool) -> None:
3590        """
3591        Mute or unmute all mute capable members of a player group or synced players.
3592
3593        :param group_player: The group player or sync leader.
3594        :param muted: bool if the group should be muted.
3595        """
3596        coros = []
3597        for child_player in self.iter_group_members(
3598            group_player, only_powered=True, exclude_self=False
3599        ):
3600            if child_player.mute_control == PLAYER_CONTROL_NONE:
3601                # members without a mute control are left alone, just like the
3602                # group mute state itself is calculated from the capable members only
3603                continue
3604            coros.append(self.cmd_volume_mute(child_player.player_id, muted))
3605        await asyncio.gather(*coros)
3606
3607    async def _handle_cmd_volume_mute(self, player: Player, mute_control: str, muted: bool) -> None:
3608        """
3609        Send the mute command to the given player's mute control.
3610
3611        Skips permission checks, locking and mute lock bookkeeping (internal use only).
3612
3613        :param player: the player to handle the command.
3614        :param mute_control: the already resolved mute control of the player.
3615        :param muted: bool if player should be muted.
3616        """
3617        if mute_control == PLAYER_CONTROL_NATIVE:
3618            # player supports mute command natively: forward to player
3619            await player.volume_mute(muted)
3620            return
3621        if mute_control == PLAYER_CONTROL_FAKE:
3622            # user wants to use fake mute control - so we use volume instead
3623            self.logger.debug(
3624                "Using volume for muting for player %s",
3625                player.state.name,
3626            )
3627            if muted:
3628                already_muted = bool(player.extra_data.get(ATTR_FAKE_MUTE))
3629                if not already_muted:
3630                    # on a repeated mute command the volume is already 0
3631                    player.extra_data[ATTR_PREVIOUS_VOLUME] = player.state.volume_level
3632                await self._handle_cmd_volume_set(player.player_id, 0)
3633                # set the flag after the volume command, as that clears it
3634                player.extra_data[ATTR_FAKE_MUTE] = True
3635                player.update_state()
3636            else:
3637                was_muted = bool(player.extra_data.get(ATTR_FAKE_MUTE))
3638                player.extra_data[ATTR_FAKE_MUTE] = False
3639                player.update_state()
3640                if not was_muted:
3641                    # the volume is the one the user is listening at, restoring
3642                    # anything here would turn a no-op unmute into a volume change
3643                    return
3644                stored_volume: int | None = player.extra_data.pop(ATTR_PREVIOUS_VOLUME, None)
3645                # the volume was still unknown at mute time, so pick a low volume
3646                # rather than blasting the speaker at some assumed level
3647                await self._handle_cmd_volume_set(
3648                    player.player_id, 1 if stored_volume is None else stored_volume
3649                )
3650            return
3651
3652        # handle external player control
3653        if player_control := self._controls.get(mute_control):
3654            control_name = player_control.name
3655            self.logger.debug("Redirecting mute command to PlayerControl %s", control_name)
3656            if not player_control.supports_mute:
3657                raise UnsupportedFeaturedException(
3658                    f"Player control {control_name} is not available"
3659                )
3660            assert player_control.mute_set is not None
3661            await player_control.mute_set(muted)
3662            return
3663
3664        # handle to protocol player as volume_mute control
3665        if protocol_player := self.get_player(mute_control):
3666            self.logger.debug(
3667                "Redirecting mute command to protocol player %s",
3668                protocol_player.provider.manifest.name,
3669            )
3670            await protocol_player.volume_mute(muted)
3671            return
3672
3673        # the configured control disappeared after the mute control was resolved
3674        raise UnsupportedFeaturedException(f"Player {player.state.name} does not support muting")
3675
3676    async def _handle_play_media(self, player_id: str, media: PlayerMedia) -> None:
3677        """
3678        Handle play media command without group redirect.
3679
3680        Skips permission checks, locking, and all redirect logic (internal use only).
3681
3682        :param player_id: player_id of the player to handle the command.
3683        :param media: The Media that needs to be played on the player.
3684        """
3685        player = self.get_player(player_id, raise_unavailable=True)
3686        assert player is not None
3687        # set active source if media has a source_id (e.g. plugin source or mass queue source)
3688        if media.source_id:
3689            player.set_active_mass_source(media.source_id)
3690
3691        # Determine output protocol to use:
3692        # While a session is active (playing/paused), keep using the already active
3693        # protocol so mid-session commands stay on the same output.
3694        # On a fresh start always (re)select: a leftover active protocol from a
3695        # previous session must not overrule user preference, a grouped protocol
3696        # or native playback (and it may point at a player that is gone by now).
3697        target_player: Player | None = None
3698        output_protocol: OutputProtocol | None = None
3699        if (
3700            player.state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
3701            and player.active_output_protocol
3702            and player.active_output_protocol != "native"
3703            and (protocol_player := self.get_player(player.active_output_protocol))
3704        ):
3705            # Use the already-set protocol directly
3706            output_protocol = next(
3707                (
3708                    p
3709                    for p in player.linked_output_protocols
3710                    if p.output_protocol_id == player.active_output_protocol
3711                ),
3712                None,
3713            )
3714            if output_protocol is not None:
3715                target_player = protocol_player
3716        if target_player is None:
3717            target_player, output_protocol = self._select_best_output_protocol(player)
3718
3719        if target_player.player_id != player.player_id:
3720            # Playing via linked protocol - update active output protocol
3721            # output_protocol is guaranteed to be non-None when target_player != player
3722            assert output_protocol is not None
3723            self.logger.debug(
3724                "Starting playback on %s via protocol %s (target=%s), group_members=%s",
3725                player.state.name,
3726                output_protocol.name,
3727                target_player.display_name,
3728                target_player.state.group_members,
3729            )
3730            player.set_active_output_protocol(output_protocol.output_protocol_id)
3731        elif player.type != PlayerType.GROUP:
3732            # Native playback - group players don't have output protocols of their own
3733            # (they delegate to a sync leader / member which manages its own protocol)
3734            self.logger.debug(
3735                "Starting playback on %s via native, group_members=%s",
3736                player.state.name,
3737                player.state.group_members,
3738            )
3739            player.set_active_output_protocol("native")
3740
3741        # power on the player if needed (skip auto-play since we're about to start playback)
3742        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3743            await self._handle_cmd_power(player.player_id, True, skip_auto_play=True)
3744        await target_player.play_media(media)
3745        if target_player.player_id != player.player_id:
3746            # notify the native player that protocol playback started
3747            assert output_protocol is not None
3748            await player.on_protocol_playback(output_protocol=output_protocol)
3749
3750    async def _handle_enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
3751        """
3752        Handle enqueue next media command without group redirect.
3753
3754        Skips permission checks, locking, and all redirect logic (internal use only).
3755
3756        :param player_id: player_id of the player to handle the command.
3757        :param media: The Media that needs to be enqueued on the player.
3758        """
3759        player = self.get_player(player_id, raise_unavailable=True)
3760        assert player is not None
3761        if target_player := self._get_control_target(
3762            player,
3763            required_feature=PlayerFeature.ENQUEUE,
3764            require_active=True,
3765        ):
3766            self.logger.debug(
3767                "Redirecting enqueue command to protocol player %s",
3768                target_player.provider.manifest.name,
3769            )
3770            await target_player.enqueue_next_media(media)
3771            return
3772
3773        if PlayerFeature.ENQUEUE not in player.state.supported_features:
3774            raise UnsupportedFeaturedException(
3775                f"Player {player.state.name} does not support enqueueing"
3776            )
3777        await player.enqueue_next_media(media)
3778
3779    async def _handle_select_source(self, player_id: str, source: str | None) -> None:
3780        """
3781        Handle select source command without group redirect.
3782
3783        Skips permission checks, locking, and all redirect logic (internal use only).
3784
3785        :param player_id: player_id of the player to handle the command.
3786        :param source: The ID of the source that needs to be activated/selected.
3787        """
3788        if source is None:
3789            source = player_id  # default to MA queue source
3790        player = self.get_player(player_id, True)
3791        assert player is not None
3792        # check if player is already playing and source is different
3793        # in that case we need to stop the player first
3794        prev_source = player.state.active_source
3795        if prev_source and source != prev_source:
3796            with suppress(PlayerCommandFailed, RuntimeError):
3797                # just try to stop (regardless of state)
3798                async with self.wait_for_player_update(player_id, timeout=5):
3799                    await self._handle_cmd_stop(player_id)
3800        # check if source is a mass queue
3801        # this can be used to restore the queue after a source switch
3802        if self.mass.player_queues.get(source):
3803            player.set_active_mass_source(source)
3804            return
3805        # Legacy compatibility: the old plugin-source API used the
3806        # plugin's instance_id directly as the source string. The refactor
3807        # moved plugin sources to first-class AudioSource MediaItems played
3808        # via player_queues.play_media. Translate a legacy plugin-instance-id
3809        # source into the new flow so old frontends, third-party scripts,
3810        # and HA automations keep working — but only when the provider
3811        # exposes EXACTLY ONE AudioSource (it was always a 1:1 mapping under
3812        # the old API; multi-source providers have to use the explicit URI).
3813        if (legacy_prov := self.mass.get_provider(source)) and isinstance(
3814            legacy_prov, PluginProvider
3815        ):
3816            if ProviderFeature.AUDIO_SOURCE not in legacy_prov.supported_features:
3817                raise PlayerCommandFailed(f"Provider {source} does not expose AudioSources")
3818            sources = await legacy_prov.get_audio_sources()
3819            if len(sources) == 1:
3820                self.logger.debug(
3821                    "Translating legacy select_source(%s) to play_media(%s)",
3822                    source,
3823                    sources[0].uri,
3824                )
3825                await self.mass.player_queues.play_media(player_id, str(sources[0].uri))
3826                return
3827            raise UnsupportedFeaturedException(
3828                f"Provider {source} exposes {len(sources)} AudioSources; the legacy "
3829                "select_source(plugin_instance_id) API only supported 1:1 mappings. "
3830                "Use player_queues.play_media with an explicit AudioSource URI."
3831            )
3832        # basic check if player supports source selection
3833        if PlayerFeature.SELECT_SOURCE not in player.state.supported_features:
3834            raise UnsupportedFeaturedException(
3835                f"Player {player.state.name} does not support source selection"
3836            )
3837        # basic check if source is valid for player
3838        if not any(x for x in player.state.source_list if x.id == source):
3839            raise PlayerCommandFailed(
3840                f"{source} is an invalid source for player {player.state.name}"
3841            )
3842        # forward to player
3843        await player.select_source(source)
3844
3845    async def _handle_cmd_stop(self, player_id: str) -> None:
3846        """
3847        Handle stop command without any redirects.
3848
3849        Skips permission checks, locking, and all redirect logic (internal use only).
3850
3851        :param player_id: player_id of the player to handle the command.
3852        """
3853        player = self.get_player(player_id, raise_unavailable=True)
3854        assert player is not None
3855        protocol_player: Player | None = None
3856        if player.active_output_protocol and player.active_output_protocol != "native":
3857            protocol_player = self.get_player(player.active_output_protocol)
3858        if player.state.playback_state == PlaybackState.IDLE:
3859            # The player already reports idle but an output protocol is still marked
3860            # active: the protocol player may never have received a stop at all
3861            # (e.g. the source stream ended on its own before this stop command
3862            # arrived). Forward an (idempotent) stop and schedule the protocol clear
3863            # so no stale session lingers on the device and the next playback
3864            # (re)selects the output protocol.
3865            if protocol_player is not None:
3866                await protocol_player.stop()
3867                if len(protocol_player.group_members) <= 1:
3868                    self.schedule_active_output_protocol_clear(player)
3869            return
3870        player.mark_stop_called()
3871        # Delegate to active protocol player if one is active
3872        target_player = player
3873        if protocol_player is not None:
3874            target_player = protocol_player
3875            if PlayerFeature.POWER in target_player.supported_features:
3876                # if protocol player supports/requires power,
3877                # we power it off instead of just stopping (which also stops playback)
3878                # this is rare as most protocols do not support power control (except for cast)
3879                await self._handle_cmd_power(target_player.player_id, False)
3880                return
3881
3882        # handle command on player(protocol) directly
3883        await target_player.stop()
3884        # Only clear active protocol if the protocol player has no remaining group members.
3885        # If there are still protocol group members, keep the protocol active so that
3886        # when playback resumes it continues on the same protocol.
3887        if target_player.player_id == player.player_id or len(target_player.group_members) <= 1:
3888            self.schedule_active_output_protocol_clear(player)
3889
3890    async def _handle_cmd_play(self, player_id: str) -> None:
3891        """
3892        Handle play command without group redirect.
3893
3894        Skips permission checks, locking, and all redirect logic (internal use only).
3895
3896        :param player_id: player_id of the player to handle the command.
3897        """
3898        player = self.get_player(player_id, raise_unavailable=True)
3899        assert player is not None
3900        if player.state.playback_state == PlaybackState.PLAYING:
3901            self.logger.info(
3902                "Ignore PLAY request to player %s: player is already playing", player.state.name
3903            )
3904            return
3905        # If an AudioSource is the active queue item, proxy play to the plugin
3906        if active := self._get_active_audio_source(player):
3907            audio_source, plugin_prov = active
3908            if audio_source.can_play_pause:
3909                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PLAY)
3910                return
3911        # handle unpause (=play if player is paused)
3912        if player.state.playback_state == PlaybackState.PAUSED:
3913            active_source = next(
3914                (x for x in player.state.source_list if x.id == player.state.active_source), None
3915            )
3916            # raise if active source does not support play/pause
3917            if active_source and not active_source.can_play_pause:
3918                msg = (
3919                    f"The active source ({active_source.name}) on player "
3920                    f"{player.state.name} does not support play/pause"
3921                )
3922                raise PlayerCommandFailed(msg)
3923            # Delegate to active protocol player if one is active
3924            if target_player := self._get_control_target(
3925                player, PlayerFeature.PAUSE, require_active=True
3926            ):
3927                await target_player.play()
3928                return
3929            # No active protocol target: if the player rendering the audio supports pause and
3930            # the active (external) source can be paused, unpause it directly instead of
3931            # restarting the source.
3932            output_player = player.resolve_output_player()
3933            if (
3934                active_source
3935                and active_source.can_play_pause
3936                and PlayerFeature.PAUSE in output_player.supported_features
3937            ):
3938                await output_player.play()
3939                return
3940
3941        # player is not paused: try to resume the player
3942        # Note: We handle resume inline here without calling _handle_cmd_resume
3943        active_source = next(
3944            (x for x in player.state.source_list if x.id == player.state.active_source), None
3945        )
3946        media = player.state.current_media
3947        # power on the player if needed
3948        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3949            await self._handle_cmd_power(player.player_id, True)
3950        if active_source and not active_source.passive:
3951            await self._handle_select_source(player_id, active_source.id)
3952            return
3953        if media:
3954            # try to re-play the current media item
3955            await player.play_media(media)
3956            return
3957        # fallback: just send play command - which will fail if nothing can be played
3958        await player.play()
3959
3960    async def _handle_cmd_pause(self, player_id: str) -> None:
3961        """
3962        Handle pause command without any redirects.
3963
3964        Skips permission checks, locking, and all redirect logic (internal use only).
3965
3966        :param player_id: player_id of the player to handle the command.
3967        """
3968        player = self.get_player(player_id, raise_unavailable=True)
3969        assert player is not None
3970        if player.state.playback_state == PlaybackState.IDLE:
3971            return
3972        # If an AudioSource is the active queue item, proxy pause to the plugin
3973        if active := self._get_active_audio_source(player):
3974            audio_source, plugin_prov = active
3975            if audio_source.can_play_pause:
3976                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PAUSE)
3977                return
3978        # handle command on player/source directly
3979        active_source = next(
3980            (x for x in player.state.source_list if x.id == player.state.active_source), None
3981        )
3982        if active_source and not active_source.can_play_pause:
3983            # raise if active source does not support play/pause
3984            msg = (
3985                f"The active source ({active_source.name}) on player "
3986                f"{player.state.name} does not support play/pause"
3987            )
3988            raise PlayerCommandFailed(msg)
3989        # Delegate to active protocol player if one is active
3990        if target_player := self._get_control_target(
3991            player, PlayerFeature.PAUSE, require_active=True
3992        ):
3993            await target_player.pause()
3994            return
3995        # No active protocol target: if the player rendering the audio supports pause and the
3996        # active (external) source can be paused, forward the command to it instead of stopping
3997        # it (mirrors the external-source handling in cmd_seek/cmd_next_track).
3998        output_player = player.resolve_output_player()
3999        if (
4000            active_source
4001            and active_source.can_play_pause
4002            and PlayerFeature.PAUSE in output_player.supported_features
4003        ):
4004            await output_player.pause()
4005            return
4006        # player/protocol does not support pause: fall back to stop
4007        self.logger.debug(
4008            "Player/protocol %s does not support pause, using STOP instead",
4009            player.state.name,
4010        )
4011        await self._handle_cmd_stop(player.player_id)
4012