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