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