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