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