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