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