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