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        # teardown is best-effort: a provider that fails to release its player must not
1602        # strand the other players of that provider, nor the provider unload itself
1603        try:
1604            await player.on_unload()
1605        except Exception:
1606            self.logger.exception("Error unloading player %s", player.name)
1607        if permanent:
1608            # player permanent removal: cleanup protocol links, delete config
1609            # and signal PLAYER_REMOVED event
1610            await self._cleanup_player_memberships(player_id)
1611            self._cleanup_protocol_links(player)
1612            self.delete_player_config(player_id)
1613            self.logger.info("Player removed: %s", player.name)
1614            if player.state.type != PlayerType.PROTOCOL:
1615                self.mass.signal_event(EventType.PLAYER_REMOVED, player_id)
1616        else:
1617            # temporary unavailable: mark player as unavailable
1618            # note: the player will be re-registered later if it comes back online
1619            player.state.available = False
1620            self.logger.info("Player unavailable: %s", player.name)
1621            if player.state.type != PlayerType.PROTOCOL:
1622                self.mass.signal_event(
1623                    EventType.PLAYER_UPDATED, object_id=player.player_id, data=player.state
1624                )
1625        # Schedule debounced update of all players since can_group_with values may change
1626        self._schedule_update_all_players()
1627
1628    @api_command("players/remove", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1629    async def remove(self, player_id: str) -> None:
1630        """
1631        Remove a player from a provider.
1632
1633        Can only be called when a PlayerProvider supports ProviderFeature.REMOVE_PLAYER.
1634        """
1635        player = self.get_player(player_id)
1636        if player is None:
1637            # we simply permanently delete the player config since it is not registered
1638            self.delete_player_config(player_id)
1639            return
1640        if player.state.type == PlayerType.GROUP:
1641            # Handle group player removal
1642            player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1643            await player.provider.remove_group_player(player_id)
1644            return
1645        player.provider.check_feature(ProviderFeature.REMOVE_PLAYER)
1646        await player.provider.remove_player(player_id)
1647        # check for group memberships that need to be updated
1648        if player.state.active_group and (
1649            group_player := self.mass.players.get_player(player.state.active_group)
1650        ):
1651            # try to remove from the group
1652            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1653                await group_player.set_members(
1654                    player_ids_to_remove=[player_id],
1655                )
1656        # We removed the player and can now clean up its config
1657        self.delete_player_config(player_id)
1658
1659    def delete_player_config(self, player_id: str) -> None:
1660        """
1661        Permanently delete a player's configuration.
1662
1663        Should only be called for players that are not registered by the player controller.
1664        """
1665        # we simply permanently delete the player by wiping its config
1666        conf_key = f"{CONF_PLAYERS}/{player_id}"
1667        dsp_conf_key = f"{CONF_PLAYER_DSP}/{player_id}"
1668        for key in (conf_key, dsp_conf_key):
1669            self.mass.config.remove(key)
1670
1671    def scale_volume_to_device(self, player_id: str, logical_volume: int) -> int:
1672        """Scale logical volume (0-100) to device volume (min_volume-max_volume)."""
1673        min_volume, max_volume = self._get_volume_limits(player_id)
1674        if min_volume == 0 and max_volume == 100:
1675            return logical_volume
1676        # Scale: logical 0 -> min_volume, logical 100 -> max_volume
1677        return min_volume + (logical_volume * (max_volume - min_volume)) // 100
1678
1679    def scale_volume_from_device(self, player_id: str, device_volume: int) -> int:
1680        """Scale device volume (min_volume-max_volume) to logical volume (0-100)."""
1681        min_volume, max_volume = self._get_volume_limits(player_id)
1682        if min_volume == 0 and max_volume == 100:
1683            return device_volume
1684        volume_range = max_volume - min_volume
1685        if volume_range == 0:
1686            return 0
1687        # Scale to 0-100 without clamping so that out-of-range device volumes
1688        # produce distinct logical values, ensuring state change detection triggers
1689        # volume limit enforcement
1690        return ((device_volume - min_volume) * 100) // volume_range
1691
1692    def on_player_position_jumped(self, player: Player) -> None:
1693        """
1694        Handle a discrete jump of a player's corrected playback position.
1695
1696        Called by a Player when its corrected position moved significantly
1697        outside regular playback progression (seek or buffer correction). This
1698        is not an event by itself: it re-bases the active queue's timing on the
1699        fresh position and nudges related players so derived positions stay in
1700        sync; current_media then re-anchors from the corrected queue time on
1701        the follow-up update, which emits the actual update event.
1702        """
1703        if self.mass.closing:
1704            return
1705        self.mass.player_queues.on_player_elapsed_time_corrected(player)
1706        self.trigger_player_update(player.player_id)
1707        self._forward_state_update(player, {})
1708
1709    def signal_player_state_update(
1710        self,
1711        player: Player,
1712        changed_values: dict[str, tuple[Any, Any]],
1713        force_update: bool = False,
1714        skip_forward: bool = False,
1715        media_position_jumped: bool = False,
1716    ) -> None:
1717        """
1718        Signal a player state update.
1719
1720        Called by a Player when its state has changed.
1721        This will update the player state in the controller and signal the event bus.
1722        """
1723        player_id = player.player_id
1724        if self.mass.closing:
1725            return
1726
1727        # ignore updates for disabled players
1728        if not player.state.enabled and ATTR_ENABLED not in changed_values:
1729            return
1730
1731        # The current_media position anchor only changes on discrete events
1732        # (play/pause/seek/track change/buffer correction), so a change set holding
1733        # only anchor keys represents a position correction rather than a regular
1734        # state change.
1735        non_anchor_keys = changed_values.keys() - POSITION_ANCHOR_KEYS
1736        if len(non_anchor_keys) == 0 and not force_update:
1737            if not media_position_jumped:
1738                # anchor adoption without a significant corrected-position change
1739                return
1740            # current_media's corrected position jumped (seek or buffer correction
1741            # reached the current media): emit the full player update below so
1742            # consumers see the fresh position
1743
1744        if self.logger.isEnabledFor(VERBOSE_LOG_LEVEL):
1745            self.logger.log(
1746                VERBOSE_LOG_LEVEL,
1747                "Player state updated for %s: changed fields: %s",
1748                player.name,
1749                ", ".join(changed_values.keys()),
1750            )
1751
1752        # signal update to the playerqueue
1753        if player.state.type != PlayerType.PROTOCOL:
1754            self.mass.call_later(
1755                0.5,
1756                self.mass.player_queues.on_player_update,
1757                player,
1758                changed_values,
1759                task_id=f"queue_on_player_update_{player.player_id}",
1760            )
1761
1762        # Kick async palette extraction on cold cache. On transition prefetch
1763        # the next queue item too. Skip players that mirror another player's media
1764        # (grouped/synced members, protocol children): their current_media - palette
1765        # included - is taken wholesale from the owner, so resolving it per member is
1766        # wasted work that also produces duplicate state updates across the group.
1767        if (
1768            not self._mirrors_parent_media(player)
1769            and (current_media := player.state.current_media)
1770            and current_media.image_url
1771        ):
1772            if current_media.palette is None:
1773                self._schedule_palette_fetch(player_id, current_media.image_url)
1774            if "current_media.image_url" in changed_values or "current_media" in changed_values:
1775                self._schedule_next_queue_item_palette_prefetch(player_id, current_media)
1776
1777        # handle DSP reload of the leader when grouping/ungrouping
1778        if ATTR_GROUP_MEMBERS in changed_values:
1779            prev_group_members, new_group_members = changed_values[ATTR_GROUP_MEMBERS]
1780            self._handle_group_dsp_change(player, prev_group_members or [], new_group_members)
1781            # Removed group members also need to be updated since they are no longer part
1782            # of this group and are available for playback again
1783            removed_members = set(prev_group_members or []) - set(new_group_members or [])
1784            for _removed_player_id in removed_members:
1785                if removed_player := self.get_player(_removed_player_id):
1786                    removed_player.refresh_state()
1787
1788        # detect when active_source changes to
1789        # something external while we have a grouped protocol active
1790        if ATTR_ACTIVE_SOURCE in changed_values:
1791            task_id = f"external_source_takeover_{player_id}"
1792            self.mass.call_later(
1793                5,
1794                self._check_external_source_takeover,
1795                player,
1796                task_id=task_id,
1797            )
1798        # only steer into the (relatively expensive) membership cleanup when a field
1799        # that can require an unsync actually changed - this runs on every state tick
1800        if changed_values.keys() & {ATTR_AVAILABLE, ATTR_ENABLED, ATTR_POWERED}:
1801            self._handle_membership_cleanup_on_state_change(player, changed_values)
1802
1803        # enforce volume limits when volume changes externally
1804        if "volume_level" in changed_values:
1805            self._enforce_volume_limits(player)
1806        # dispatch to internal state update subscribers (with changed_values)
1807        self._dispatch_state_update_subscribers(player, changed_values)
1808
1809        # signal player update on the eventbus
1810        if player.state.type != PlayerType.PROTOCOL:
1811            self.mass.signal_event(EventType.PLAYER_UPDATED, object_id=player_id, data=player)
1812
1813        # signal a separate PlayerOptionsUpdated event
1814        if options := changed_values.get("options"):
1815            self.mass.signal_event(
1816                EventType.PLAYER_OPTIONS_UPDATED, object_id=player_id, data=options
1817            )
1818        # signal player config update event if playerfeatures changed
1819        # this is temporary needed for the Home Assistant integration which only
1820        # re-evalues the entity's supported features on a PLAYER_CONFIG_UPDATED event.
1821        # TODO: Remove this temporary workaround once the HA integration is updated to
1822        # also re-evaluate supported features on PLAYER_UPDATED events.
1823        if changed_values.keys() & {
1824            ATTR_SUPPORTED_FEATURES,
1825            ATTR_MUTE_CONTROL,
1826            ATTR_VOLUME_CONTROL,
1827            ATTR_POWER_CONTROL,
1828        }:
1829            self.mass.signal_event(
1830                EventType.PLAYER_CONFIG_UPDATED, object_id=player_id, data=player.config
1831            )
1832
1833        if not skip_forward or force_update:
1834            self._forward_state_update(player, changed_values)
1835
1836        # trigger update of all players in a provider if group related fields changed
1837        # this ensures that calculated fields like can_group_with are updated on all players
1838        if any(key in changed_values for key in ("group_members", "synced_to", "available")):
1839            for prov_player in player.provider.players:
1840                self.trigger_player_update(prov_player.player_id, debounce_delay=2)
1841
1842    async def register_player_control(self, player_control: PlayerControl) -> None:
1843        """Register a new PlayerControl on the controller."""
1844        if self.mass.closing:
1845            return
1846        control_id = player_control.id
1847
1848        if control_id in self._controls:
1849            msg = f"PlayerControl {control_id} is already registered"
1850            raise AlreadyRegisteredError(msg)
1851
1852        # make sure that the playercontrol's provider is set to the instance_id
1853        prov = self.mass.get_provider(player_control.provider)
1854        if not prov or prov.instance_id != player_control.provider:
1855            raise RuntimeError(f"Invalid provider ID given: {player_control.provider}")
1856
1857        self._controls[control_id] = player_control
1858
1859        self.logger.info(
1860            "PlayerControl registered: %s/%s",
1861            control_id,
1862            player_control.name,
1863        )
1864
1865        # always call update to update any attached players etc.
1866        self.update_player_control(player_control.id, include_configured=True)
1867
1868    async def register_or_update_player_control(self, player_control: PlayerControl) -> None:
1869        """Register a new playercontrol on the controller or update existing one."""
1870        if self.mass.closing:
1871            return
1872        if player_control.id in self._controls:
1873            self._controls[player_control.id] = player_control
1874            self.update_player_control(player_control.id, include_configured=True)
1875            return
1876        await self.register_player_control(player_control)
1877
1878    def update_player_control(self, control_id: str, include_configured: bool = False) -> None:
1879        """
1880        Refresh the players that use the given player control.
1881
1882        :param control_id: The control whose state or availability changed.
1883        :param include_configured: Also refresh the players that select this control in their
1884            config but do not currently resolve to it. Needed when a control (re)appears,
1885            because such a player has already fallen back to another control and would
1886            otherwise never pick this one back up.
1887        """
1888        if self.mass.closing:
1889            return
1890        # update all players that are using this control
1891        for player in list(self._players.values()):
1892            if control_id in (
1893                player.state.power_control,
1894                player.state.volume_control,
1895                player.state.mute_control,
1896            ) or (
1897                include_configured and control_id in self._configured_control_ids(player.player_id)
1898            ):
1899                self.mass.loop.call_soon(player.refresh_state)
1900
1901    def remove_player_control(self, control_id: str) -> None:
1902        """Remove a player_control from the player manager."""
1903        control = self._controls.pop(control_id, None)
1904        if control is None:
1905            return
1906        self.logger.info("PlayerControl removed: %s", control.name)
1907        # players configured to use this control still resolve to it until they are
1908        # refreshed, so let them fall back to their remaining options right away
1909        self.update_player_control(control_id)
1910
1911    def get_player_provider(self, player_id: str) -> PlayerProvider:
1912        """Return PlayerProvider for given player."""
1913        player = self._players[player_id]
1914        assert player  # for type checker
1915        return player.provider
1916
1917    def get_active_queue(self, player: Player) -> PlayerQueue | None:
1918        """Return the current active queue for a player (if any)."""
1919        # account for player that is synced (sync child)
1920        if player.state.synced_to and player.state.synced_to != player.player_id:
1921            if sync_leader := self.get_player(player.state.synced_to):
1922                return self.get_active_queue(sync_leader)
1923        # handle active group player
1924        if player.state.active_group and player.state.active_group != player.player_id:
1925            if group_player := self.get_player(player.state.active_group):
1926                return self.get_active_queue(group_player)
1927        # active_source may be filled queue id (or None)
1928        active_source = player.state.active_source or player.player_id
1929        if active_queue := self.mass.player_queues.get(active_source):
1930            return active_queue
1931        # handle active protocol player with parent player queue
1932        if player.type == PlayerType.PROTOCOL and player.protocol_parent_id:
1933            if parent_player := self.mass.players.get_player(player.protocol_parent_id):
1934                return self.get_active_queue(parent_player)
1935        return None
1936
1937    async def set_group_volume(self, group_player: Player, volume_level: int) -> None:
1938        """
1939        Set the overall volume for a player group or synced players.
1940
1941        Uses interpolation to adjust all child volumes while preserving their
1942        relative balance. A snapshot of child volumes is cached on first call and
1943        used as the reference point for subsequent adjustments.
1944
1945        :param group_player: The group player or sync leader.
1946        :param volume_level: Target volume level (0..100).
1947        """
1948        cur_volume = group_player.state.group_volume
1949        if cur_volume is None:
1950            return
1951
1952        children: list[Player] = []
1953        for child_player in self.iter_group_members(
1954            group_player, only_powered=True, exclude_self=False
1955        ):
1956            if child_player.state.volume_control == PLAYER_CONTROL_NONE:
1957                continue
1958            children.append(child_player)
1959        if not children:
1960            return
1961
1962        # cache a snapshot of child volumes on the group player as reference for interpolation.
1963        # scaling up: each child interpolates from its snapshot value toward 100.
1964        # scaling down: each child interpolates from its snapshot value toward 0.
1965        # this ensures the relative balance is preserved and all children converge
1966        # to 0 and 100 at the extremes. the snapshot is invalidated when a child's
1967        # individual volume changes or group membership changes.
1968        snapshot: dict[str, int] | None = group_player.extra_data.get(ATTR_GROUP_VOLUME_SNAPSHOT)
1969        if snapshot is None or not all(c.player_id in snapshot for c in children):
1970            snapshot = {c.player_id: c.state.volume_level or 0 for c in children}
1971            group_player.extra_data[ATTR_GROUP_VOLUME_SNAPSHOT] = snapshot
1972
1973        base_group = max(snapshot.values())
1974
1975        coros = []
1976        for child_player in children:
1977            child_base = snapshot.get(child_player.player_id, 0)
1978            if volume_level >= base_group:
1979                # scaling up: interpolate each child from snapshot toward 100
1980                if base_group >= 100:
1981                    new_child_volume = child_base
1982                else:
1983                    progress = (volume_level - base_group) / (100 - base_group)
1984                    new_child_volume = round(child_base + (100 - child_base) * progress)
1985            elif base_group == 0:
1986                new_child_volume = 0
1987            else:
1988                # scaling down: interpolate each child from snapshot toward 0
1989                progress = volume_level / base_group
1990                new_child_volume = round(child_base * progress)
1991            new_child_volume = max(0, min(100, new_child_volume))
1992            coros.append(self._handle_cmd_volume_set(child_player.player_id, new_child_volume))
1993        await asyncio.gather(*coros)
1994
1995        # notify active AudioSource once at the group level to prevent
1996        # feedback loops from per-child callbacks with different volume values
1997        if active := self._get_active_audio_source(group_player):
1998            audio_source, plugin_prov = active
1999            active_queue = self.get_active_queue(group_player)
2000            if active_queue is not None and active_queue.queue_id == group_player.player_id:
2001                await plugin_prov.on_volume_change(audio_source.item_id, volume_level)
2002
2003    def iter_group_members(
2004        self,
2005        group_player: Player,
2006        only_powered: bool = False,
2007        only_playing: bool = False,
2008        active_only: bool = False,
2009        exclude_self: bool = True,
2010    ) -> Iterator[Player]:
2011        """Get (child) players attached to a group player or syncgroup."""
2012        for child_id in list(group_player.state.group_members):
2013            if child_player := self.get_player(child_id, False):
2014                if not child_player.state.available or not child_player.state.enabled:
2015                    continue
2016                if only_powered and child_player.state.powered is False:
2017                    continue
2018                if active_only and child_player.state.active_group != group_player.player_id:
2019                    continue
2020                if exclude_self and child_player.player_id == group_player.player_id:
2021                    continue
2022                if only_playing and child_player.state.playback_state not in (
2023                    PlaybackState.PLAYING,
2024                    PlaybackState.PAUSED,
2025                ):
2026                    continue
2027                yield child_player
2028
2029    def subscribe_player_state_update(
2030        self,
2031        callback: Callable[[Player, dict[str, tuple[Any, Any]]], None],
2032    ) -> Callable[[], None]:
2033        """
2034        Subscribe to player state update notifications.
2035
2036        The callback receives the Player and a dict of changed values
2037        (mapping attribute name to a (previous, new) tuple).
2038
2039        :param callback: Function to invoke for each player state update.
2040        :return: An unsubscribe function.
2041        """
2042        self._state_update_subscribers.append(callback)
2043
2044        def _unsub() -> None:
2045            with suppress(ValueError):
2046                self._state_update_subscribers.remove(callback)
2047
2048        return _unsub
2049
2050    @contextlib.asynccontextmanager
2051    async def wait_for_player_update(
2052        self,
2053        player_id: str,
2054        attribute_name: str | None = None,
2055        attribute_value: Any = _SENTINEL,
2056        timeout: float = 5.0,
2057    ) -> AsyncIterator[None]:
2058        """
2059        Async context manager that waits for a player state update.
2060
2061        Subscribes to player state updates on entry, runs the body (typically
2062        the action that triggers the expected update), then waits for a
2063        matching update on exit. If ``attribute_name`` and ``attribute_value``
2064        are both provided and the current value already matches at entry, the
2065        wait is skipped.
2066
2067        Example::
2068
2069            async with mass.players.wait_for_player_update(
2070                player_id, attribute_name="playback_state",
2071                attribute_value=PlaybackState.IDLE, timeout=5,
2072            ):
2073                await mass.players._handle_cmd_stop(player_id)
2074
2075        :param player_id: The player ID to wait for.
2076        :param attribute_name: Optional state attribute to watch for changes
2077            (e.g. ``"playback_state"``). If omitted, any state change satisfies
2078            the wait.
2079        :param attribute_value: Optional value the watched attribute must reach.
2080            Only meaningful in combination with ``attribute_name``.
2081        :param timeout: Maximum time to wait in seconds.
2082        """
2083        update_event = asyncio.Event()
2084
2085        def _on_state_update(player: Player, changed_values: dict[str, tuple[Any, Any]]) -> None:
2086            if player.player_id != player_id:
2087                return
2088            if attribute_name is None:
2089                update_event.set()
2090                return
2091            if attribute_name not in changed_values:
2092                return
2093            if attribute_value is _SENTINEL:
2094                update_event.set()
2095                return
2096            _prev, new_val = changed_values[attribute_name]
2097            if new_val == attribute_value:
2098                update_event.set()
2099
2100        # short-circuit when the desired value is already the current state
2101        already_satisfied = (
2102            attribute_name is not None
2103            and attribute_value is not _SENTINEL
2104            and (player := self.get_player(player_id)) is not None
2105            and getattr(player.state, attribute_name, _SENTINEL) == attribute_value
2106        )
2107
2108        unsub = self.subscribe_player_state_update(_on_state_update)
2109        try:
2110            yield
2111            if already_satisfied:
2112                return
2113            try:
2114                async with asyncio.timeout(timeout):
2115                    await update_event.wait()
2116            except TimeoutError:
2117                self.logger.debug(
2118                    "Timed out waiting for player update on %s (attr=%s value=%s)",
2119                    player_id,
2120                    attribute_name,
2121                    attribute_value,
2122                )
2123        finally:
2124            unsub()
2125
2126    async def on_player_config_change(self, config: PlayerConfig, changed_keys: set[str]) -> None:
2127        """Call (by config manager) when the configuration of a player changes."""
2128        min_vol_changed = f"values/{CONF_MIN_VOLUME}" in changed_keys
2129        max_vol_changed = f"values/{CONF_MAX_VOLUME}" in changed_keys
2130        if min_vol_changed or max_vol_changed:
2131            raw_min = config.get_value(CONF_MIN_VOLUME)
2132            raw_max = config.get_value(CONF_MAX_VOLUME)
2133            min_vol = int(cast("int", raw_min)) if raw_min is not None else 0
2134            max_vol = int(cast("int", raw_max)) if raw_max is not None else 100
2135            if min_vol > max_vol:
2136                msg = "Minimum volume cannot exceed maximum volume"
2137                raise InvalidDataError(msg)
2138        player = self.get_player(config.player_id)
2139        player_provider = self.mass.get_provider(config.provider)
2140        player_disabled = ATTR_ENABLED in changed_keys and not config.enabled
2141        player_enabled = ATTR_ENABLED in changed_keys and config.enabled
2142
2143        if player_disabled and player and player.state.available:
2144            # edge case: ensure that the player is powered off if the player gets disabled
2145            if player.state.power_control != PLAYER_CONTROL_NONE:
2146                await self._handle_cmd_power(config.player_id, False)
2147            elif player.state.playback_state != PlaybackState.IDLE:
2148                await self.cmd_stop(config.player_id)
2149
2150        # signal player provider that the player got enabled/disabled
2151        if (player_enabled or player_disabled) and player_provider:
2152            assert isinstance(player_provider, PlayerProvider)  # for type checking
2153            # Collect linked protocol IDs to cascade the enable/disable to.
2154            # Without this, a disabled native parent leaves its linked protocols
2155            # registered after restart; they then fail to find their parent and
2156            # get wrapped in a fresh Universal Player.
2157            cascade_protocol_ids: list[str] = []
2158            parent_is_protocol = player.state.type == PlayerType.PROTOCOL if player else False
2159            if not parent_is_protocol:
2160                if player and player.linked_output_protocols:
2161                    cascade_protocol_ids = [
2162                        link.output_protocol_id for link in player.linked_output_protocols
2163                    ]
2164                else:
2165                    cascade_protocol_ids = self._get_cached_protocol_ids(config.player_id)
2166            if player_disabled:
2167                player_provider.on_player_disabled(config.player_id)
2168            elif player_enabled:
2169                player_provider.on_player_enabled(config.player_id)
2170            for protocol_id in cascade_protocol_ids:
2171                protocol_raw = self.mass.config.get(f"{CONF_PLAYERS}/{protocol_id}")
2172                if not protocol_raw:
2173                    continue
2174                if bool(protocol_raw.get("enabled", True)) == bool(player_enabled):
2175                    continue
2176                self.mass.create_task(
2177                    self.mass.config.save_player_config(
2178                        protocol_id, {ATTR_ENABLED: bool(player_enabled)}
2179                    )
2180                )
2181            return  # enabling/disabling a player will be handled by the provider
2182
2183        if not player:
2184            return  # guard against player not being registered (yet)
2185
2186        resume_queue: PlayerQueue | None = (
2187            self.mass.player_queues.get(player.state.active_source)
2188            if player.state.active_source
2189            else None
2190        )
2191
2192        # ensure player state gets updated with any updated config
2193        player.set_config(config)
2194        await player.on_config_updated()
2195        player.update_state()
2196        # if the PlayerQueue was playing, restart playback
2197        if resume_queue and resume_queue.state == PlaybackState.PLAYING:
2198            requires_restart = any(
2199                v for v in config.values.values() if v.key in changed_keys and v.requires_reload
2200            )
2201            if requires_restart:
2202                # always stop first to ensure the player uses the new config
2203                await self.mass.player_queues.stop(resume_queue.queue_id)
2204                self.mass.call_later(
2205                    1, self.mass.player_queues.resume, resume_queue.queue_id, False
2206                )
2207
2208    async def on_player_dsp_change(self, player_id: str) -> None:
2209        """Call (by config manager) when the DSP settings of a player change."""
2210        # signal player provider that the config changed
2211        if not (player := self.get_player(player_id)):
2212            return
2213        if player.state.playback_state == PlaybackState.PLAYING:
2214            self.logger.info("Restarting playback of Player %s after DSP change", player_id)
2215            # this will restart the queue stream/playback
2216            if self.get_active_queue(player):
2217                self.mass.call_later(
2218                    0, self.mass.player_queues.resume, player.state.active_source, False
2219                )
2220                return
2221            # if the player is not using a queue, we need to stop and start playback
2222            await self.cmd_stop(player_id)
2223            await self.cmd_play(player_id)
2224
2225    def schedule_active_output_protocol_clear(self, player: Player) -> None:
2226        """
2227        Clear the player's active output protocol once it stops playing.
2228
2229        A device may keep reporting PLAYING for a short while after a stop
2230        command, so the clear is deferred until the player reports IDLE (with a
2231        timeout as fallback). Starting a new session cancels the pending clear
2232        (see Player.set_active_output_protocol).
2233
2234        :param player: The player whose active output protocol must be cleared.
2235        """
2236        # Deduplicated per player via task_id: if a clear is already pending we
2237        # keep it, so the single tracked task stays cancellable by a new session.
2238        self.mass.create_task(
2239            self._clear_active_output_protocol_when_idle(player),
2240            task_id=f"clear_active_protocol_{player.player_id}",
2241        )
2242
2243    def __iter__(self) -> Iterator[Player]:
2244        """Iterate over all players."""
2245        return iter(self._players.values())
2246
2247    async def _release_player_for_play_media(self, player: Player) -> None:
2248        """
2249        Release a captured player so a play_media command can target it directly.
2250
2251        :param player: The captured player to release.
2252        """
2253        # Strategy is picked from how the player is currently captured:
2254        #   synced_to            → unsync this player (cmd_ungroup)
2255        #   dynamic group member → remove from group via cmd_set_members
2256        #   static group member  → dissolve the whole group (power off if it
2257        #                          has a real power control, otherwise stop)
2258        # In every branch we wait for the relevant state attribute to actually
2259        # clear before returning. Providers (Sonos in particular) reject a
2260        # play_media on a player whose synced_to/active_group is still set
2261        # locally even though the release command has been acknowledged.
2262        if player.state.synced_to:
2263            self.logger.debug(
2264                "Unsyncing %s from %s to honor explicit play_media target",
2265                player.state.name,
2266                player.state.synced_to,
2267            )
2268            async with self.wait_for_player_update(
2269                player.player_id,
2270                attribute_name="synced_to",
2271                attribute_value=None,
2272                timeout=5,
2273            ):
2274                await self.cmd_ungroup(player.player_id)
2275            return
2276        if not player.state.active_group:
2277            return
2278        group = self.get_player(player.state.active_group)
2279        if group is None:
2280            return
2281        is_dynamic_member = (
2282            PlayerFeature.SET_MEMBERS in group.state.supported_features
2283            and player.player_id not in group.state.static_group_members
2284        )
2285        if is_dynamic_member:
2286            self.logger.debug(
2287                "Removing %s from dynamic group %s to honor explicit play_media target",
2288                player.state.name,
2289                group.state.name,
2290            )
2291            async with self.wait_for_player_update(
2292                player.player_id,
2293                attribute_name="active_group",
2294                attribute_value=None,
2295                timeout=5,
2296            ):
2297                await self.cmd_set_members(group.player_id, player_ids_to_remove=[player.player_id])
2298            return
2299        # static member: a single member can't be released, so the whole
2300        # group must dissolve. Prefer cmd_power when an explicit power
2301        # control is set so the user-visible state stays consistent.
2302        async with self.wait_for_player_update(
2303            player.player_id,
2304            attribute_name="active_group",
2305            attribute_value=None,
2306            timeout=5,
2307        ):
2308            if group.state.power_control != PLAYER_CONTROL_NONE and group.state.powered:
2309                self.logger.debug(
2310                    "Powering off %s to honor explicit play_media target on %s",
2311                    group.state.name,
2312                    player.state.name,
2313                )
2314                await self._handle_cmd_power(group.player_id, False)
2315            else:
2316                self.logger.debug(
2317                    "Stopping %s to honor explicit play_media target on %s",
2318                    group.state.name,
2319                    player.state.name,
2320                )
2321                await self._handle_cmd_stop(group.player_id)
2322
2323    def _mirrors_parent_media(self, player: Player) -> bool:
2324        """
2325        Return True if the player's current_media is taken from another player.
2326
2327        Grouped/synced members and protocol children mirror their parent's
2328        current_media (palette included), so they must not resolve it themselves.
2329
2330        :param player: The player to check.
2331        """
2332        state = player.state
2333        # a self-referential active_group/synced_to is not a real parent (mirror the
2334        # != self guard in Player.__final_current_media), so it must not skip resolution
2335        parent_id = state.active_group or state.synced_to
2336        if parent_id and parent_id != player.player_id:
2337            return True
2338        return state.type == PlayerType.PROTOCOL and player.protocol_parent_id is not None
2339
2340    def _schedule_palette_fetch(
2341        self, player_id: str, image_url: str | None, *, trigger_update: bool = True
2342    ) -> None:
2343        """
2344        Kick off an async palette extraction for an image URL.
2345
2346        :param player_id: Player the palette is scoped to (used for task dedup).
2347        :param image_url: Image URL to extract from. No-op when empty or already cached.
2348        :param trigger_update: When True, re-emit player state once palette is ready
2349                               (current track). When False, only warm the cache (prefetch).
2350        """
2351        if not image_url:
2352            return
2353        # Key the task on the image (not just the player) so a track change always
2354        # schedules a fetch for the new image instead of being dropped by an in-flight
2355        # fetch for the previous one; repeated schedules for the same image still dedupe.
2356        slot = "current" if trigger_update else "next"
2357        self.mass.create_task(
2358            self._fetch_palette(player_id, image_url, trigger_update=trigger_update),
2359            task_id=f"palette_fetch_{player_id}_{slot}_{image_url}",
2360            abort_existing=False,
2361        )
2362
2363    async def _fetch_palette(self, player_id: str, image_url: str, *, trigger_update: bool) -> None:
2364        palette = await get_palette_for_url(self.mass, image_url)
2365        if palette is None or not trigger_update:
2366            return  # prefetch only warms the cache controller; nothing to attach
2367        player = self.get_player(player_id)
2368        if player is None:
2369            return
2370        current = player.state.current_media
2371        if current is None or current.image_url != image_url:
2372            return  # media changed while fetching
2373        # Carry the palette on player state so the (sync) serialization reads it back.
2374        player.set_resolved_palette(image_url, palette)
2375        # Avoid trigger_player_update so a concurrent state-change debounce
2376        # doesn't cancel our timer via the shared player_update_state task_id.
2377        self.mass.call_later(
2378            0,
2379            player.update_state,
2380            force_update=True,
2381            task_id=f"palette_player_update_{player_id}",
2382        )
2383
2384    def _schedule_next_queue_item_palette_prefetch(
2385        self, player_id: str, current_media: PlayerMedia
2386    ) -> None:
2387        """Warm the palette cache for the next queue item so it's hot at transition."""
2388        queue_id, item_id = current_media.source_id, current_media.queue_item_id
2389        if not queue_id or not item_id:
2390            return
2391        next_item = self.mass.player_queues.get_next_item(queue_id, item_id)
2392        if next_item is None or not next_item.image:
2393            return
2394        next_url = self.mass.metadata.get_image_url(
2395            next_item.image, size=512, prefer_stream_server=True
2396        )
2397        self._schedule_palette_fetch(player_id, next_url, trigger_update=False)
2398
2399    def _configured_control_ids(self, player_id: str) -> set[str]:
2400        """Return the player control ids the given player's config selects."""
2401        return {
2402            str(value)
2403            for conf_key in (CONF_POWER_CONTROL, CONF_VOLUME_CONTROL, CONF_MUTE_CONTROL)
2404            if (value := self.mass.config.get_raw_player_config_value(player_id, conf_key))
2405        }
2406
2407    def _get_volume_limits(self, player_id: str) -> tuple[int, int]:
2408        """Get the configured min/max volume limits for a player."""
2409        min_volume = int(
2410            cast(
2411                "int",
2412                self.mass.config.get_raw_player_config_value(
2413                    player_id, CONF_MIN_VOLUME, CONF_ENTRY_MIN_VOLUME.default_value
2414                ),
2415            )
2416        )
2417        max_volume = int(
2418            cast(
2419                "int",
2420                self.mass.config.get_raw_player_config_value(
2421                    player_id, CONF_MAX_VOLUME, CONF_ENTRY_MAX_VOLUME.default_value
2422                ),
2423            )
2424        )
2425        return min_volume, max_volume
2426
2427    def _enforce_volume_limits(self, player: Player) -> None:
2428        """Clamp device volume to min/max range when changed externally."""
2429        player_id = player.player_id
2430        min_volume, max_volume = self._get_volume_limits(player_id)
2431        if min_volume == 0 and max_volume == 100:
2432            return
2433        # state.volume_level is the resolved logical volume, available for all
2434        # volume control types; a device volume outside the configured range
2435        # surfaces here as a value outside 0-100 (scaling does not clamp)
2436        logical_volume = player.state.volume_level
2437        if logical_volume is None or 0 <= logical_volume <= 100:
2438            return
2439        clamped = max(0, min(100, logical_volume))
2440        # correct via the regular volume-set path so scaling and redirection apply
2441        self.mass.create_task(self._handle_cmd_volume_set(player_id, clamped))
2442
2443    def _forward_state_update(
2444        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2445    ) -> None:
2446        """Forward a player state update to related players (groups, sync parent, protocols)."""
2447        # TODO: make this fan-out change-aware (skip relatives that derive nothing from
2448        # the changed fields) once reverse indexes for synced_to/active_group exist.
2449        # Propagate group or sync-leader updates to child players.
2450        if player.state.group_members:
2451            for child_player in self.iter_group_members(player, exclude_self=True):
2452                if player.type == PlayerType.GROUP:
2453                    child_player.on_group_updated(player, changed_values)
2454                else:
2455                    child_player.on_sync_parent_updated(player, changed_values)
2456        # update/signal group player(s) when a member updates. A sync leader is a member of the
2457        # group player that formed the sync group and gaining members of its own does not change
2458        # that: a group player mirrors its leader, so it depends on exactly these updates.
2459        for group_player in self._get_player_groups(player):
2460            group_player.on_group_member_updated(player, changed_values)
2461
2462        # update/signal manually sync-parent player when child updates
2463        if (_sync_parent_id := player.state.synced_to) and (
2464            _sync_parent := self.get_player(_sync_parent_id)
2465        ):
2466            self.trigger_player_update(_sync_parent.player_id)
2467        # If this is a protocol player, forward the state update to the parent player
2468        if (
2469            player.type == PlayerType.PROTOCOL
2470            and player.protocol_parent_id
2471            and (_protocol_parent := self.mass.players.get_player(player.protocol_parent_id))
2472        ):
2473            _protocol_parent.on_protocol_player_updated(player, changed_values)
2474        # If this is a parent player with linked protocols, forward state updates
2475        # to linked protocol players so their state reflects parent dependencies
2476        if player.state.type != PlayerType.PROTOCOL and player.linked_output_protocols:
2477            for linked in player.linked_output_protocols:
2478                if protocol_player := self.mass.players.get_player(linked.output_protocol_id):
2479                    protocol_player.on_protocol_parent_updated(player, changed_values)
2480
2481    def _invalidate_group_volume_snapshot(self, player_id: str) -> None:
2482        """Clear the cached group volume snapshot for all groups this player belongs to."""
2483        player = self.get_player(player_id)
2484        if not player:
2485            return
2486        if player.state.group_members:
2487            player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2488        for group_player in self._get_player_groups(player):
2489            group_player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2490        if player.state.synced_to and (leader := self.get_player(player.state.synced_to)):
2491            leader.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2492
2493    def _dispatch_state_update_subscribers(
2494        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2495    ) -> None:
2496        """Notify all internal subscribers of a player state update."""
2497        for subscriber in list(self._state_update_subscribers):
2498            try:
2499                subscriber(player, changed_values)
2500            except Exception:
2501                self.logger.exception(
2502                    "Error in player state update subscriber for %s", player.player_id
2503                )
2504
2505    async def _wait_for_playback_state(
2506        self,
2507        player: Player,
2508        wanted_state: PlaybackState,
2509        timeout: float,
2510        minimal_time: float = 0,
2511    ) -> None:
2512        """Wait for a player to reach a playback state, with optional minimum wait time."""
2513        start_timestamp = time.time()
2514        async with self.wait_for_player_update(
2515            player.player_id,
2516            attribute_name="playback_state",
2517            attribute_value=wanted_state,
2518            timeout=timeout,
2519        ):
2520            pass
2521        elapsed = time.time() - start_timestamp
2522        if elapsed < minimal_time:
2523            await asyncio.sleep(minimal_time - elapsed)
2524
2525    async def _clear_active_output_protocol_when_idle(self, player: Player) -> None:
2526        """Wait for the player to stop playing, then clear its active output protocol."""
2527        await self._wait_for_playback_state(player, PlaybackState.IDLE, timeout=10)
2528        player.set_active_output_protocol(None)
2529
2530    def _handle_membership_cleanup_on_state_change(
2531        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2532    ) -> None:
2533        """Detach a player from its (sync)groups when a state change requires it."""
2534        # A player that became unavailable or disabled can no longer be commanded,
2535        # so we drop it from its parent group/leader directly.
2536        became_inactive = (
2537            ATTR_AVAILABLE in changed_values and changed_values[ATTR_AVAILABLE][1] is False
2538        ) or (ATTR_ENABLED in changed_values and changed_values[ATTR_ENABLED][1] is False)
2539        if became_inactive and (player.state.active_group or player.state.synced_to):
2540            self.mass.create_task(self._cleanup_player_memberships(player.player_id))
2541
2542        # A player whose power was turned off outside of an MA power command (e.g. its
2543        # linked power control was switched off directly) must be unsynced too. We act
2544        # only on an explicit on->off transition, leaving players without power control
2545        # (powered == None) untouched. The player is still reachable here, so we route
2546        # through cmd_ungroup which also transfers leadership when it is a sync leader.
2547        if (
2548            changed_values.get(ATTR_POWERED) == (True, False)
2549            and player.state.type == PlayerType.PLAYER
2550            and (player.state.synced_to or player.state.active_group or player.state.group_members)
2551        ):
2552            self.mass.create_task(self.cmd_ungroup(player.player_id))
2553
2554    async def _cleanup_player_memberships(self, player_id: str) -> None:
2555        """Ensure a player is detached from any groups or syncgroups."""
2556        if not (player := self.get_player(player_id)):
2557            return
2558        with suppress(UnsupportedFeaturedException, PlayerCommandFailed, PlayerUnavailableError):
2559            if parent_id := (player.state.active_group or player.state.synced_to):
2560                # the player is part of a (permanent) groupplayer and the user tries to ungroup
2561                if parent_player := self.get_player(parent_id):
2562                    await self._handle_set_members(parent_player, player_ids_to_remove=[player_id])
2563                return
2564
2565    def _get_player_with_redirect(self, player_id: str) -> Player:
2566        """Get player with check if playback related command should be redirected."""
2567        player = self.get_player(player_id, True)
2568        assert player is not None  # for type checking
2569        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
2570            self.logger.info(
2571                "Player %s is synced to %s and can not accept "
2572                "playback related commands itself, "
2573                "redirected the command to the sync leader.",
2574                player.name,
2575                sync_leader.name,
2576            )
2577            return sync_leader
2578        if player.state.active_group and (
2579            active_group := self.get_player(player.state.active_group)
2580        ):
2581            self.logger.info(
2582                "Player %s is part of a playergroup and can not accept "
2583                "playback related commands itself, "
2584                "redirected the command to the group leader.",
2585                player.name,
2586            )
2587            return active_group
2588        return player
2589
2590    def _get_active_audio_source(self, player: Player) -> tuple[AudioSource, PluginProvider] | None:
2591        """
2592        Return the active AudioSource and its owning PluginProvider for a player.
2593
2594        Returns None when the player's active queue item is not a MediaType.AUDIO_SOURCE
2595        or when the owning plugin provider is no longer available.
2596
2597        :param player: The player whose active queue to inspect.
2598        """
2599        active_queue = self.get_active_queue(player)
2600        if active_queue is None:
2601            return None
2602        current_item = active_queue.current_item
2603        if current_item is None or current_item.media_item is None:
2604            return None
2605        media_item = current_item.media_item
2606        # isinstance check defends against a non-AudioSource subclass that
2607        # somehow has media_type=AUDIO_SOURCE set (mutated or constructed wrong)
2608        # — the media_type guard alone would let it through and crash later.
2609        if not isinstance(media_item, AudioSource):
2610            return None
2611        provider = self.mass.get_provider(media_item.provider)
2612        if not isinstance(provider, PluginProvider):
2613            return None
2614        # Belt-and-suspenders: a queue item carrying media_type=AUDIO_SOURCE
2615        # can only have come from a provider that declared the feature, but
2616        # a feature flag flipped off at runtime (provider reload, config
2617        # change) would leave on_source_control / on_volume_change raising
2618        # NotImplementedError out of cmd_play / cmd_pause. Skip cleanly.
2619        if ProviderFeature.AUDIO_SOURCE not in provider.supported_features:
2620            return None
2621        return media_item, provider
2622
2623    def _get_player_groups(self, player: Player) -> Iterator[Player]:
2624        """
2625        Return all group players the given player is a member of.
2626
2627        :param player: The player to look up the group memberships for.
2628        """
2629        # A group player mirrors its members, so it is also included while unavailable -
2630        # skipping it there is exactly how its state goes stale.
2631        player_id = player.player_id
2632        for _player in self.iter_players():
2633            if _player.player_id == player_id:
2634                continue
2635            if _player.state.type != PlayerType.GROUP:
2636                continue
2637            if player_id in _player.state.group_members:
2638                yield _player
2639
2640    # Protocol linking methods are provided by ProtocolLinkingMixin (protocol_linking.py)
2641
2642    def _repair_protocol_parent_links(self) -> None:
2643        """
2644        Repair protocol parent links in player configs on startup.
2645
2646        Scans player configs with a protocol_parent_id set and clears parent_ids
2647        that point to player configs that no longer exist (e.g., deleted universal
2648        players). A valid parent link also proves the player is a protocol child,
2649        so a stale player_type (left behind by an aborted registration) is healed.
2650        """
2651        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
2652        for player_id, player_config in all_player_configs.items():
2653            values = player_config.get("values") or {}
2654            parent_id = values.get(CONF_PROTOCOL_PARENT_ID)
2655            if not parent_id:
2656                continue
2657            # Check if parent config still exists
2658            parent_config = all_player_configs.get(parent_id)
2659            if not parent_config:
2660                self.logger.debug(
2661                    "Clearing stale protocol_parent_id %s for %s (parent config deleted)",
2662                    parent_id,
2663                    player_id,
2664                )
2665                conf_key = f"{CONF_PLAYERS}/{player_id}/values/{CONF_PROTOCOL_PARENT_ID}"
2666                self.mass.config.set(conf_key, None)
2667                continue
2668            if player_config.get("player_type") != PlayerType.PROTOCOL.value:
2669                self.logger.info(
2670                    "Repairing player type of %s - linked as protocol child of %s",
2671                    player_id,
2672                    parent_id,
2673                )
2674                self.mass.config.set_player_type(player_id, PlayerType.PROTOCOL)
2675
2676    async def _fix_group_member_configs(self) -> None:
2677        """
2678        Fix stale protocol player IDs in sync group member configs.
2679
2680        When a sync group references a protocol player ID instead of
2681        the parent player ID, correct it using the cached protocol parent mapping.
2682        """
2683        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
2684        total_fixes = 0
2685        fixed_groups: list[str] = []
2686
2687        for group_id, group_config in list(all_player_configs.items()):
2688            if group_config.get("provider") != "sync_group":
2689                continue
2690            old_members: list[str] = group_config.get("values", {}).get(CONF_GROUP_MEMBERS, [])
2691            if not old_members:
2692                continue
2693
2694            new_members: list[str] = []
2695            changes = 0
2696            for member_id in old_members:
2697                parent_id = self._get_cached_protocol_parent_id(member_id)
2698                corrected_id = parent_id or member_id
2699                if corrected_id != member_id:
2700                    changes += 1
2701                    self.logger.debug(
2702                        "Sync group %s: corrected member %s -> %s",
2703                        group_id,
2704                        member_id,
2705                        corrected_id,
2706                    )
2707                if corrected_id not in new_members:
2708                    new_members.append(corrected_id)
2709
2710            if changes:
2711                self.mass.config.set_raw_player_config_value(
2712                    group_id, CONF_GROUP_MEMBERS, new_members
2713                )
2714                total_fixes += changes
2715                fixed_groups.append(group_id)
2716
2717        for group_id in fixed_groups:
2718            if (group_player := self.get_player(group_id)) and group_player.available:
2719                await group_player.on_config_updated()
2720
2721        if total_fixes:
2722            self.logger.info(
2723                "Fixed %d stale member reference(s) across %d sync group(s)",
2724                total_fixes,
2725                len(fixed_groups),
2726            )
2727
2728    async def _poll_players(self) -> None:
2729        """Background task that polls players for updates."""
2730        while True:
2731            for player in list(self._players.values()):
2732                # if the player is playing, update elapsed time every tick
2733                # to ensure the queue has accurate details
2734                player_playing = player.state.playback_state == PlaybackState.PLAYING
2735                if player_playing and player.type != PlayerType.PROTOCOL:
2736                    self.mass.call_later(
2737                        0.5,
2738                        self.mass.player_queues.on_player_update,
2739                        player,
2740                        {"corrected_elapsed_time": (None, player.state.corrected_elapsed_time)},
2741                        task_id=f"queue_on_player_update_{player.player_id}",
2742                    )
2743                # Poll player;
2744                if not player.needs_poll:
2745                    continue
2746                try:
2747                    last_poll: float = player.extra_data[ATTR_LAST_POLL]
2748                except KeyError:
2749                    last_poll = 0.0
2750                if (self.mass.loop.time() - last_poll) < player.poll_interval:
2751                    continue
2752                player.extra_data[ATTR_LAST_POLL] = self.mass.loop.time()
2753                try:
2754                    await player.poll()
2755                except Exception as err:
2756                    self.logger.warning(
2757                        "Error while requesting latest state from player %s: %s",
2758                        player.state.name,
2759                        str(err),
2760                        exc_info=err if self.logger.isEnabledFor(10) else None,
2761                    )
2762                # Yield to event loop to prevent blocking
2763                await asyncio.sleep(0)
2764            await asyncio.sleep(1)
2765
2766    def _handle_group_dsp_change(
2767        self, player: Player, prev_group_members: list[str], new_group_members: list[str]
2768    ) -> None:
2769        """Handle DSP reload when group membership changes."""
2770        # reset cached group volume snapshot since membership changed
2771        player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2772        prev_child_count = len(prev_group_members)
2773        new_child_count = len(new_group_members)
2774        is_player_group = player.state.type == PlayerType.GROUP
2775
2776        # handle special case for PlayerGroups: since there are no leaders,
2777        # DSP still always work with a single player in the group.
2778        multi_device_dsp_threshold = 1 if is_player_group else 0
2779
2780        prev_is_multiple_devices = prev_child_count > multi_device_dsp_threshold
2781        new_is_multiple_devices = new_child_count > multi_device_dsp_threshold
2782
2783        if prev_is_multiple_devices == new_is_multiple_devices:
2784            return  # no change in multi-device status
2785
2786        supports_multi_device_dsp = (
2787            PlayerFeature.MULTI_DEVICE_DSP in player.state.supported_features
2788        )
2789
2790        dsp_enabled: bool
2791        if player.state.type == PlayerType.GROUP:
2792            # Since player groups do not have leaders, we will use the only child
2793            # that was in the group before and after the change
2794            if prev_is_multiple_devices:
2795                if childs := new_group_members:
2796                    # We shrank the group from multiple players to a single player
2797                    # So the now only child will control the DSP
2798                    dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2799                else:
2800                    dsp_enabled = False
2801            elif childs := prev_group_members:
2802                # We grew the group from a single player to multiple players,
2803                # let's see if the previous single player had DSP enabled
2804                dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2805            else:
2806                dsp_enabled = False
2807        else:
2808            dsp_enabled = self.mass.config.get_player_dsp_config(player.player_id).enabled
2809
2810        if dsp_enabled and not supports_multi_device_dsp:
2811            # We now know that the group configuration has changed so:
2812            # - multi-device DSP is not supported
2813            # - we switched from a group with multiple players to a single player
2814            #   (or vice versa)
2815            # - the leader has DSP enabled
2816            self.mass.create_task(self.mass.players.on_player_dsp_change(player.player_id))
2817
2818    def _check_external_source_takeover(self, player: Player) -> None:
2819        """
2820        Handle when an external source takes over playback on a player.
2821
2822        When a player has an active grouped output protocol (e.g., AirPlay group) and
2823        an external source (e.g., Spotify Connect, TV input) takes over playback,
2824        we need to clear the active output protocol and ungroup the protocol players.
2825
2826        This prevents the situation where the player appears grouped via protocol
2827        but is actually playing from a different source.
2828
2829        :param player: The player whose active_source changed.
2830        """
2831        # Only relevant for non-protocol players
2832        if player.type == PlayerType.PROTOCOL:
2833            return
2834
2835        # Not a takeover if the player is not actively playing
2836        if player.playback_state != PlaybackState.PLAYING:
2837            return
2838
2839        # Only relevant if we have an active output protocol (not native)
2840        if not player.active_output_protocol or player.active_output_protocol == "native":
2841            return
2842
2843        new_source = player.state.active_source
2844
2845        # Check if new source is external (not MA-managed)
2846        if self._is_ma_managed_source(player, new_source):
2847            return
2848
2849        # Get the active protocol player
2850        protocol_player = self.get_player(player.active_output_protocol)
2851        if not protocol_player:
2852            return
2853
2854        # If the source matches the active protocol's domain, it's expected - not a takeover
2855        # e.g., source "airplay" when using AirPlay protocol is normal
2856        if new_source and new_source.lower() == protocol_player.provider.domain.lower():
2857            return
2858
2859        if (
2860            new_source
2861            and new_source.lower() in ("airplay", "cast", "chromecast", "network")
2862            and protocol_player.provider.domain.lower() == "sendspin"
2863        ):
2864            # Special case for Sendspin bridge: if the new source matches cast or airplay and the
2865            # active protocol is Sendspin, we consider this a normal behavior and not a takeover
2866            return
2867
2868        # Confirmed external source takeover
2869        self.logger.info(
2870            "External source '%s' took over on %s while playing via protocol %s - "
2871            "clearing active output protocol and ungrouping",
2872            new_source,
2873            player.display_name,
2874            protocol_player.provider.domain,
2875        )
2876
2877        # Set active output protocol to native
2878        player.set_active_output_protocol("native")
2879
2880        # Ungroup the protocol player (async task)
2881        self.mass.create_task(protocol_player.ungroup())
2882
2883    def _is_ma_managed_source(self, player: Player, source: str | None) -> bool:
2884        """
2885        Check if a source is managed by Music Assistant.
2886
2887        MA-managed sources include:
2888        - None (=autodetect, no source explicitly set by player)
2889        - The player's own ID (MA queue)
2890        - Any active queue ID
2891        - Any plugin source ID
2892
2893        :param player: The player to check.
2894        :param source: The source ID to check.
2895        :return: True if the source is MA-managed, False if external.
2896        """
2897        if source is None:
2898            return True
2899
2900        # Player's own ID means MA queue is active
2901        if source == player.player_id:
2902            return True
2903
2904        # Check if it's a known queue ID
2905        return self.mass.player_queues.get(source) is not None
2906
2907    def _schedule_update_all_players(self, delay: float = 2.0) -> None:
2908        """
2909        Schedule a debounced update of all players' state.
2910
2911        Used when a new player is registered to ensure all existing players
2912        update their dynamic properties (like can_group_with) that may have changed.
2913
2914        :param delay: Delay in seconds before triggering updates (default 2.0).
2915        """
2916        if self.mass.closing:
2917            return
2918
2919        for player in self.all_players(
2920            return_unavailable=True,
2921            return_disabled=False,
2922            return_protocol_players=True,
2923        ):
2924            self.trigger_player_update(player.player_id, debounce_delay=delay)
2925
2926    async def _auto_ungroup_if_synced(self, player: Player, log_context: str) -> None:
2927        """
2928        Automatically ungroup a player if it's synced to another player.
2929
2930        :param player: The player to check and potentially ungroup.
2931        :param log_context: Additional context for the log message (e.g., target player name).
2932        """
2933        if not player.state.synced_to and not player.state.active_group:
2934            return
2935        self.logger.info(
2936            "Player %s is already synced to %s, ungrouping it first before %s",
2937            player.name,
2938            player.state.synced_to or player.state.active_group,
2939            log_context,
2940        )
2941        # Use internal _handle_set_members to avoid deadlocking on the play lock
2942        # (we're already inside a cmd_set_members chain that holds a play lock).
2943        synced_to = player.state.synced_to or player.state.active_group
2944        if synced_to and (parent := self.get_player(synced_to)):
2945            try:
2946                async with self.wait_for_player_update(player.player_id, timeout=5):
2947                    await self._handle_set_members(parent, player_ids_to_remove=[player.player_id])
2948            except asyncio.CancelledError:
2949                raise
2950            except Exception:
2951                self.logger.warning(
2952                    "Failed to auto-ungroup %s from %s, proceeding anyway",
2953                    player.name,
2954                    synced_to,
2955                )
2956
2957    async def _handle_set_members(
2958        self,
2959        parent_player: Player,
2960        player_ids_to_add: list[str] | None = None,
2961        player_ids_to_remove: list[str] | None = None,
2962    ) -> None:
2963        """
2964        Handle the actual set_members logic.
2965
2966        Skips permission checks and locking (internal use only).
2967
2968        :param parent_player: The parent player to add/remove members to/from.
2969        :param player_ids_to_add: List of player_id's to add to the parent player.
2970        :param player_ids_to_remove: List of player_id's to remove from the parent player.
2971        """
2972        target_player = parent_player.player_id
2973        # handle the sync leader being removed from itself: either transfer leadership
2974        # to a remaining member (keeping playback alive) or dissolve the group entirely
2975        should_stop = False
2976        if player_ids_to_remove and target_player in player_ids_to_remove:
2977            remaining_members = [
2978                m
2979                for m in parent_player.state.group_members
2980                if m != target_player
2981                and m not in player_ids_to_remove
2982                and (member := self.get_player(m))
2983                and member.state.available
2984            ]
2985            active_queue = self.get_active_queue(parent_player)
2986            if remaining_members and active_queue and active_queue.state != PlaybackState.IDLE:
2987                # transfer leadership to a remaining member instead of dissolving
2988                await self._transfer_ad_hoc_leadership(parent_player, remaining_members)
2989                return
2990            self.logger.info(
2991                "Dissolving sync group of player %s as it is being removed from itself",
2992                parent_player.name,
2993            )
2994            player_ids_to_add = None
2995            player_ids_to_remove = [
2996                x for x in parent_player.state.group_members if x != target_player
2997            ]
2998            should_stop = True
2999        # filter all player ids on compatibility and availability
3000        final_player_ids_to_add: list[str] = []
3001        for child_player_id in player_ids_to_add or []:
3002            if child_player_id == target_player:
3003                continue
3004            if child_player_id in final_player_ids_to_add:
3005                continue
3006            if (
3007                not (child_player := self.get_player(child_player_id))
3008                or not child_player.state.available
3009            ):
3010                self.logger.warning("Player %s is not available", child_player_id)
3011                continue
3012
3013            # check if player can be synced/grouped with the target player
3014            # state.can_group_with already handles all expansion and translation
3015            if child_player_id not in parent_player.state.can_group_with:
3016                self.logger.warning(
3017                    "Player %s can not be grouped with %s",
3018                    child_player.name,
3019                    parent_player.name,
3020                )
3021                continue
3022
3023            if (
3024                child_player.state.synced_to
3025                and child_player.state.synced_to == target_player
3026                and child_player_id in parent_player.state.group_members
3027            ):
3028                continue  # already synced to this target
3029
3030            # also skip if the child is part of this group via its sync leader
3031            # (e.g. synced to the sync leader of this syncgroup)
3032            if (
3033                child_player.state.active_group == target_player
3034                and child_player_id in parent_player.state.group_members
3035            ):
3036                continue
3037
3038            # handle edge case: child player is synced to a different player
3039            # automatically ungroup it first and wait for state to propagate
3040            # but not if the child is already part of this group (via its sync leader)
3041            if child_player.state.synced_to and target_player not in {
3042                child_player.state.synced_to,
3043                child_player.state.active_group,
3044            }:
3045                await self._auto_ungroup_if_synced(child_player, f"joining {parent_player.name}")
3046
3047            # power on the player if needed
3048            if (
3049                not child_player.state.powered
3050                and child_player.state.power_control != PLAYER_CONTROL_NONE
3051            ):
3052                await self._handle_cmd_power(child_player.player_id, True)
3053            # if we reach here, all checks passed
3054            final_player_ids_to_add.append(child_player_id)
3055
3056        # process player ids to remove and filter out invalid/unavailable players and edge cases
3057        final_player_ids_to_remove: list[str] = []
3058        if player_ids_to_remove:
3059            for child_player_id in player_ids_to_remove:
3060                if child_player_id in parent_player.state.group_members:
3061                    final_player_ids_to_remove.append(child_player_id)
3062                    continue
3063                # also accept the removal if the child player itself reports
3064                # being synced to this parent - handles race conditions where the
3065                # parent's group_members state is stale/not yet updated
3066                child_player = self.get_player(child_player_id)
3067                if child_player and child_player.state.synced_to == target_player:
3068                    final_player_ids_to_remove.append(child_player_id)
3069                    continue
3070
3071        # Forward command to the appropriate player after all (base) sanity checks
3072        # GROUP players (sync_group, universal_group) manage their own members internally
3073        # and don't need protocol translation - call their set_members directly
3074        if (
3075            parent_player.type == PlayerType.GROUP
3076            and PlayerFeature.SET_MEMBERS in parent_player.state.supported_features
3077        ):
3078            await parent_player.set_members(
3079                player_ids_to_add=final_player_ids_to_add,
3080                player_ids_to_remove=final_player_ids_to_remove,
3081            )
3082            return
3083        # For regular players, handle protocol selection and translation
3084        await self._handle_set_members_with_protocols(
3085            parent_player, final_player_ids_to_add, final_player_ids_to_remove
3086        )
3087
3088        if should_stop:
3089            # Stop playback on the player if it is being removed from itself
3090            await self._handle_cmd_stop(parent_player.player_id)
3091
3092    async def _handle_set_members_with_protocols(
3093        self,
3094        parent_player: Player,
3095        player_ids_to_add: list[str],
3096        player_ids_to_remove: list[str],
3097    ) -> None:
3098        """
3099        Handle set_members considering protocol and native members.
3100
3101        Skips permission checks, locking, and all redirect logic (internal use only).
3102        Translates visible player IDs to protocol player IDs when appropriate,
3103        and forwards to the correct player's set_members.
3104
3105        :param parent_player: The parent player to add/remove members to/from.
3106        :param player_ids_to_add: List of visible player IDs to add as members.
3107        :param player_ids_to_remove: List of visible player IDs to remove from members.
3108        """
3109        # Get parent's active protocol domain and player if available
3110        parent_protocol_domain = None
3111        parent_protocol_player = None
3112        if (
3113            parent_player.active_output_protocol
3114            and parent_player.active_output_protocol != "native"
3115        ):
3116            parent_protocol_player = self.get_player(parent_player.active_output_protocol)
3117            if parent_protocol_player:
3118                parent_protocol_domain = parent_protocol_player.provider.domain
3119
3120        self.logger.debug(
3121            "set_members on %s: active_protocol=%s, adding=%s, removing=%s",
3122            parent_player.state.name,
3123            parent_protocol_domain or "none",
3124            player_ids_to_add,
3125            player_ids_to_remove,
3126        )
3127
3128        # Translate members to add
3129        (
3130            protocol_members_to_add,
3131            native_members_to_add,
3132            parent_protocol_player,
3133            parent_protocol_domain,
3134        ) = self._translate_members_for_protocols(
3135            parent_player, player_ids_to_add, parent_protocol_player, parent_protocol_domain
3136        )
3137
3138        self.logger.debug(
3139            "Translated members: protocol=%s (domain=%s), native=%s",
3140            protocol_members_to_add,
3141            parent_protocol_domain,
3142            native_members_to_add,
3143        )
3144
3145        # Translate members to remove
3146        protocol_members_to_remove, native_members_to_remove = (
3147            self._translate_members_to_remove_for_protocols(
3148                parent_player, player_ids_to_remove, parent_protocol_player, parent_protocol_domain
3149            )
3150        )
3151
3152        # Forward protocol members to protocol player's set_members
3153        if (protocol_members_to_add or protocol_members_to_remove) and parent_protocol_player:
3154            await self._forward_protocol_set_members(
3155                parent_player,
3156                parent_protocol_player,
3157                protocol_members_to_add,
3158                protocol_members_to_remove,
3159            )
3160
3161        # Forward native members to parent player's set_members
3162        if native_members_to_add or native_members_to_remove:
3163            filtered_native_add = self._filter_native_members(native_members_to_add, parent_player)
3164            # For removal, allow protocol players if they're actually in the parent's group_members
3165            # This handles native protocol players (e.g., native AirPlay) where group_members
3166            # contains protocol player IDs
3167            filtered_native_remove = [
3168                pid
3169                for pid in native_members_to_remove
3170                if (p := self.get_player(pid))
3171                and (p.type != PlayerType.PROTOCOL or pid in parent_player.group_members)
3172            ]
3173            self.logger.debug(
3174                "Native grouping on %s: filtered_add=%s, filtered_remove=%s",
3175                parent_player.state.name,
3176                filtered_native_add,
3177                filtered_native_remove,
3178            )
3179            if filtered_native_add or filtered_native_remove:
3180                if PlayerFeature.SET_MEMBERS not in parent_player.state.supported_features:
3181                    return
3182                self.logger.info(
3183                    "Calling set_members on native player %s with add=%s, remove=%s",
3184                    parent_player.state.name,
3185                    filtered_native_add,
3186                    filtered_native_remove,
3187                )
3188                await parent_player.set_members(
3189                    player_ids_to_add=filtered_native_add or None,
3190                    player_ids_to_remove=filtered_native_remove or None,
3191                )
3192
3193    async def _transfer_ad_hoc_leadership(
3194        self, leader: Player, remaining_members: list[str]
3195    ) -> None:
3196        """
3197        Transfer leadership of an ad-hoc sync group to a remaining member.
3198
3199        Called when the sync leader of an ad-hoc group is unjoined while other
3200        members remain and playback is active. The queue is moved to a newly
3201        selected leader, the remaining members are regrouped under it and playback
3202        resumes at the saved position (accepting a brief audio gap).
3203
3204        :param leader: The current sync leader being removed from the group.
3205        :param remaining_members: Available group members (excluding the leader)
3206            that should keep playing under a new leader.
3207        """
3208        active_queue = self.get_active_queue(leader)
3209        was_playing = active_queue is not None and active_queue.state == PlaybackState.PLAYING
3210        new_leader_id = self._select_ad_hoc_leader(leader, remaining_members)
3211        self.logger.info(
3212            "Transferring leadership of %s to %s (%s remaining member(s))",
3213            leader.name,
3214            new_leader_id,
3215            len(remaining_members),
3216        )
3217        # Move the queue to the new leader. transfer_queue frees the new leader from
3218        # the old leader's group and stops the old leader; the playback position
3219        # survives because stop() stores it in resume_pos.
3220        await self.mass.player_queues.transfer_queue(
3221            leader.player_id, new_leader_id, auto_play=False
3222        )
3223        # regroup the other remaining members under the new leader
3224        other_members = [m for m in remaining_members if m != new_leader_id]
3225        if other_members:
3226            await self.cmd_set_members(new_leader_id, player_ids_to_add=other_members)
3227        if was_playing:
3228            await self.mass.player_queues.resume(new_leader_id)
3229
3230    def _select_ad_hoc_leader(self, leader: Player, remaining_members: list[str]) -> str:
3231        """
3232        Pick the new leader for an ad-hoc sync group leadership transfer.
3233
3234        Prefers a remaining member that supports the protocol the group is currently
3235        playing on, so the other members can be regrouped under it; falls back to the
3236        first remaining member. The members' own ``can_group_with`` is unusable here
3237        because it is empty while they are still synced to the old leader.
3238
3239        :param leader: The current sync leader being removed.
3240        :param remaining_members: Candidate member player_ids, already filtered for
3241            availability. Must not be empty.
3242        """
3243        active_domain: str | None = None
3244        if leader.active_output_protocol and leader.active_output_protocol != "native":
3245            if protocol_player := self.get_player(leader.active_output_protocol):
3246                active_domain = protocol_player.provider.domain
3247        if active_domain:
3248            for member_id in remaining_members:
3249                member = self.get_player(member_id)
3250                if member is None:
3251                    continue
3252                if member.provider.domain == active_domain or any(
3253                    protocol.protocol_domain == active_domain and protocol.available
3254                    for protocol in member.linked_output_protocols
3255                ):
3256                    return member_id
3257        return remaining_members[0]
3258
3259    def _clear_sleep_timer(self, player: Player) -> None:
3260        """
3261        Clear the active sleep timer for the player.
3262
3263        :param player: Player to clear the timer for.
3264        """
3265        self.mass.cancel_timer(self._sleep_timer_task_id(player.player_id))
3266        if player.sleep_timer_expires_at is not None:
3267            player.set_sleep_timer_expires_at(None)
3268            player.update_state()
3269            self._signal_sleep_timer_updated(player, None)
3270
3271    async def _handle_sleep_timer_expired(self, player_id: str) -> None:
3272        """
3273        Stop playback when a player's sleep timer expires.
3274
3275        :param player_id: Player ID whose sleep timer expired.
3276        """
3277        player = self.get_player(player_id)
3278        if player is None or player.sleep_timer_expires_at is None:
3279            return
3280        player.set_sleep_timer_expires_at(None)
3281        player.update_state()
3282        self._signal_sleep_timer_updated(player, None)
3283        await self.cmd_stop(player_id)
3284
3285    def _signal_sleep_timer_updated(self, player: Player, expires_at: float | None) -> None:
3286        """
3287        Signal a sleep timer change for the player on the event bus.
3288
3289        :param player: Player whose sleep timer changed.
3290        :param expires_at: New expiry timestamp, or None when the timer was cleared.
3291        """
3292        if player.state.type == PlayerType.PROTOCOL:
3293            return
3294        self.mass.signal_event(
3295            EventType.PLAYER_SLEEP_TIMER_UPDATED,
3296            object_id=player.player_id,
3297            data=expires_at,
3298        )
3299
3300    @staticmethod
3301    def _sleep_timer_task_id(player_id: str) -> str:
3302        """
3303        Return the scheduled task ID for a player's sleep timer.
3304
3305        :param player_id: Player ID to build the task ID for.
3306        """
3307        return f"player_sleep_timer_{player_id}"
3308
3309    # Private command handlers (no permission checks)
3310
3311    async def _handle_cmd_resume(
3312        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
3313    ) -> None:
3314        """
3315        Handle resume playback command.
3316
3317        Skips permission checks and locking (internal use only).
3318        """
3319        player = self._get_player_with_redirect(player_id)
3320        source = source or player.state.active_source
3321        media = media or player.state.current_media
3322        # power on the player if needed
3323        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3324            await self._handle_cmd_power(player.player_id, True)
3325        # Redirect to queue controller if it is active
3326        if active_queue := self.mass.player_queues.get(source or player_id):
3327            await self.mass.player_queues.resume(active_queue.queue_id)
3328            return
3329        # try to handle command on player directly
3330        # TODO: check if player has an active source with native resume support
3331        active_source = next((x for x in player.state.source_list if x.id == source), None)
3332        if (
3333            player.state.playback_state in (PlaybackState.IDLE, PlaybackState.PAUSED)
3334            and active_source
3335            and active_source.can_play_pause
3336            and PlayerFeature.PAUSE in player.state.supported_features
3337        ):
3338            # player has some other source active and native resume support
3339            await player.play()
3340            return
3341        if active_source and not active_source.passive:
3342            await self.select_source(player_id, active_source.id)
3343            return
3344        if media:
3345            # try to re-play the current media item
3346            await player.play_media(media)
3347            return
3348        # fallback: just try to resume queue playback
3349        await self.mass.player_queues.resume(player.player_id)
3350
3351    async def _handle_cmd_power(
3352        self, player_id: str, powered: bool, skip_auto_play: bool = False
3353    ) -> None:
3354        """
3355        Handle player power on/off command.
3356
3357        Skips permission checks and locking (internal use only).
3358
3359        :param player_id: The player ID to power on/off.
3360        :param powered: True to power on, False to power off.
3361        :param skip_auto_play: If True, skip auto-play on power on.
3362        """
3363        player = self.get_player(player_id, True)
3364        assert player is not None  # for type checking
3365        player_state = player.state
3366
3367        if player_state.powered == powered:
3368            self.logger.debug(
3369                "Ignoring power %s command for player %s: already in state %s",
3370                "ON" if powered else "OFF",
3371                player_state.name,
3372                "ON" if player_state.powered else "OFF",
3373            )
3374            return  # nothing to do
3375
3376        # ungroup player at power off
3377        player_was_sync_child = bool(player.state.synced_to or player.state.active_group)
3378        if (
3379            (player_was_sync_child or player.group_members)
3380            and player.type == PlayerType.PLAYER
3381            and not powered
3382        ):
3383            # ungroup player if it is synced (or is a sync leader itself)
3384            await self.cmd_ungroup(player_id)
3385
3386        # always stop player at power off
3387        if (
3388            not powered
3389            and not player_was_sync_child
3390            and player_state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
3391        ):
3392            # wait for the stop command to process and prevent race conditions
3393            async with self.wait_for_player_update(player_id, timeout=5):
3394                await self._handle_cmd_stop(player_id)
3395
3396        # power off all synced childs when player is a sync leader
3397        elif not powered and player_state.type == PlayerType.PLAYER and player_state.group_members:
3398            async with TaskManager(self.mass) as tg:
3399                for member in self.iter_group_members(player, True):
3400                    if member.power_control == PLAYER_CONTROL_NONE:
3401                        continue
3402                    tg.create_task(self._handle_cmd_power(member.player_id, False))
3403
3404        # handle actual power command
3405        if player_state.power_control == PLAYER_CONTROL_NONE:
3406            self.logger.debug(
3407                "Player %s does not support power control, ignoring power command",
3408                player_state.name,
3409            )
3410            return
3411        if player_state.power_control == PLAYER_CONTROL_NATIVE:
3412            # player supports power command natively: forward to player provider
3413            await player.power(powered)
3414            if powered:
3415                await wait_for_power_on(self.logger, player)
3416        elif player_state.power_control == PLAYER_CONTROL_FAKE:
3417            # user wants to use fake power control - so we (optimistically) update the state
3418            # and store the state in the cache
3419            player.extra_data[ATTR_FAKE_POWER] = powered
3420            # Group players need to actively form/dissolve their session when the
3421            # user toggles fake power — otherwise the toggle would only update the
3422            # cosmetic state without ever capturing or releasing the members.
3423            if player_state.type == PlayerType.GROUP:
3424                await player.power(powered)
3425            player.update_state()  # trigger update of the player state
3426            if player_state.type != PlayerType.GROUP:
3427                # see register(): group fake-power is intentionally not persisted
3428                # because there is no session to restore at boot.
3429                await self.mass.cache.set(
3430                    key=player_id,
3431                    data=powered,
3432                    provider=self.domain,
3433                    category=CACHE_CATEGORY_PLAYER_POWER,
3434                )
3435        # handle external player control
3436        elif player_control := self._controls.get(player.state.power_control):
3437            control_name = player_control.name
3438            self.logger.debug("Redirecting power command to PlayerControl %s", control_name)
3439            if not player_control.supports_power:
3440                raise UnsupportedFeaturedException(
3441                    f"Player control {control_name} is not available"
3442                )
3443            if powered:
3444                assert player_control.power_on is not None  # for type checking
3445                await player_control.power_on()
3446                await wait_for_power_on(self.logger, player, player_control)
3447            else:
3448                assert player_control.power_off is not None  # for type checking
3449                await player_control.power_off()
3450        # always trigger a state update to update the UI
3451        player.refresh_state()
3452
3453        # handle 'auto play on power on' feature
3454        if (
3455            not skip_auto_play
3456            and not player_state.active_group
3457            and not player_state.synced_to
3458            and powered
3459            and player.config.get_value(CONF_AUTO_PLAY)
3460            and player_state.active_source in (None, player_id)
3461            and not player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)
3462        ):
3463            await self.mass.player_queues.resume(player_id)
3464
3465    async def _handle_cmd_volume_set(self, player_id: str, volume_level: int) -> None:
3466        """
3467        Handle Player volume set command.
3468
3469        Skips permission checks and locking (internal use only).
3470
3471        :param player_id: player_id of the player to handle the command.
3472        :param volume_level: logical volume level (0..100) to set on the player.
3473        """
3474        player = self.get_player(player_id, True)
3475        assert player is not None  # for type checker
3476
3477        # Clamp logical volume to 0-100
3478        volume_level = max(0, min(100, volume_level))
3479
3480        if player.type == PlayerType.GROUP:
3481            # redirect to special group volume control
3482            await self.cmd_group_volume(player_id, volume_level)
3483            return
3484
3485        # Check if player has mute lock (set when individually muted in a group)
3486        # If locked, don't auto-unmute when volume changes
3487        has_mute_lock = self._has_active_mute_lock(player)
3488        if (
3489            not has_mute_lock
3490            # the live value is what cmd_volume_mute checks, so a control change that
3491            # has not reached the player state yet may not send us into a failing unmute
3492            and player.mute_control not in (PLAYER_CONTROL_NONE, PLAYER_CONTROL_FAKE)
3493            and player.state.volume_muted
3494        ):
3495            # if player is muted and not locked, we unmute it first
3496            # skip this for fake mute since it uses volume to simulate mute
3497            self.logger.debug(
3498                "Unmuting player %s before setting volume",
3499                player.state.name,
3500            )
3501            await self.cmd_volume_mute(player_id, False)
3502
3503        if (
3504            has_mute_lock
3505            and player.mute_control == PLAYER_CONTROL_FAKE
3506            and player.extra_data.get(ATTR_FAKE_MUTE)
3507        ):
3508            # a locked player stays silent, the volume it holds is the one
3509            # that gets restored once it is unmuted again
3510            volume_level = 0
3511        else:
3512            # always reset fake mute when controlling volume
3513            player.extra_data.pop(ATTR_FAKE_MUTE, None)
3514
3515        # Scale logical volume (0-100) to device volume (min_volume-max_volume)
3516        device_volume = self.scale_volume_to_device(player_id, volume_level)
3517
3518        # Notify the active AudioSource of a volume change.
3519        # Only fire if this player is the direct owner of its queue,
3520        # not when it merely inherits active_source from a parent group —
3521        # group volume changes handle the callback once at the group level.
3522        if active := self._get_active_audio_source(player):
3523            audio_source, plugin_prov = active
3524            active_queue = self.get_active_queue(player)
3525            if active_queue is not None and active_queue.queue_id == player.player_id:
3526                await plugin_prov.on_volume_change(audio_source.item_id, volume_level)
3527
3528        # Handle native volume control support
3529        if player.volume_control == PLAYER_CONTROL_NATIVE:
3530            # player supports volume command natively: forward to player
3531            await player.volume_set(device_volume)
3532            return
3533        # Handle fake volume control support
3534        if player.volume_control == PLAYER_CONTROL_FAKE:
3535            # user wants to use fake volume control - so we (optimistically) update the state
3536            # and store the state in the cache. Fake volume uses the logical volume (no scaling).
3537            player.extra_data[ATTR_FAKE_VOLUME] = volume_level
3538            player.update_state()
3539            return
3540        # player has no volume support at all
3541        if player.volume_control == PLAYER_CONTROL_NONE:
3542            raise UnsupportedFeaturedException(
3543                f"Player {player.state.name} does not support volume control"
3544            )
3545        # handle external player control
3546        if player_control := self._controls.get(player.state.volume_control):
3547            control_name = player_control.name
3548            self.logger.debug("Redirecting volume command to PlayerControl %s", control_name)
3549            if not player_control.supports_volume:
3550                raise UnsupportedFeaturedException(
3551                    f"Player control {control_name} is not available"
3552                )
3553            assert player_control.volume_set is not None
3554            # forward the already-scaled device volume; the external control sets the
3555            # raw device volume and does not apply min/max scaling of its own
3556            await player_control.volume_set(device_volume)
3557            return
3558        if protocol_player := self.get_player(player.state.volume_control):
3559            # redirect to protocol player volume control.
3560            # forward the already-scaled device volume so the min/max limits configured
3561            # on this (user-facing) player are honored; the protocol player has no
3562            # limits of its own, so its scaling is an identity pass-through.
3563            self.logger.debug(
3564                "Redirecting volume command to protocol player %s",
3565                protocol_player.provider.manifest.name,
3566            )
3567            await self._handle_cmd_volume_set(protocol_player.player_id, device_volume)
3568            return
3569
3570    @staticmethod
3571    def _is_in_group(state: PlayerState) -> bool:
3572        """Check if the player with the given state is currently grouped with other players."""
3573        # a sync leader has neither synced_to nor active_group set, but it does lead its
3574        # own group_members, which stays empty for a player that is not grouped at all
3575        return bool(state.synced_to or state.active_group or state.group_members)
3576
3577    def _has_active_mute_lock(self, player: Player) -> bool:
3578        """
3579        Check if the given player holds a mute lock that still applies to it.
3580
3581        A lock is only earned inside a group and only holds for as long as the player
3582        is still grouped, so it can not outlive the group it was earned in.
3583
3584        :param player: The player to check, which may be a protocol player.
3585        """
3586        if player.extra_data.get(ATTR_MUTE_LOCK) and self._is_in_group(player.state):
3587            return True
3588        # cmd_volume_mute stores the lock on the parent player, while the volume command
3589        # may arrive with the protocol player ID (e.g. during group volume changes)
3590        if player.protocol_parent_id and (parent := self.get_player(player.protocol_parent_id)):
3591            return bool(parent.extra_data.get(ATTR_MUTE_LOCK)) and self._is_in_group(parent.state)
3592        return False
3593
3594    async def _mute_group_members(self, group_player: Player, muted: bool) -> None:
3595        """
3596        Mute or unmute all mute capable members of a player group or synced players.
3597
3598        :param group_player: The group player or sync leader.
3599        :param muted: bool if the group should be muted.
3600        """
3601        coros = []
3602        for child_player in self.iter_group_members(
3603            group_player, only_powered=True, exclude_self=False
3604        ):
3605            if child_player.mute_control == PLAYER_CONTROL_NONE:
3606                # members without a mute control are left alone, just like the
3607                # group mute state itself is calculated from the capable members only
3608                continue
3609            coros.append(self.cmd_volume_mute(child_player.player_id, muted))
3610        await asyncio.gather(*coros)
3611
3612    async def _handle_cmd_volume_mute(self, player: Player, mute_control: str, muted: bool) -> None:
3613        """
3614        Send the mute command to the given player's mute control.
3615
3616        Skips permission checks, locking and mute lock bookkeeping (internal use only).
3617
3618        :param player: the player to handle the command.
3619        :param mute_control: the already resolved mute control of the player.
3620        :param muted: bool if player should be muted.
3621        """
3622        if mute_control == PLAYER_CONTROL_NATIVE:
3623            # player supports mute command natively: forward to player
3624            await player.volume_mute(muted)
3625            return
3626        if mute_control == PLAYER_CONTROL_FAKE:
3627            # user wants to use fake mute control - so we use volume instead
3628            self.logger.debug(
3629                "Using volume for muting for player %s",
3630                player.state.name,
3631            )
3632            if muted:
3633                already_muted = bool(player.extra_data.get(ATTR_FAKE_MUTE))
3634                if not already_muted:
3635                    # on a repeated mute command the volume is already 0
3636                    player.extra_data[ATTR_PREVIOUS_VOLUME] = player.state.volume_level
3637                await self._handle_cmd_volume_set(player.player_id, 0)
3638                # set the flag after the volume command, as that clears it
3639                player.extra_data[ATTR_FAKE_MUTE] = True
3640                player.update_state()
3641            else:
3642                was_muted = bool(player.extra_data.get(ATTR_FAKE_MUTE))
3643                player.extra_data[ATTR_FAKE_MUTE] = False
3644                player.update_state()
3645                if not was_muted:
3646                    # the volume is the one the user is listening at, restoring
3647                    # anything here would turn a no-op unmute into a volume change
3648                    return
3649                stored_volume: int | None = player.extra_data.pop(ATTR_PREVIOUS_VOLUME, None)
3650                # the volume was still unknown at mute time, so pick a low volume
3651                # rather than blasting the speaker at some assumed level
3652                await self._handle_cmd_volume_set(
3653                    player.player_id, 1 if stored_volume is None else stored_volume
3654                )
3655            return
3656
3657        # handle external player control
3658        if player_control := self._controls.get(mute_control):
3659            control_name = player_control.name
3660            self.logger.debug("Redirecting mute command to PlayerControl %s", control_name)
3661            if not player_control.supports_mute:
3662                raise UnsupportedFeaturedException(
3663                    f"Player control {control_name} is not available"
3664                )
3665            assert player_control.mute_set is not None
3666            await player_control.mute_set(muted)
3667            return
3668
3669        # handle to protocol player as volume_mute control
3670        if protocol_player := self.get_player(mute_control):
3671            self.logger.debug(
3672                "Redirecting mute command to protocol player %s",
3673                protocol_player.provider.manifest.name,
3674            )
3675            await protocol_player.volume_mute(muted)
3676            return
3677
3678        # the configured control disappeared after the mute control was resolved
3679        raise UnsupportedFeaturedException(f"Player {player.state.name} does not support muting")
3680
3681    async def _handle_play_media(self, player_id: str, media: PlayerMedia) -> None:
3682        """
3683        Handle play media command without group redirect.
3684
3685        Skips permission checks, locking, and all redirect logic (internal use only).
3686
3687        :param player_id: player_id of the player to handle the command.
3688        :param media: The Media that needs to be played on the player.
3689        """
3690        player = self.get_player(player_id, raise_unavailable=True)
3691        assert player is not None
3692        # set active source if media has a source_id (e.g. plugin source or mass queue source)
3693        if media.source_id:
3694            player.set_active_mass_source(media.source_id)
3695
3696        # Determine output protocol to use:
3697        # While a session is active (playing/paused), keep using the already active
3698        # protocol so mid-session commands stay on the same output.
3699        # On a fresh start always (re)select: a leftover active protocol from a
3700        # previous session must not overrule user preference, a grouped protocol
3701        # or native playback (and it may point at a player that is gone by now).
3702        target_player: Player | None = None
3703        output_protocol: OutputProtocol | None = None
3704        if (
3705            player.state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
3706            and player.active_output_protocol
3707            and player.active_output_protocol != "native"
3708            and (protocol_player := self.get_player(player.active_output_protocol))
3709        ):
3710            # Use the already-set protocol directly
3711            output_protocol = next(
3712                (
3713                    p
3714                    for p in player.linked_output_protocols
3715                    if p.output_protocol_id == player.active_output_protocol
3716                ),
3717                None,
3718            )
3719            if output_protocol is not None:
3720                target_player = protocol_player
3721        if target_player is None:
3722            target_player, output_protocol = self._select_best_output_protocol(player)
3723
3724        if target_player.player_id != player.player_id:
3725            # Playing via linked protocol - update active output protocol
3726            # output_protocol is guaranteed to be non-None when target_player != player
3727            assert output_protocol is not None
3728            self.logger.debug(
3729                "Starting playback on %s via protocol %s (target=%s), group_members=%s",
3730                player.state.name,
3731                output_protocol.name,
3732                target_player.display_name,
3733                target_player.state.group_members,
3734            )
3735            player.set_active_output_protocol(output_protocol.output_protocol_id)
3736        elif player.type != PlayerType.GROUP:
3737            # Native playback - group players don't have output protocols of their own
3738            # (they delegate to a sync leader / member which manages its own protocol)
3739            self.logger.debug(
3740                "Starting playback on %s via native, group_members=%s",
3741                player.state.name,
3742                player.state.group_members,
3743            )
3744            player.set_active_output_protocol("native")
3745
3746        # power on the player if needed (skip auto-play since we're about to start playback)
3747        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3748            await self._handle_cmd_power(player.player_id, True, skip_auto_play=True)
3749        await target_player.play_media(media)
3750        if target_player.player_id != player.player_id:
3751            # notify the native player that protocol playback started
3752            assert output_protocol is not None
3753            await player.on_protocol_playback(output_protocol=output_protocol)
3754
3755    async def _handle_enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
3756        """
3757        Handle enqueue next media command without group redirect.
3758
3759        Skips permission checks, locking, and all redirect logic (internal use only).
3760
3761        :param player_id: player_id of the player to handle the command.
3762        :param media: The Media that needs to be enqueued on the player.
3763        """
3764        player = self.get_player(player_id, raise_unavailable=True)
3765        assert player is not None
3766        if target_player := self._get_control_target(
3767            player,
3768            required_feature=PlayerFeature.ENQUEUE,
3769            require_active=True,
3770        ):
3771            self.logger.debug(
3772                "Redirecting enqueue command to protocol player %s",
3773                target_player.provider.manifest.name,
3774            )
3775            await target_player.enqueue_next_media(media)
3776            return
3777
3778        if PlayerFeature.ENQUEUE not in player.state.supported_features:
3779            raise UnsupportedFeaturedException(
3780                f"Player {player.state.name} does not support enqueueing"
3781            )
3782        await player.enqueue_next_media(media)
3783
3784    async def _handle_select_source(self, player_id: str, source: str | None) -> None:
3785        """
3786        Handle select source command without group redirect.
3787
3788        Skips permission checks, locking, and all redirect logic (internal use only).
3789
3790        :param player_id: player_id of the player to handle the command.
3791        :param source: The ID of the source that needs to be activated/selected.
3792        """
3793        if source is None:
3794            source = player_id  # default to MA queue source
3795        player = self.get_player(player_id, True)
3796        assert player is not None
3797        # check if player is already playing and source is different
3798        # in that case we need to stop the player first
3799        prev_source = player.state.active_source
3800        if prev_source and source != prev_source:
3801            with suppress(PlayerCommandFailed, RuntimeError):
3802                # just try to stop (regardless of state)
3803                async with self.wait_for_player_update(player_id, timeout=5):
3804                    await self._handle_cmd_stop(player_id)
3805        # check if source is a mass queue
3806        # this can be used to restore the queue after a source switch
3807        if self.mass.player_queues.get(source):
3808            player.set_active_mass_source(source)
3809            return
3810        # Legacy compatibility: the old plugin-source API used the
3811        # plugin's instance_id directly as the source string. The refactor
3812        # moved plugin sources to first-class AudioSource MediaItems played
3813        # via player_queues.play_media. Translate a legacy plugin-instance-id
3814        # source into the new flow so old frontends, third-party scripts,
3815        # and HA automations keep working — but only when the provider
3816        # exposes EXACTLY ONE AudioSource (it was always a 1:1 mapping under
3817        # the old API; multi-source providers have to use the explicit URI).
3818        if (legacy_prov := self.mass.get_provider(source)) and isinstance(
3819            legacy_prov, PluginProvider
3820        ):
3821            if ProviderFeature.AUDIO_SOURCE not in legacy_prov.supported_features:
3822                raise PlayerCommandFailed(f"Provider {source} does not expose AudioSources")
3823            sources = await legacy_prov.get_audio_sources()
3824            if len(sources) == 1:
3825                self.logger.debug(
3826                    "Translating legacy select_source(%s) to play_media(%s)",
3827                    source,
3828                    sources[0].uri,
3829                )
3830                await self.mass.player_queues.play_media(player_id, str(sources[0].uri))
3831                return
3832            raise UnsupportedFeaturedException(
3833                f"Provider {source} exposes {len(sources)} AudioSources; the legacy "
3834                "select_source(plugin_instance_id) API only supported 1:1 mappings. "
3835                "Use player_queues.play_media with an explicit AudioSource URI."
3836            )
3837        # basic check if player supports source selection
3838        if PlayerFeature.SELECT_SOURCE not in player.state.supported_features:
3839            raise UnsupportedFeaturedException(
3840                f"Player {player.state.name} does not support source selection"
3841            )
3842        # basic check if source is valid for player
3843        if not any(x for x in player.state.source_list if x.id == source):
3844            raise PlayerCommandFailed(
3845                f"{source} is an invalid source for player {player.state.name}"
3846            )
3847        # forward to player
3848        await player.select_source(source)
3849
3850    async def _handle_cmd_stop(self, player_id: str) -> None:
3851        """
3852        Handle stop command without any redirects.
3853
3854        Skips permission checks, locking, and all redirect logic (internal use only).
3855
3856        :param player_id: player_id of the player to handle the command.
3857        """
3858        player = self.get_player(player_id, raise_unavailable=True)
3859        assert player is not None
3860        protocol_player: Player | None = None
3861        if player.active_output_protocol and player.active_output_protocol != "native":
3862            protocol_player = self.get_player(player.active_output_protocol)
3863        if player.state.playback_state == PlaybackState.IDLE:
3864            # The player already reports idle but an output protocol is still marked
3865            # active: the protocol player may never have received a stop at all
3866            # (e.g. the source stream ended on its own before this stop command
3867            # arrived). Forward an (idempotent) stop and schedule the protocol clear
3868            # so no stale session lingers on the device and the next playback
3869            # (re)selects the output protocol.
3870            if protocol_player is not None:
3871                await protocol_player.stop()
3872                if len(protocol_player.group_members) <= 1:
3873                    self.schedule_active_output_protocol_clear(player)
3874            return
3875        player.mark_stop_called()
3876        # Delegate to active protocol player if one is active
3877        target_player = player
3878        if protocol_player is not None:
3879            target_player = protocol_player
3880            if PlayerFeature.POWER in target_player.supported_features:
3881                # if protocol player supports/requires power,
3882                # we power it off instead of just stopping (which also stops playback)
3883                # this is rare as most protocols do not support power control (except for cast)
3884                await self._handle_cmd_power(target_player.player_id, False)
3885                return
3886
3887        # handle command on player(protocol) directly
3888        await target_player.stop()
3889        # Only clear active protocol if the protocol player has no remaining group members.
3890        # If there are still protocol group members, keep the protocol active so that
3891        # when playback resumes it continues on the same protocol.
3892        if target_player.player_id == player.player_id or len(target_player.group_members) <= 1:
3893            self.schedule_active_output_protocol_clear(player)
3894
3895    async def _handle_cmd_play(self, player_id: str) -> None:
3896        """
3897        Handle play command without group redirect.
3898
3899        Skips permission checks, locking, and all redirect logic (internal use only).
3900
3901        :param player_id: player_id of the player to handle the command.
3902        """
3903        player = self.get_player(player_id, raise_unavailable=True)
3904        assert player is not None
3905        if player.state.playback_state == PlaybackState.PLAYING:
3906            self.logger.info(
3907                "Ignore PLAY request to player %s: player is already playing", player.state.name
3908            )
3909            return
3910        # If an AudioSource is the active queue item, proxy play to the plugin
3911        if active := self._get_active_audio_source(player):
3912            audio_source, plugin_prov = active
3913            if audio_source.can_play_pause:
3914                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PLAY)
3915                return
3916        # handle unpause (=play if player is paused)
3917        if player.state.playback_state == PlaybackState.PAUSED:
3918            active_source = next(
3919                (x for x in player.state.source_list if x.id == player.state.active_source), None
3920            )
3921            # raise if active source does not support play/pause
3922            if active_source and not active_source.can_play_pause:
3923                msg = (
3924                    f"The active source ({active_source.name}) on player "
3925                    f"{player.state.name} does not support play/pause"
3926                )
3927                raise PlayerCommandFailed(msg)
3928            # Delegate to active protocol player if one is active
3929            if target_player := self._get_control_target(
3930                player, PlayerFeature.PAUSE, require_active=True
3931            ):
3932                await target_player.play()
3933                return
3934            # No active protocol target: if the player rendering the audio supports pause and
3935            # the active (external) source can be paused, unpause it directly instead of
3936            # restarting the source.
3937            output_player = player.resolve_output_player()
3938            if (
3939                active_source
3940                and active_source.can_play_pause
3941                and PlayerFeature.PAUSE in output_player.supported_features
3942            ):
3943                await output_player.play()
3944                return
3945
3946        # player is not paused: try to resume the player
3947        # Note: We handle resume inline here without calling _handle_cmd_resume
3948        active_source = next(
3949            (x for x in player.state.source_list if x.id == player.state.active_source), None
3950        )
3951        media = player.state.current_media
3952        # power on the player if needed
3953        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3954            await self._handle_cmd_power(player.player_id, True)
3955        if active_source and not active_source.passive:
3956            await self._handle_select_source(player_id, active_source.id)
3957            return
3958        if media:
3959            # try to re-play the current media item
3960            await player.play_media(media)
3961            return
3962        # fallback: just send play command - which will fail if nothing can be played
3963        await player.play()
3964
3965    async def _handle_cmd_pause(self, player_id: str) -> None:
3966        """
3967        Handle pause command without any redirects.
3968
3969        Skips permission checks, locking, and all redirect logic (internal use only).
3970
3971        :param player_id: player_id of the player to handle the command.
3972        """
3973        player = self.get_player(player_id, raise_unavailable=True)
3974        assert player is not None
3975        if player.state.playback_state == PlaybackState.IDLE:
3976            return
3977        # If an AudioSource is the active queue item, proxy pause to the plugin
3978        if active := self._get_active_audio_source(player):
3979            audio_source, plugin_prov = active
3980            if audio_source.can_play_pause:
3981                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PAUSE)
3982                return
3983        # handle command on player/source directly
3984        active_source = next(
3985            (x for x in player.state.source_list if x.id == player.state.active_source), None
3986        )
3987        if active_source and not active_source.can_play_pause:
3988            # raise if active source does not support play/pause
3989            msg = (
3990                f"The active source ({active_source.name}) on player "
3991                f"{player.state.name} does not support play/pause"
3992            )
3993            raise PlayerCommandFailed(msg)
3994        # Delegate to active protocol player if one is active
3995        if target_player := self._get_control_target(
3996            player, PlayerFeature.PAUSE, require_active=True
3997        ):
3998            await target_player.pause()
3999            return
4000        # No active protocol target: if the player rendering the audio supports pause and the
4001        # active (external) source can be paused, forward the command to it instead of stopping
4002        # it (mirrors the external-source handling in cmd_seek/cmd_next_track).
4003        output_player = player.resolve_output_player()
4004        if (
4005            active_source
4006            and active_source.can_play_pause
4007            and PlayerFeature.PAUSE in output_player.supported_features
4008        ):
4009            await output_player.pause()
4010            return
4011        # player/protocol does not support pause: fall back to stop
4012        self.logger.debug(
4013            "Player/protocol %s does not support pause, using STOP instead",
4014            player.state.name,
4015        )
4016        await self._handle_cmd_stop(player.player_id)
4017