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 time
21from contextlib import suppress
22from contextvars import ContextVar
23from typing import TYPE_CHECKING, Any, cast
24
25from music_assistant_models.auth import UserRole
26from music_assistant_models.constants import (
27    PLAYER_CONTROL_FAKE,
28    PLAYER_CONTROL_NATIVE,
29    PLAYER_CONTROL_NONE,
30)
31from music_assistant_models.enums import (
32    EventType,
33    MediaType,
34    PlaybackState,
35    PlayerFeature,
36    PlayerType,
37    ProviderFeature,
38    ProviderType,
39)
40from music_assistant_models.errors import (
41    AlreadyRegisteredError,
42    InsufficientPermissions,
43    MusicAssistantError,
44    PlayerCommandFailed,
45    PlayerUnavailableError,
46    ProviderUnavailableError,
47    UnsupportedFeaturedException,
48)
49from music_assistant_models.player import PlayerOptionValueType  # noqa: TC002
50from music_assistant_models.player_control import PlayerControl  # noqa: TC002
51
52from music_assistant.constants import (
53    ANNOUNCE_ALERT_FILE,
54    ATTR_ACTIVE_SOURCE,
55    ATTR_ANNOUNCEMENT_IN_PROGRESS,
56    ATTR_AVAILABLE,
57    ATTR_ELAPSED_TIME,
58    ATTR_ENABLED,
59    ATTR_FAKE_MUTE,
60    ATTR_FAKE_POWER,
61    ATTR_FAKE_VOLUME,
62    ATTR_GROUP_MEMBERS,
63    ATTR_LAST_POLL,
64    ATTR_MUTE_LOCK,
65    ATTR_PREVIOUS_VOLUME,
66    CONF_AUTO_PLAY,
67    CONF_ENTRY_ANNOUNCE_VOLUME,
68    CONF_ENTRY_ANNOUNCE_VOLUME_MAX,
69    CONF_ENTRY_ANNOUNCE_VOLUME_MIN,
70    CONF_ENTRY_ANNOUNCE_VOLUME_STRATEGY,
71    CONF_ENTRY_TTS_PRE_ANNOUNCE,
72    CONF_ENTRY_ZEROCONF_INTERFACES,
73    CONF_PLAYER_DSP,
74    CONF_PLAYERS,
75    CONF_PRE_ANNOUNCE_CHIME_URL,
76)
77from music_assistant.controllers.webserver.helpers.auth_middleware import (
78    get_current_user,
79    get_sendspin_player_id,
80)
81from music_assistant.helpers.api import api_command
82from music_assistant.helpers.tags import async_parse_tags
83from music_assistant.helpers.throttle_retry import Throttler
84from music_assistant.helpers.util import TaskManager, validate_announcement_chime_url
85from music_assistant.models.core_controller import CoreController
86from music_assistant.models.player import Player, PlayerMedia, PlayerState
87from music_assistant.models.player_provider import PlayerProvider
88from music_assistant.models.plugin import PluginProvider, PluginSource
89
90from .helpers import AnnounceData, handle_player_command
91from .protocol_linking import ProtocolLinkingMixin
92
93if TYPE_CHECKING:
94    from collections.abc import Iterator
95
96    from music_assistant_models.config_entries import (
97        ConfigEntry,
98        ConfigValueType,
99        CoreConfig,
100        PlayerConfig,
101    )
102    from music_assistant_models.player_queue import PlayerQueue
103
104    from music_assistant import MusicAssistant
105
106CACHE_CATEGORY_PLAYER_POWER = 1
107
108# Context variable to prevent circular calls between players and player_queues controllers
109IN_QUEUE_COMMAND: ContextVar[bool] = ContextVar("IN_QUEUE_COMMAND", default=False)
110
111
112class PlayerController(ProtocolLinkingMixin, CoreController):
113    """Controller holding all logic to control registered players."""
114
115    domain: str = "players"
116
117    def __init__(self, mass: MusicAssistant) -> None:
118        """Initialize core controller."""
119        super().__init__(mass)
120        self._players: dict[str, Player] = {}
121        self._controls: dict[str, PlayerControl] = {}
122        self.manifest.name = "Player Controller"
123        self.manifest.description = (
124            "Music Assistant's core controller which manages all players from all providers."
125        )
126        self.manifest.icon = "speaker-multiple"
127        self._poll_task: asyncio.Task[None] | None = None
128        self._player_throttlers: dict[str, Throttler] = {}
129        self._player_command_locks: dict[str, asyncio.Lock] = {}
130        # Lock to prevent race conditions during player registration
131        self._register_lock = asyncio.Lock()
132        # Track pending protocol player evaluations (delayed to allow all protocols to register)
133        self._pending_protocol_evaluations: dict[str, asyncio.TimerHandle] = {}
134
135    async def get_config_entries(
136        self,
137        action: str | None = None,
138        values: dict[str, ConfigValueType] | None = None,
139    ) -> tuple[ConfigEntry, ...]:
140        """Return Config Entries for the Player Controller."""
141        return (CONF_ENTRY_ZEROCONF_INTERFACES,)
142
143    async def setup(self, config: CoreConfig) -> None:
144        """Async initialize of module."""
145        self._poll_task = self.mass.create_task(self._poll_players())
146
147    async def close(self) -> None:
148        """Cleanup on exit."""
149        if self._poll_task and not self._poll_task.done():
150            self._poll_task.cancel()
151        # Cancel all pending protocol evaluations
152        for handle in self._pending_protocol_evaluations.values():
153            handle.cancel()
154        self._pending_protocol_evaluations.clear()
155
156    async def on_provider_loaded(self, provider: PlayerProvider) -> None:
157        """Handle logic when a provider is loaded."""
158
159    async def on_provider_unload(self, provider: PlayerProvider) -> None:
160        """Handle logic when a provider is (about to get) unloaded."""
161
162    @property
163    def providers(self) -> list[PlayerProvider]:
164        """Return all loaded/running MusicProviders."""
165        return cast("list[PlayerProvider]", self.mass.get_providers(ProviderType.PLAYER))
166
167    def all_players(
168        self,
169        return_unavailable: bool = True,
170        return_disabled: bool = False,
171        provider_filter: str | None = None,
172        return_protocol_players: bool = False,
173    ) -> list[Player]:
174        """
175        Return all registered players.
176
177        Note that this applies user filters for players (for non admin users).
178
179        :param return_unavailable [bool]: Include unavailable players.
180        :param return_disabled [bool]: Include disabled players.
181        :param provider_filter [str]: Optional filter by provider lookup key.
182        :param return_protocol_players [bool]: Include protocol players (hidden by default).
183
184        :return: List of Player objects.
185        """
186        current_user = get_current_user()
187        user_filter = (
188            current_user.player_filter
189            if current_user and current_user.role != UserRole.ADMIN
190            else None
191        )
192        current_sendspin_player = get_sendspin_player_id()
193        return [
194            player
195            for player in list(self._players.values())
196            if (player.state.available or return_unavailable)
197            and (player.state.enabled or return_disabled)
198            and (provider_filter is None or player.provider.instance_id == provider_filter)
199            and (
200                not user_filter
201                or player.player_id in user_filter
202                or player.player_id == current_sendspin_player
203            )
204            and (return_protocol_players or player.state.type != PlayerType.PROTOCOL)
205        ]
206
207    @api_command("players/all")
208    def all_player_states(
209        self,
210        return_unavailable: bool = True,
211        return_disabled: bool = False,
212        provider_filter: str | None = None,
213        return_protocol_players: bool = False,
214    ) -> list[PlayerState]:
215        """
216        Return PlayerState for all registered players.
217
218        :param return_unavailable [bool]: Include unavailable players.
219        :param return_disabled [bool]: Include disabled players.
220        :param provider_filter [str]: Optional filter by provider lookup key.
221        :param return_protocol_players [bool]: Include protocol players (hidden by default).
222
223        :return: List of PlayerState objects.
224        """
225        return [
226            player.state
227            for player in self.all_players(
228                return_unavailable=return_unavailable,
229                return_disabled=return_disabled,
230                provider_filter=provider_filter,
231                return_protocol_players=return_protocol_players,
232            )
233        ]
234
235    def get_player(
236        self,
237        player_id: str,
238        raise_unavailable: bool = False,
239    ) -> Player | None:
240        """
241        Return Player by player_id.
242
243        :param player_id [str]: ID of the player.
244        :param raise_unavailable [bool]: Raise if player is unavailable.
245
246        :raises PlayerUnavailableError: If player is unavailable and raise_unavailable is True.
247        :return: Player object or None.
248        """
249        if player := self._players.get(player_id):
250            if (not player.state.available or not player.state.enabled) and raise_unavailable:
251                msg = f"Player {player_id} is not available"
252                raise PlayerUnavailableError(msg)
253            return player
254        if raise_unavailable:
255            msg = f"Player {player_id} is not available"
256            raise PlayerUnavailableError(msg)
257        return None
258
259    @api_command("players/get")
260    def get_player_state(
261        self,
262        player_id: str,
263        raise_unavailable: bool = False,
264    ) -> PlayerState | None:
265        """
266        Return PlayerState by player_id.
267
268        :param player_id [str]: ID of the player.
269        :param raise_unavailable [bool]: Raise if player is unavailable.
270
271        :raises PlayerUnavailableError: If player is unavailable and raise_unavailable is True.
272        :return: Player object or None.
273        """
274        current_user = get_current_user()
275        user_filter = (
276            current_user.player_filter
277            if current_user and current_user.role != UserRole.ADMIN
278            else None
279        )
280        current_sendspin_player = get_sendspin_player_id()
281        if (
282            current_user
283            and user_filter
284            and player_id not in user_filter
285            and player_id != current_sendspin_player
286        ):
287            msg = f"{current_user.username} does not have access to player {player_id}"
288            raise InsufficientPermissions(msg)
289        if player := self.get_player(player_id, raise_unavailable):
290            return player.state
291        return None
292
293    def get_player_by_name(self, name: str) -> Player | None:
294        """
295        Return Player by name.
296
297        Performs case-insensitive matching against the player's state name
298        (the final name visible in clients and API).
299        If multiple players match, logs a warning and returns the first match.
300
301        :param name: Name of the player.
302        :return: Player object or None.
303        """
304        name_normalized = name.strip().lower()
305        matches: list[Player] = []
306
307        for player in list(self._players.values()):
308            if player.state.name.strip().lower() == name_normalized:
309                matches.append(player)
310
311        if not matches:
312            return None
313
314        if len(matches) > 1:
315            player_ids = [p.player_id for p in matches]
316            self.logger.warning(
317                "players/get_by_name: Multiple players found with name '%s': %s - "
318                "returning first match (%s). "
319                "Consider using the players/get API with player_id instead "
320                "for unambiguous lookups.",
321                name,
322                player_ids,
323                matches[0].player_id,
324            )
325
326        return matches[0]
327
328    @api_command("players/get_by_name")
329    def get_player_state_by_name(self, name: str) -> PlayerState | None:
330        """
331        Return PlayerState by name.
332
333        :param name: Name of the player.
334        :return: PlayerState object or None.
335        """
336        current_user = get_current_user()
337        user_filter = (
338            current_user.player_filter
339            if current_user and current_user.role != UserRole.ADMIN
340            else None
341        )
342        current_sendspin_player = get_sendspin_player_id()
343        if player := self.get_player_by_name(name):
344            if (
345                current_user
346                and user_filter
347                and player.player_id not in user_filter
348                and player.player_id != current_sendspin_player
349            ):
350                msg = f"{current_user.username} does not have access to player {player.player_id}"
351                raise InsufficientPermissions(msg)
352            return player.state
353        return None
354
355    @api_command("players/player_controls")
356    def player_controls(
357        self,
358    ) -> list[PlayerControl]:
359        """Return all registered playercontrols."""
360        return list(self._controls.values())
361
362    @api_command("players/player_control")
363    def get_player_control(
364        self,
365        control_id: str,
366    ) -> PlayerControl | None:
367        """
368        Return PlayerControl by control_id.
369
370        :param control_id: ID of the player control.
371        :return: PlayerControl object or None.
372        """
373        if control := self._controls.get(control_id):
374            return control
375        return None
376
377    @api_command("players/plugin_sources")
378    def get_plugin_sources(self) -> list[PluginSource]:
379        """Return all available plugin sources."""
380        return [
381            plugin_prov.get_source()
382            for plugin_prov in self.mass.get_providers(ProviderType.PLUGIN)
383            if isinstance(plugin_prov, PluginProvider)
384            and ProviderFeature.AUDIO_SOURCE in plugin_prov.supported_features
385        ]
386
387    @api_command("players/plugin_source")
388    def get_plugin_source(
389        self,
390        source_id: str,
391    ) -> PluginSource | None:
392        """
393        Return PluginSource by source_id.
394
395        :param source_id: ID of the plugin source.
396        :return: PluginSource object or None.
397        """
398        for plugin_prov in self.mass.get_providers(ProviderType.PLUGIN):
399            assert isinstance(plugin_prov, PluginProvider)  # for type checking
400            if ProviderFeature.AUDIO_SOURCE not in plugin_prov.supported_features:
401                continue
402            if (source := plugin_prov.get_source()) and source.id == source_id:
403                return source
404        return None
405
406    # Player commands
407
408    @api_command("players/cmd/stop")
409    @handle_player_command
410    async def cmd_stop(self, player_id: str) -> None:
411        """Send STOP command to given player.
412
413        - player_id: player_id of the player to handle the command.
414        """
415        player = self._get_player_with_redirect(player_id)
416        # Redirect to queue controller if it is active (skip if already in queue command context)
417        if not IN_QUEUE_COMMAND.get() and (active_queue := self.get_active_queue(player)):
418            await self.mass.player_queues.stop(active_queue.queue_id)
419            return
420        # Delegate to internal handler for actual implementation
421        await self._handle_cmd_stop(player.player_id)
422
423    @api_command("players/cmd/play")
424    @handle_player_command
425    async def cmd_play(self, player_id: str) -> None:
426        """Send PLAY (unpause) command to given player.
427
428        - player_id: player_id of the player to handle the command.
429        """
430        player = self._get_player_with_redirect(player_id)
431        if player.state.playback_state == PlaybackState.PLAYING:
432            self.logger.info(
433                "Ignore PLAY request to player %s: player is already playing", player.state.name
434            )
435            return
436        # player is not paused: check for queue redirect, then delegate to internal handler
437        if player.state.playback_state != PlaybackState.PAUSED:
438            source = player.state.active_source
439            if active_queue := self.mass.player_queues.get(source or player_id):
440                await self.mass.player_queues.resume(active_queue.queue_id)
441                return
442
443        # Delegate to internal handler for actual implementation
444        await self._handle_cmd_play(player.player_id)
445
446    @api_command("players/cmd/pause")
447    @handle_player_command
448    async def cmd_pause(self, player_id: str) -> None:
449        """Send PAUSE command to given player.
450
451        - player_id: player_id of the player to handle the command.
452        """
453        player = self._get_player_with_redirect(player_id)
454        # Redirect to queue controller if it is active (skip if already in queue command context)
455        if not IN_QUEUE_COMMAND.get() and (active_queue := self.get_active_queue(player)):
456            await self.mass.player_queues.pause(active_queue.queue_id)
457            return
458        # Delegate to internal handler for actual implementation
459        await self._handle_cmd_pause(player.player_id)
460
461    @api_command("players/cmd/play_pause")
462    async def cmd_play_pause(self, player_id: str) -> None:
463        """Toggle play/pause on given player.
464
465        - player_id: player_id of the player to handle the command.
466        """
467        player = self._get_player_with_redirect(player_id)
468        if player.state.playback_state == PlaybackState.PLAYING:
469            await self.cmd_pause(player.player_id)
470        else:
471            await self.cmd_play(player.player_id)
472
473    @api_command("players/cmd/resume")
474    @handle_player_command
475    async def cmd_resume(
476        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
477    ) -> None:
478        """Send RESUME command to given player.
479
480        Resume (or restart) playback on the player.
481
482        :param player_id: player_id of the player to handle the command.
483        :param source: Optional source to resume.
484        :param media: Optional media to resume.
485        """
486        await self._handle_cmd_resume(player_id, source, media)
487
488    @api_command("players/cmd/seek")
489    async def cmd_seek(self, player_id: str, position: int) -> None:
490        """Handle SEEK command for given player.
491
492        - player_id: player_id of the player to handle the command.
493        - position: position in seconds to seek to in the current playing item.
494        """
495        player = self._get_player_with_redirect(player_id)
496        # Check if a plugin source is active with a seek callback
497        if plugin_source := self._get_active_plugin_source(player):
498            if plugin_source.can_seek and plugin_source.on_seek:
499                await plugin_source.on_seek(position)
500                return
501        # Redirect to queue controller if it is active
502        if not IN_QUEUE_COMMAND.get() and (active_queue := self.get_active_queue(player)):
503            await self.mass.player_queues.seek(active_queue.queue_id, position)
504            return
505        # handle command on player/source directly
506        active_source = next((x for x in player.source_list if x.id == player.active_source), None)
507        if active_source and not active_source.can_seek:
508            msg = (
509                f"The active source ({active_source.name}) on player "
510                f"{player.display_name} does not support seeking"
511            )
512            raise PlayerCommandFailed(msg)
513        if PlayerFeature.SEEK not in player.supported_features:
514            msg = f"Player {player.display_name} does not support seeking"
515            raise UnsupportedFeaturedException(msg)
516        # handle command on player directly
517        await player.seek(position)
518
519    @api_command("players/cmd/next")
520    async def cmd_next_track(self, player_id: str) -> None:
521        """Handle NEXT TRACK command for given player."""
522        player = self._get_player_with_redirect(player_id)
523        active_source_id = player.state.active_source or player.player_id
524        # Check if a plugin source is active with a next callback
525        if plugin_source := self._get_active_plugin_source(player):
526            if plugin_source.can_next_previous and plugin_source.on_next:
527                await plugin_source.on_next()
528                return
529        # Redirect to queue controller if it is active
530        if active_queue := self.get_active_queue(player):
531            await self.mass.player_queues.next(active_queue.queue_id)
532            return
533        if PlayerFeature.NEXT_PREVIOUS in player.state.supported_features:
534            # player has some other source active and native next/previous support
535            active_source = next(
536                (x for x in player.state.source_list if x.id == active_source_id), None
537            )
538            if active_source and active_source.can_next_previous:
539                await player.next_track()
540                return
541            msg = "This action is (currently) unavailable for this source."
542            raise PlayerCommandFailed(msg)
543        # Player does not support next/previous feature
544        msg = f"Player {player.state.name} does not support skipping to the next track."
545        raise UnsupportedFeaturedException(msg)
546
547    @api_command("players/cmd/previous")
548    async def cmd_previous_track(self, player_id: str) -> None:
549        """Handle PREVIOUS TRACK command for given player."""
550        player = self._get_player_with_redirect(player_id)
551        active_source_id = player.state.active_source or player.player_id
552        # Check if a plugin source is active with a previous callback
553        if plugin_source := self._get_active_plugin_source(player):
554            if plugin_source.can_next_previous and plugin_source.on_previous:
555                await plugin_source.on_previous()
556                return
557        # Redirect to queue controller if it is active
558        if active_queue := self.get_active_queue(player):
559            await self.mass.player_queues.previous(active_queue.queue_id)
560            return
561        if PlayerFeature.NEXT_PREVIOUS in player.state.supported_features:
562            # player has some other source active and native next/previous support
563            active_source = next(
564                (x for x in player.state.source_list if x.id == active_source_id), None
565            )
566            if active_source and active_source.can_next_previous:
567                await player.previous_track()
568                return
569            msg = "This action is (currently) unavailable for this source."
570            raise PlayerCommandFailed(msg)
571        # Player does not support next/previous feature
572        msg = f"Player {player.state.name} does not support skipping to the previous track."
573        raise UnsupportedFeaturedException(msg)
574
575    @api_command("players/cmd/power")
576    @handle_player_command
577    async def cmd_power(self, player_id: str, powered: bool) -> None:
578        """Send POWER command to given player.
579
580        :param player_id: player_id of the player to handle the command.
581        :param powered: bool if player should be powered on or off.
582        """
583        await self._handle_cmd_power(player_id, powered)
584
585    @api_command("players/cmd/volume_set")
586    @handle_player_command
587    async def cmd_volume_set(self, player_id: str, volume_level: int) -> None:
588        """Send VOLUME_SET command to given player.
589
590        :param player_id: player_id of the player to handle the command.
591        :param volume_level: volume level (0..100) to set on the player.
592        """
593        await self._handle_cmd_volume_set(player_id, volume_level)
594
595    @api_command("players/cmd/volume_up")
596    @handle_player_command
597    async def cmd_volume_up(self, player_id: str) -> None:
598        """Send VOLUME_UP command to given player.
599
600        - player_id: player_id of the player to handle the command.
601        """
602        if not (player := self.get_player(player_id)):
603            return
604        current_volume = player.state.volume_level or 0
605        if current_volume < 5 or current_volume > 95:
606            step_size = 1
607        elif current_volume < 20 or current_volume > 80:
608            step_size = 2
609        else:
610            step_size = 5
611        new_volume = min(100, current_volume + step_size)
612        await self.cmd_volume_set(player_id, new_volume)
613
614    @api_command("players/cmd/volume_down")
615    @handle_player_command
616    async def cmd_volume_down(self, player_id: str) -> None:
617        """Send VOLUME_DOWN command to given player.
618
619        - player_id: player_id of the player to handle the command.
620        """
621        if not (player := self.get_player(player_id)):
622            return
623        current_volume = player.state.volume_level or 0
624        if current_volume < 5 or current_volume > 95:
625            step_size = 1
626        elif current_volume < 20 or current_volume > 80:
627            step_size = 2
628        else:
629            step_size = 5
630        new_volume = max(0, current_volume - step_size)
631        await self.cmd_volume_set(player_id, new_volume)
632
633    @api_command("players/cmd/group_volume")
634    @handle_player_command
635    async def cmd_group_volume(
636        self,
637        player_id: str,
638        volume_level: int,
639    ) -> None:
640        """
641        Handle adjusting the overall/group volume to a playergroup (or synced players).
642
643        Will set a new (overall) volume level to a group player or syncgroup.
644
645        :param player_id: Player ID of group player or syncleader to handle the command.
646        :param volume_level: Volume level (0..100) to set to the group.
647        """
648        player = self.get_player(player_id, True)
649        assert player is not None  # for type checker
650        if player.state.type == PlayerType.GROUP or player.state.group_members:
651            # dedicated group player or sync leader
652            await self.set_group_volume(player, volume_level)
653            return
654        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
655            # redirect to sync leader
656            await self.set_group_volume(sync_leader, volume_level)
657            return
658        # treat as normal player volume change
659        await self.cmd_volume_set(player_id, volume_level)
660
661    @api_command("players/cmd/group_volume_up")
662    @handle_player_command
663    async def cmd_group_volume_up(self, player_id: str) -> None:
664        """Send VOLUME_UP command to given playergroup.
665
666        - player_id: player_id of the player to handle the command.
667        """
668        group_player_state = self.get_player_state(player_id, True)
669        assert group_player_state
670        cur_volume = group_player_state.group_volume
671        if cur_volume < 5 or cur_volume > 95:
672            step_size = 1
673        elif cur_volume < 20 or cur_volume > 80:
674            step_size = 2
675        else:
676            step_size = 5
677        new_volume = min(100, cur_volume + step_size)
678        await self.cmd_group_volume(player_id, new_volume)
679
680    @api_command("players/cmd/group_volume_down")
681    @handle_player_command
682    async def cmd_group_volume_down(self, player_id: str) -> None:
683        """Send VOLUME_DOWN command to given playergroup.
684
685        - player_id: player_id of the player to handle the command.
686        """
687        group_player_state = self.get_player_state(player_id, True)
688        assert group_player_state
689        cur_volume = group_player_state.group_volume
690        if cur_volume < 5 or cur_volume > 95:
691            step_size = 1
692        elif cur_volume < 20 or cur_volume > 80:
693            step_size = 2
694        else:
695            step_size = 5
696        new_volume = max(0, cur_volume - step_size)
697        await self.cmd_group_volume(player_id, new_volume)
698
699    @api_command("players/cmd/group_volume_mute")
700    @handle_player_command
701    async def cmd_group_volume_mute(self, player_id: str, muted: bool) -> None:
702        """Send VOLUME_MUTE command to all players in a group.
703
704        - player_id: player_id of the group player or sync leader.
705        - muted: bool if group should be muted.
706        """
707        player = self.get_player(player_id, True)
708        assert player is not None  # for type checker
709        if player.state.type == PlayerType.GROUP or player.state.group_members:
710            # dedicated group player or sync leader
711            coros = []
712            for child_player in self.iter_group_members(
713                player, only_powered=True, exclude_self=False
714            ):
715                coros.append(self.cmd_volume_mute(child_player.player_id, muted))
716            await asyncio.gather(*coros)
717
718    @api_command("players/cmd/volume_mute")
719    @handle_player_command
720    async def cmd_volume_mute(self, player_id: str, muted: bool) -> None:
721        """Send VOLUME_MUTE command to given player.
722
723        - player_id: player_id of the player to handle the command.
724        - muted: bool if player should be muted.
725        """
726        player = self.get_player(player_id, True)
727        assert player
728
729        # Set/clear mute lock for players in a group
730        # This prevents auto-unmute when group volume changes
731        is_in_group = bool(player.state.synced_to or player.state.group_members)
732        if muted and is_in_group:
733            player.extra_data[ATTR_MUTE_LOCK] = True
734        elif not muted:
735            player.extra_data.pop(ATTR_MUTE_LOCK, None)
736
737        if player.volume_control == PLAYER_CONTROL_NONE:
738            raise UnsupportedFeaturedException(
739                f"Player {player.state.name} does not support muting"
740            )
741        if player.mute_control == PLAYER_CONTROL_NATIVE:
742            # player supports mute command natively: forward to player
743            await player.volume_mute(muted)
744            return
745        if player.mute_control == PLAYER_CONTROL_FAKE:
746            # user wants to use fake mute control - so we use volume instead
747            self.logger.debug(
748                "Using volume for muting for player %s",
749                player.state.name,
750            )
751            if muted:
752                player.extra_data[ATTR_PREVIOUS_VOLUME] = player.state.volume_level
753                player.extra_data[ATTR_FAKE_MUTE] = True
754                await self._handle_cmd_volume_set(player_id, 0)
755                player.update_state()
756            else:
757                prev_volume = player.extra_data.get(ATTR_PREVIOUS_VOLUME, 1)
758                player.extra_data[ATTR_FAKE_MUTE] = False
759                player.update_state()
760                await self._handle_cmd_volume_set(player_id, prev_volume)
761            return
762
763        # handle external player control
764        if player_control := self._controls.get(player.mute_control):
765            control_name = player_control.name if player_control else player.mute_control
766            self.logger.debug("Redirecting mute command to PlayerControl %s", control_name)
767            if not player_control or not player_control.supports_mute:
768                raise UnsupportedFeaturedException(
769                    f"Player control {control_name} is not available"
770                )
771            assert player_control.mute_set is not None
772            await player_control.mute_set(muted)
773            return
774
775        # handle to protocol player as volume_mute control
776        if protocol_player := self.get_player(player.state.volume_control):
777            self.logger.debug(
778                "Redirecting mute command to protocol player %s",
779                protocol_player.provider.manifest.name,
780            )
781            await self.cmd_volume_mute(protocol_player.player_id, muted)
782            return
783
784    @api_command("players/cmd/play_announcement")
785    @handle_player_command(lock=True)
786    async def play_announcement(
787        self,
788        player_id: str,
789        url: str,
790        pre_announce: bool | None = None,
791        volume_level: int | None = None,
792        pre_announce_url: str | None = None,
793    ) -> None:
794        """
795        Handle playback of an announcement (url) on given player.
796
797        :param player_id: Player ID of the player to handle the command.
798        :param url: URL of the announcement to play.
799        :param pre_announce: Optional bool if pre-announce should be used.
800        :param volume_level: Optional volume level to set for the announcement.
801        :param pre_announce_url: Optional custom URL to use for the pre-announce chime.
802        """
803        player = self.get_player(player_id, True)
804        assert player is not None  # for type checking
805        if not url.startswith("http"):
806            raise PlayerCommandFailed("Only URLs are supported for announcements")
807        if (
808            pre_announce
809            and pre_announce_url
810            and not validate_announcement_chime_url(pre_announce_url)
811        ):
812            raise PlayerCommandFailed("Invalid pre-announce chime URL specified.")
813        try:
814            # mark announcement_in_progress on player
815            player.extra_data[ATTR_ANNOUNCEMENT_IN_PROGRESS] = True
816            # determine pre-announce from (group)player config
817            if pre_announce is None and "tts" in url:
818                conf_pre_announce = self.mass.config.get_raw_player_config_value(
819                    player_id,
820                    CONF_ENTRY_TTS_PRE_ANNOUNCE.key,
821                    CONF_ENTRY_TTS_PRE_ANNOUNCE.default_value,
822                )
823                pre_announce = cast("bool", conf_pre_announce)
824            if pre_announce_url is None:
825                if conf_pre_announce_url := self.mass.config.get_raw_player_config_value(
826                    player_id,
827                    CONF_PRE_ANNOUNCE_CHIME_URL,
828                ):
829                    # player default custom chime url
830                    pre_announce_url = cast("str", conf_pre_announce_url)
831                else:
832                    # use global default chime url
833                    pre_announce_url = ANNOUNCE_ALERT_FILE
834            # if player type is group with all members supporting announcements,
835            # we forward the request to each individual player
836            if player.state.type == PlayerType.GROUP and (
837                all(
838                    PlayerFeature.PLAY_ANNOUNCEMENT in x.state.supported_features
839                    for x in self.iter_group_members(player)
840                )
841            ):
842                # forward the request to each individual player
843                async with TaskManager(self.mass) as tg:
844                    for group_member in player.state.group_members:
845                        tg.create_task(
846                            self.play_announcement(
847                                group_member,
848                                url=url,
849                                pre_announce=pre_announce,
850                                volume_level=volume_level,
851                                pre_announce_url=pre_announce_url,
852                            )
853                        )
854                return
855            self.logger.info(
856                "Playback announcement to player %s (with pre-announce: %s): %s",
857                player.state.name,
858                pre_announce,
859                url,
860            )
861            # determine if the player has native announcements support
862            # or if any linked protocol has announcement support
863            native_announce_support = False
864            if announce_player := self._get_control_target(
865                player,
866                required_feature=PlayerFeature.PLAY_ANNOUNCEMENT,
867                require_active=False,
868            ):
869                native_announce_support = True
870            else:
871                announce_player = player
872            # create a PlayerMedia object for the announcement so
873            # we can send a regular play-media call downstream
874            announce_data = AnnounceData(
875                announcement_url=url,
876                pre_announce=bool(pre_announce),
877                pre_announce_url=pre_announce_url,
878            )
879            announcement = PlayerMedia(
880                uri=self.mass.streams.get_announcement_url(player_id, announce_data=announce_data),
881                media_type=MediaType.ANNOUNCEMENT,
882                title="Announcement",
883                custom_data=dict(announce_data),
884            )
885            # handle native announce support (player or linked protocol)
886            if native_announce_support:
887                announcement_volume = self.get_announcement_volume(player_id, volume_level)
888                await announce_player.play_announcement(announcement, announcement_volume)
889                return
890            # use fallback/default implementation
891            await self._play_announcement(player, announcement, volume_level)
892        finally:
893            player.extra_data[ATTR_ANNOUNCEMENT_IN_PROGRESS] = False
894
895    @handle_player_command(lock=True)
896    async def play_media(self, player_id: str, media: PlayerMedia) -> None:
897        """Handle PLAY MEDIA on given player.
898
899        - player_id: player_id of the player to handle the command.
900        - media: The Media that needs to be played on the player.
901        """
902        player = self._get_player_with_redirect(player_id)
903        # Delegate to internal handler for actual implementation
904        await self._handle_play_media(player.player_id, media)
905
906    @api_command("players/cmd/select_sound_mode")
907    @handle_player_command
908    async def select_sound_mode(self, player_id: str, sound_mode: str) -> None:
909        """
910        Handle SELECT SOUND MODE command on given player.
911
912        - player_id: player_id of the player to handle the command
913        - sound_mode: The ID of the sound mode that needs to be activated/selected.
914        """
915        player = self.get_player(player_id, True)
916        assert player is not None  # for type checking
917
918        if PlayerFeature.SELECT_SOUND_MODE not in player.supported_features:
919            raise UnsupportedFeaturedException(
920                f"Player {player.display_name} does not support sound mode selection"
921            )
922
923        prev_sound_mode = player.active_sound_mode
924        if sound_mode == prev_sound_mode:
925            return
926
927        # basic check if sound mode is valid for player
928        if not any(x for x in player.sound_mode_list if x.id == sound_mode):
929            raise PlayerCommandFailed(
930                f"{sound_mode} is an invalid sound_mode for player {player.display_name}"
931            )
932
933        # forward to player
934        await player.select_sound_mode(sound_mode)
935
936    @api_command("players/cmd/set_option")
937    @handle_player_command
938    async def set_option(
939        self, player_id: str, option_key: str, option_value: PlayerOptionValueType
940    ) -> None:
941        """
942        Handle SET_OPTION command on given player.
943
944        - player_id: player_id of the player to handle the command
945        - option_key: The key of the player option that needs to be activated/selected.
946        - option_value: The new value of the player option.
947        """
948        player = self.get_player(player_id, True)
949        assert player is not None  # for type checking
950
951        if PlayerFeature.OPTIONS not in player.supported_features:
952            raise UnsupportedFeaturedException(
953                f"Player {player.display_name} does not support set_option"
954            )
955
956        prev_player_option = next((x for x in player.options if x.key == option_key), None)
957        if not prev_player_option:
958            return
959        if prev_player_option.value == option_value:
960            return
961
962        if prev_player_option.read_only:
963            raise UnsupportedFeaturedException(
964                f"Player {player.display_name} option {option_key} is read-only"
965            )
966
967        # forward to player
968        await player.set_option(option_key=option_key, option_value=option_value)
969
970    @api_command("players/cmd/select_source")
971    @handle_player_command
972    async def select_source(self, player_id: str, source: str | None) -> None:
973        """
974        Handle SELECT SOURCE command on given player.
975
976        - player_id: player_id of the player to handle the command.
977        - source: The ID of the source that needs to be activated/selected.
978        """
979        if source is None:
980            source = player_id  # default to MA queue source
981        player = self.get_player(player_id, True)
982        assert player is not None  # for type checking
983        # Check if player is currently grouped (reject for public API)
984        if player.state.synced_to or player.state.active_group:
985            raise PlayerCommandFailed(f"Player {player.state.name} is currently grouped")
986        # Delegate to internal handler for actual implementation
987        await self._handle_select_source(player_id, source)
988
989    @handle_player_command(lock=True)
990    async def enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
991        """
992        Handle enqueuing of a next media item on the player.
993
994        :param player_id: player_id of the player to handle the command.
995        :param media: The Media that needs to be enqueued on the player.
996        :raises UnsupportedFeaturedException: if the player does not support enqueueing.
997        :raises PlayerUnavailableError: if the player is not available.
998        """
999        # Note: No group redirect needed here as enqueue doesn't use _get_player_with_redirect
1000        # Delegate to internal handler for actual implementation
1001        await self._handle_enqueue_next_media(player_id, media)
1002
1003    @api_command("players/cmd/set_members")
1004    @handle_player_command(lock=True)
1005    async def cmd_set_members(
1006        self,
1007        target_player: str,
1008        player_ids_to_add: list[str] | None = None,
1009        player_ids_to_remove: list[str] | None = None,
1010    ) -> None:
1011        """
1012        Join/unjoin given player(s) to/from target player.
1013
1014        Will add the given player(s) to the target player (sync leader or group player).
1015
1016        :param target_player: player_id of the syncgroup leader or group player.
1017        :param player_ids_to_add: List of player_id's to add to the target player.
1018        :param player_ids_to_remove: List of player_id's to remove from the target player.
1019
1020        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1021        :raises PlayerUnavailableError: if the target player is not available.
1022        """
1023        parent_player: Player | None = self.get_player(target_player, True)
1024        assert parent_player is not None  # for type checking
1025        if PlayerFeature.SET_MEMBERS not in parent_player.state.supported_features:
1026            msg = f"Player {parent_player.name} does not support group commands"
1027            raise UnsupportedFeaturedException(msg)
1028
1029        # guard edge case: player already synced to another player
1030        if parent_player.state.synced_to:
1031            raise PlayerCommandFailed(
1032                f"Player {parent_player.name} is already synced to another player on its own, "
1033                "you need to ungroup it first before you can join other players to it.",
1034            )
1035        # handle dissolve sync group if the target player is currently
1036        # a sync leader and is being removed from itself
1037        should_stop = False
1038        if player_ids_to_remove and target_player in player_ids_to_remove:
1039            self.logger.info(
1040                "Dissolving sync group of player %s as it is being removed from itself",
1041                parent_player.name,
1042            )
1043            player_ids_to_add = None
1044            player_ids_to_remove = [
1045                x for x in parent_player.state.group_members if x != target_player
1046            ]
1047            should_stop = True
1048        # filter all player ids on compatibility and availability
1049        final_player_ids_to_add: list[str] = []
1050        for child_player_id in player_ids_to_add or []:
1051            if child_player_id == target_player:
1052                continue
1053            if child_player_id in final_player_ids_to_add:
1054                continue
1055            if (
1056                not (child_player := self.get_player(child_player_id))
1057                or not child_player.state.available
1058            ):
1059                self.logger.warning("Player %s is not available", child_player_id)
1060                continue
1061
1062            # check if player can be synced/grouped with the target player
1063            # state.can_group_with already handles all expansion and translation
1064            if child_player_id not in parent_player.state.can_group_with:
1065                self.logger.warning(
1066                    "Player %s can not be grouped with %s",
1067                    child_player.name,
1068                    parent_player.name,
1069                )
1070                continue
1071
1072            if (
1073                child_player.state.synced_to
1074                and child_player.state.synced_to == target_player
1075                and child_player_id in parent_player.state.group_members
1076            ):
1077                continue  # already synced to this target
1078
1079            # power on the player if needed
1080            if (
1081                not child_player.state.powered
1082                and child_player.state.power_control != PLAYER_CONTROL_NONE
1083            ):
1084                await self._handle_cmd_power(child_player.player_id, True)
1085            # if we reach here, all checks passed
1086            final_player_ids_to_add.append(child_player_id)
1087
1088        # process player ids to remove and filter out invalid/unavailable players and edge cases
1089        final_player_ids_to_remove: list[str] = []
1090        if player_ids_to_remove:
1091            for child_player_id in player_ids_to_remove:
1092                if child_player_id not in parent_player.state.group_members:
1093                    continue
1094                final_player_ids_to_remove.append(child_player_id)
1095
1096        # Forward command to the appropriate player after all (base) sanity checks
1097        # GROUP players (sync_group, universal_group) manage their own members internally
1098        # and don't need protocol translation - call their set_members directly
1099        if parent_player.type == PlayerType.GROUP:
1100            await parent_player.set_members(
1101                player_ids_to_add=final_player_ids_to_add,
1102                player_ids_to_remove=final_player_ids_to_remove,
1103            )
1104            return
1105        # For regular players, handle protocol selection and translation
1106        # Store playback state before changing members to detect protocol changes
1107        was_playing = parent_player.playback_state in (
1108            PlaybackState.PLAYING,
1109            PlaybackState.PAUSED,
1110        )
1111        previous_protocol = parent_player.active_output_protocol if was_playing else None
1112
1113        await self._handle_set_members_with_protocols(
1114            parent_player, final_player_ids_to_add, final_player_ids_to_remove
1115        )
1116
1117        if should_stop:
1118            # Stop playback on the player if it is being removed from itself
1119            await self._handle_cmd_stop(parent_player.player_id)
1120            return
1121
1122        # Check if protocol changed due to member change and restart playback if needed
1123        if not should_stop and was_playing:
1124            # Determine which protocol would be used now with new members
1125            _new_target_player, new_protocol = self._select_best_output_protocol(parent_player)
1126            new_protocol_id = new_protocol.output_protocol_id if new_protocol else "native"
1127            previous_protocol_id = previous_protocol or "native"
1128
1129            # If protocol changed, restart playback
1130            if new_protocol_id != previous_protocol_id:
1131                self.logger.info(
1132                    "Protocol changed from %s to %s due to member change, restarting playback",
1133                    previous_protocol_id,
1134                    new_protocol_id,
1135                )
1136                # Restart playback on the new protocol using resume
1137                await self.cmd_resume(
1138                    parent_player.player_id,
1139                    parent_player.state.active_source,
1140                    parent_player.state.current_media,
1141                )
1142
1143    @api_command("players/cmd/group")
1144    @handle_player_command
1145    async def cmd_group(self, player_id: str, target_player: str) -> None:
1146        """Handle GROUP command for given player.
1147
1148        Join/add the given player(id) to the given (leader) player/sync group.
1149        If the target player itself is already synced to another player, this may fail.
1150        If the player can not be synced with the given target player, this may fail.
1151
1152        NOTE: This is a convenience helper for cmd_set_members.
1153
1154        :param player_id: player_id of the player to handle the command.
1155        :param target_player: player_id of the syncgroup leader or group player.
1156
1157        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1158        :raises PlayerCommandFailed: if the target player is already synced to another player.
1159        :raises PlayerUnavailableError: if the target player is not available.
1160        :raises PlayerCommandFailed: if the player is already grouped to another player.
1161        """
1162        await self.cmd_set_members(target_player, player_ids_to_add=[player_id])
1163
1164    @api_command("players/cmd/group_many")
1165    async def cmd_group_many(self, target_player: str, child_player_ids: list[str]) -> None:
1166        """
1167        Join given player(s) to target player.
1168
1169        Will add the given player(s) to the target player (sync leader or group player).
1170        This is a (deprecated) alias for cmd_set_members.
1171        """
1172        await self.cmd_set_members(target_player, player_ids_to_add=child_player_ids)
1173
1174    @api_command("players/cmd/ungroup")
1175    @handle_player_command
1176    async def cmd_ungroup(self, player_id: str) -> None:
1177        """
1178        Handle UNGROUP command for given player.
1179
1180        Remove the given player from any (sync)groups it currently is synced to.
1181        If the player is not currently grouped to any other player,
1182        this will silently be ignored.
1183
1184        NOTE: This is a convenience helper for cmd_set_members.
1185        """
1186        if not (player := self.get_player(player_id)):
1187            self.logger.warning("Player %s is not available", player_id)
1188            return
1189
1190        if player.state.active_group:
1191            # the player is part of a (permanent) groupplayer and the user tries to ungroup
1192            await self.cmd_set_members(player.state.active_group, player_ids_to_remove=[player_id])
1193            return
1194
1195        if player.state.synced_to:
1196            # player is a sync member
1197            await self.cmd_set_members(player.state.synced_to, player_ids_to_remove=[player_id])
1198            return
1199
1200        if player.state.group_members:
1201            # player is a sync leader, so we ungroup all members from it
1202            await self.cmd_set_members(
1203                player.player_id, player_ids_to_remove=player.state.group_members
1204            )
1205            return
1206
1207    @api_command("players/cmd/ungroup_many")
1208    async def cmd_ungroup_many(self, player_ids: list[str]) -> None:
1209        """Handle UNGROUP command for all the given players."""
1210        for player_id in list(player_ids):
1211            await self.cmd_ungroup(player_id)
1212
1213    @api_command("players/create_group_player", required_role="admin")
1214    async def create_group_player(
1215        self, provider: str, name: str, members: list[str], dynamic: bool = True
1216    ) -> Player:
1217        """
1218        Create a new (permanent) Group Player.
1219
1220        :param provider: The provider (id) to create the group player for.
1221        :param name: Name of the new group player.
1222        :param members: List of player ids to add to the group.
1223        :param dynamic: Whether the group is dynamic (members can change).
1224        """
1225        if not (provider_instance := self.mass.get_provider(provider)):
1226            raise ProviderUnavailableError(f"Provider {provider} not found")
1227        provider_instance = cast("PlayerProvider", provider_instance)
1228        if ProviderFeature.CREATE_GROUP_PLAYER not in provider_instance.supported_features:
1229            raise UnsupportedFeaturedException(
1230                f"Provider {provider} does not support creating group players"
1231            )
1232        return await provider_instance.create_group_player(name, members, dynamic)
1233
1234    @api_command("players/remove_group_player", required_role="admin")
1235    async def remove_group_player(self, player_id: str) -> None:
1236        """Remove a group player."""
1237        if not (player := self.get_player(player_id)):
1238            # we simply permanently delete the player by wiping its config
1239            self.mass.config.remove(f"players/{player_id}")
1240            return
1241        if player.state.type != PlayerType.GROUP:
1242            raise UnsupportedFeaturedException(f"Player {player.state.name} is not a group player")
1243        player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1244        await player.provider.remove_group_player(player_id)
1245
1246    @api_command("players/add_currently_playing_to_favorites")
1247    async def add_currently_playing_to_favorites(self, player_id: str) -> None:
1248        """
1249        Add the currently playing item/track on given player to the favorites.
1250
1251        This tries to resolve the currently playing media to an actual media item
1252        and add that to the favorites in the library. Will raise an error if the
1253        player is not currently playing anything or if the currently playing media
1254        can not be resolved to a media item.
1255        """
1256        player = self._get_player_with_redirect(player_id)
1257        # handle mass player queue active
1258        if mass_queue := self.get_active_queue(player):
1259            if not (current_item := mass_queue.current_item) or not current_item.media_item:
1260                raise PlayerCommandFailed("No current item to add to favorites")
1261            # if we're playing a radio station, try to resolve the currently playing track
1262            if current_item.media_item.media_type == MediaType.RADIO:
1263                if not (
1264                    (streamdetails := mass_queue.current_item.streamdetails)
1265                    and (stream_title := streamdetails.stream_title)
1266                    and " - " in stream_title
1267                ):
1268                    # no stream title available, so we can't resolve the track
1269                    # this can happen if the radio station does not provide metadata
1270                    # or there's a commercial break
1271                    # Possible future improvement could be to actually detect the song with a
1272                    # shazam-like approach.
1273                    raise PlayerCommandFailed("No current item to add to favorites")
1274                # send the streamtitle into a global search query
1275                search_artist, search_title_title = stream_title.split(" - ", 1)
1276                # strip off any additional comments in the title (such as from Radio Paradise)
1277                search_title_title = search_title_title.split(" | ")[0].strip()
1278                if track := await self.mass.music.get_track_by_name(
1279                    search_title_title, search_artist
1280                ):
1281                    # we found a track, so add it to the favorites
1282                    await self.mass.music.add_item_to_favorites(track)
1283                    return
1284                # we could not resolve the track, so raise an error
1285                raise PlayerCommandFailed("No current item to add to favorites")
1286
1287            # else: any other media item, just add it to the favorites directly
1288            await self.mass.music.add_item_to_favorites(current_item.media_item)
1289            return
1290
1291        # guard for player with no active source
1292        if not player.state.active_source:
1293            raise PlayerCommandFailed("Player has no active source")
1294        # handle other source active using the current_media with uri
1295        if current_media := player.state.current_media:
1296            # prefer the uri of the current media item
1297            if current_media.uri:
1298                with suppress(MusicAssistantError):
1299                    await self.mass.music.add_item_to_favorites(current_media.uri)
1300                    return
1301            # fallback to search based on artist and title (and album if available)
1302            if current_media.artist and current_media.title:
1303                if track := await self.mass.music.get_track_by_name(
1304                    current_media.title,
1305                    current_media.artist,
1306                    current_media.album,
1307                ):
1308                    # we found a track, so add it to the favorites
1309                    await self.mass.music.add_item_to_favorites(track)
1310                    return
1311        # if we reach here, we could not resolve the currently playing item
1312        raise PlayerCommandFailed("No current item to add to favorites")
1313
1314    async def register(self, player: Player) -> None:
1315        """Register a player on the Player Controller."""
1316        if self.mass.closing:
1317            return
1318
1319        # Use lock to prevent race conditions during concurrent player registrations
1320        async with self._register_lock:
1321            player_id = player.player_id
1322
1323            if player_id in self._players:
1324                msg = f"Player {player_id} is already registered!"
1325                raise AlreadyRegisteredError(msg)
1326
1327            # ignore disabled players
1328            if not player.state.enabled:
1329                return
1330
1331            # register throttler for this player
1332            self._player_throttlers[player_id] = Throttler(1, 0.05)
1333
1334            # restore 'fake' power state from cache if available
1335            cached_value = await self.mass.cache.get(
1336                key=player.player_id,
1337                provider=self.domain,
1338                category=CACHE_CATEGORY_PLAYER_POWER,
1339                default=False,
1340            )
1341            if cached_value is not None:
1342                player.extra_data[ATTR_FAKE_POWER] = cached_value
1343
1344            # finally actually register it
1345            self._players[player_id] = player
1346            # update state without signaling event first (ensure all attributes are set)
1347            player.update_state(signal_event=False)
1348
1349            # ensure we fetch and set the latest/full config for the player
1350            player_config = await self.mass.config.get_player_config(player_id)
1351            player.set_config(player_config)
1352            # call hook after the player is registered and config is set
1353            await player.on_config_updated()
1354
1355            # Handle protocol linking
1356            # First enrich identifiers with real MAC (resolves virtual MACs via ARP)
1357            await self._enrich_player_identifiers(player)
1358            self._evaluate_protocol_links(player)
1359
1360            self.logger.info(
1361                "Player (type %s) registered: %s/%s",
1362                player.state.type.value,
1363                player_id,
1364                player.state.name,
1365            )
1366            # signal event that a player was added
1367
1368            if player.state.type != PlayerType.PROTOCOL:
1369                self.mass.signal_event(
1370                    EventType.PLAYER_ADDED, object_id=player.player_id, data=player
1371                )
1372
1373            # register playerqueue for this player
1374            # Skip if this is a protocol player pending evaluation (queue created when promoted)
1375            if (
1376                player.state.type != PlayerType.PROTOCOL
1377                and player.player_id not in self._pending_protocol_evaluations
1378            ):
1379                await self.mass.player_queues.on_player_register(player)
1380
1381        # always call update to fix special attributes like display name, group volume etc.
1382        player.update_state()
1383
1384        # Schedule debounced update of all players since can_group_with values may change
1385        # when a new player is added (provider IDs expand to include the new player)
1386        self._schedule_update_all_players()
1387
1388    async def register_or_update(self, player: Player) -> None:
1389        """Register a new player on the controller or update existing one."""
1390        if self.mass.closing:
1391            return
1392
1393        if player.player_id in self._players:
1394            self._players[player.player_id] = player
1395            player.update_state()
1396            # Also schedule update when replacing existing player
1397            self._schedule_update_all_players()
1398            return
1399
1400        await self.register(player)
1401
1402    def trigger_player_update(
1403        self, player_id: str, force_update: bool = False, debounce_delay: float = 0.25
1404    ) -> None:
1405        """Trigger a (debounced) update for the given player."""
1406        if self.mass.closing:
1407            return
1408        if not (player := self.get_player(player_id)):
1409            return
1410        task_id = f"player_update_state_{player_id}"
1411        self.mass.call_later(
1412            debounce_delay,
1413            player.update_state,
1414            force_update=force_update,
1415            task_id=task_id,
1416        )
1417
1418    async def unregister(self, player_id: str, permanent: bool = False) -> None:
1419        """
1420        Unregister a player from the player controller.
1421
1422        Called (by a PlayerProvider) when a player is removed or no longer available
1423        (for a longer period of time). This will remove the player from the player
1424        controller and optionally remove the player's config from the mass config.
1425        If the player is not registered, this will silently be ignored.
1426
1427        :param player_id: Player ID of the player to unregister.
1428        :param permanent: If True, remove the player permanently by deleting its config.
1429                          If False, the player config will not be removed.
1430        """
1431        player = self._players.get(player_id)
1432        if player is None:
1433            return
1434        await self._cleanup_player_memberships(player_id)
1435        del self._players[player_id]
1436        self.mass.player_queues.on_player_remove(player_id, permanent=permanent)
1437        await player.on_unload()
1438        if permanent:
1439            # player permanent removal: cleanup protocol links, delete config
1440            # and signal PLAYER_REMOVED event
1441            self._cleanup_protocol_links(player)
1442            self.delete_player_config(player_id)
1443            self.logger.info("Player removed: %s", player.name)
1444            if player.state.type != PlayerType.PROTOCOL:
1445                self.mass.signal_event(EventType.PLAYER_REMOVED, player_id)
1446        else:
1447            # temporary unavailable: mark player as unavailable
1448            # note: the player will be re-registered later if it comes back online
1449            player.state.available = False
1450            self.logger.info("Player unavailable: %s", player.name)
1451            if player.state.type != PlayerType.PROTOCOL:
1452                self.mass.signal_event(
1453                    EventType.PLAYER_UPDATED, object_id=player.player_id, data=player.state
1454                )
1455        # Schedule debounced update of all players since can_group_with values may change
1456        self._schedule_update_all_players()
1457
1458    @api_command("players/remove", required_role="admin")
1459    async def remove(self, player_id: str) -> None:
1460        """
1461        Remove a player from a provider.
1462
1463        Can only be called when a PlayerProvider supports ProviderFeature.REMOVE_PLAYER.
1464        """
1465        player = self.get_player(player_id)
1466        if player is None:
1467            # we simply permanently delete the player config since it is not registered
1468            self.delete_player_config(player_id)
1469            return
1470        if player.state.type == PlayerType.GROUP:
1471            # Handle group player removal
1472            player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1473            await player.provider.remove_group_player(player_id)
1474            return
1475        player.provider.check_feature(ProviderFeature.REMOVE_PLAYER)
1476        await player.provider.remove_player(player_id)
1477        # check for group memberships that need to be updated
1478        if player.state.active_group and (
1479            group_player := self.mass.players.get_player(player.state.active_group)
1480        ):
1481            # try to remove from the group
1482            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1483                await group_player.set_members(
1484                    player_ids_to_remove=[player_id],
1485                )
1486        # We removed the player and can now clean up its config
1487        self.delete_player_config(player_id)
1488
1489    def delete_player_config(self, player_id: str) -> None:
1490        """
1491        Permanently delete a player's configuration.
1492
1493        Should only be called for players that are not registered by the player controller.
1494        """
1495        # we simply permanently delete the player by wiping its config
1496        conf_key = f"{CONF_PLAYERS}/{player_id}"
1497        dsp_conf_key = f"{CONF_PLAYER_DSP}/{player_id}"
1498        for key in (conf_key, dsp_conf_key):
1499            self.mass.config.remove(key)
1500
1501    def signal_player_state_update(
1502        self,
1503        player: Player,
1504        changed_values: dict[str, tuple[Any, Any]],
1505        force_update: bool = False,
1506        skip_forward: bool = False,
1507    ) -> None:
1508        """
1509        Signal a player state update.
1510
1511        Called by a Player when its state has changed.
1512        This will update the player state in the controller and signal the event bus.
1513        """
1514        player_id = player.player_id
1515        if self.mass.closing:
1516            return
1517
1518        # ignore updates for disabled players
1519        if not player.state.enabled and ATTR_ENABLED not in changed_values:
1520            return
1521
1522        if len(changed_values) == 0 and not force_update:
1523            # nothing changed
1524            return
1525
1526        # always signal update to the playerqueue
1527        if player.state.type != PlayerType.PROTOCOL:
1528            self.mass.player_queues.on_player_update(player, changed_values)
1529
1530        # to prevent spamming the eventbus on small changes (e.g. elapsed time),
1531        # we check if there are only changes in the elapsed time
1532        clean_changed_keys = set(changed_values.keys()) - {"current_media.elapsed_time"}
1533        if clean_changed_keys == {ATTR_ELAPSED_TIME} and not force_update:
1534            # ignore small changes in elapsed time
1535            prev_value = changed_values[ATTR_ELAPSED_TIME][0] or 0
1536            new_value = changed_values[ATTR_ELAPSED_TIME][1] or 0
1537            if abs(prev_value - new_value) < 5:
1538                return
1539
1540        # handle DSP reload of the leader when grouping/ungrouping
1541        if ATTR_GROUP_MEMBERS in changed_values:
1542            prev_group_members, new_group_members = changed_values[ATTR_GROUP_MEMBERS]
1543            self._handle_group_dsp_change(player, prev_group_members or [], new_group_members)
1544
1545        if ATTR_GROUP_MEMBERS in changed_values:
1546            # Removed group members also need to be updated since they are no longer part
1547            # of this group and are available for playback again
1548            prev_group_members = changed_values[ATTR_GROUP_MEMBERS][0] or []
1549            new_group_members = changed_values[ATTR_GROUP_MEMBERS][1] or []
1550            removed_members = set(prev_group_members) - set(new_group_members)
1551            for _removed_player_id in removed_members:
1552                if removed_player := self.get_player(_removed_player_id):
1553                    removed_player.update_state()
1554
1555        # Handle external source takeover - detect when active_source changes to
1556        # something external while we have a grouped protocol active
1557        if ATTR_ACTIVE_SOURCE in changed_values:
1558            prev_source, new_source = changed_values[ATTR_ACTIVE_SOURCE]
1559            task_id = f"external_source_takeover_{player_id}"
1560            self.mass.call_later(
1561                3,
1562                self._handle_external_source_takeover,
1563                player,
1564                prev_source,
1565                new_source,
1566                task_id=task_id,
1567            )
1568        became_inactive = False
1569        if ATTR_AVAILABLE in changed_values:
1570            became_inactive = changed_values[ATTR_AVAILABLE][1] is False
1571        if not became_inactive and ATTR_ENABLED in changed_values:
1572            became_inactive = changed_values[ATTR_ENABLED][1] is False
1573        if became_inactive and (player.state.active_group or player.state.synced_to):
1574            self.mass.create_task(self._cleanup_player_memberships(player.player_id))
1575
1576        # signal player update on the eventbus
1577        if player.state.type != PlayerType.PROTOCOL:
1578            self.mass.signal_event(EventType.PLAYER_UPDATED, object_id=player_id, data=player)
1579
1580        # signal a separate PlayerOptionsUpdated event
1581        if options := changed_values.get("options"):
1582            self.mass.signal_event(
1583                EventType.PLAYER_OPTIONS_UPDATED, object_id=player_id, data=options
1584            )
1585
1586        if skip_forward and not force_update:
1587            return
1588
1589        # update/signal group player(s) child's when group updates
1590        for child_player in self.iter_group_members(player, exclude_self=True):
1591            self.trigger_player_update(child_player.player_id)
1592        # update/signal group player(s) when child updates
1593        for group_player in self._get_player_groups(player, powered_only=False):
1594            self.trigger_player_update(group_player.player_id)
1595        # update/signal manually synced to player when child updates
1596        if (synced_to := player.state.synced_to) and (
1597            synced_to_player := self.get_player(synced_to)
1598        ):
1599            self.trigger_player_update(synced_to_player.player_id)
1600        # update/signal active groups when a group member updates
1601        if (active_group := player.state.active_group) and (
1602            active_group_player := self.get_player(active_group)
1603        ):
1604            self.trigger_player_update(active_group_player.player_id)
1605        # If this is a protocol player, forward the state update to the parent player
1606        if player.protocol_parent_id and (
1607            parent_player := self.mass.players.get_player(player.protocol_parent_id)
1608        ):
1609            self.trigger_player_update(parent_player.player_id)
1610        # If this is a parent player with linked protocols, forward state updates
1611        # to linked protocol players so their state reflects parent dependencies
1612        if player.state.type != PlayerType.PROTOCOL and player.linked_output_protocols:
1613            for linked in player.linked_output_protocols:
1614                if protocol_player := self.mass.players.get_player(linked.output_protocol_id):
1615                    self.mass.players.trigger_player_update(protocol_player.player_id)
1616        # trigger update of all players in a provider if group related fields changed
1617        if any(key in changed_values for key in ("group_members", "synced_to", "available")):
1618            for prov_player in player.provider.players:
1619                self.trigger_player_update(prov_player.player_id)
1620
1621    async def register_player_control(self, player_control: PlayerControl) -> None:
1622        """Register a new PlayerControl on the controller."""
1623        if self.mass.closing:
1624            return
1625        control_id = player_control.id
1626
1627        if control_id in self._controls:
1628            msg = f"PlayerControl {control_id} is already registered"
1629            raise AlreadyRegisteredError(msg)
1630
1631        # make sure that the playercontrol's provider is set to the instance_id
1632        prov = self.mass.get_provider(player_control.provider)
1633        if not prov or prov.instance_id != player_control.provider:
1634            raise RuntimeError(f"Invalid provider ID given: {player_control.provider}")
1635
1636        self._controls[control_id] = player_control
1637
1638        self.logger.info(
1639            "PlayerControl registered: %s/%s",
1640            control_id,
1641            player_control.name,
1642        )
1643
1644        # always call update to update any attached players etc.
1645        self.update_player_control(player_control.id)
1646
1647    async def register_or_update_player_control(self, player_control: PlayerControl) -> None:
1648        """Register a new playercontrol on the controller or update existing one."""
1649        if self.mass.closing:
1650            return
1651        if player_control.id in self._controls:
1652            self._controls[player_control.id] = player_control
1653            self.update_player_control(player_control.id)
1654            return
1655        await self.register_player_control(player_control)
1656
1657    def update_player_control(self, control_id: str) -> None:
1658        """Update playercontrol state."""
1659        if self.mass.closing:
1660            return
1661        # update all players that are using this control
1662        for player in list(self._players.values()):
1663            if control_id in (
1664                player.state.power_control,
1665                player.state.volume_control,
1666                player.state.mute_control,
1667            ):
1668                self.mass.loop.call_soon(player.update_state)
1669
1670    def remove_player_control(self, control_id: str) -> None:
1671        """Remove a player_control from the player manager."""
1672        control = self._controls.pop(control_id, None)
1673        if control is None:
1674            return
1675        self._controls.pop(control_id, None)
1676        self.logger.info("PlayerControl removed: %s", control.name)
1677
1678    def get_player_provider(self, player_id: str) -> PlayerProvider:
1679        """Return PlayerProvider for given player."""
1680        player = self._players[player_id]
1681        assert player  # for type checker
1682        return player.provider
1683
1684    def get_active_queue(self, player: Player) -> PlayerQueue | None:
1685        """Return the current active queue for a player (if any)."""
1686        # account for player that is synced (sync child)
1687        if player.synced_to and player.synced_to != player.player_id:
1688            if sync_leader := self.get_player(player.synced_to):
1689                return self.get_active_queue(sync_leader)
1690        # handle active group player
1691        if player.state.active_group and player.state.active_group != player.player_id:
1692            if group_player := self.get_player(player.state.active_group):
1693                return self.get_active_queue(group_player)
1694        # active_source may be filled queue id (or None)
1695        active_source = player.state.active_source or player.player_id
1696        if active_queue := self.mass.player_queues.get(active_source):
1697            return active_queue
1698        # handle active protocol player with parent player queue
1699        if player.type == PlayerType.PROTOCOL and player.protocol_parent_id:
1700            if parent_player := self.mass.players.get_player(player.protocol_parent_id):
1701                return self.get_active_queue(parent_player)
1702        return None
1703
1704    async def set_group_volume(self, group_player: Player, volume_level: int) -> None:
1705        """Handle adjusting the overall/group volume to a playergroup (or synced players)."""
1706        cur_volume = group_player.state.group_volume
1707        volume_dif = volume_level - cur_volume
1708        coros = []
1709        # handle group volume by only applying the volume to powered members
1710        for child_player in self.iter_group_members(
1711            group_player, only_powered=True, exclude_self=False
1712        ):
1713            if child_player.state.volume_control == PLAYER_CONTROL_NONE:
1714                continue
1715            cur_child_volume = child_player.state.volume_level or 0
1716            new_child_volume = int(cur_child_volume + volume_dif)
1717            new_child_volume = max(0, new_child_volume)
1718            new_child_volume = min(100, new_child_volume)
1719            # Use private method to skip permission check - already validated on group
1720            # ATTR_MUTE_LOCK on muted players prevents auto-unmute during group volume changes
1721            coros.append(self._handle_cmd_volume_set(child_player.player_id, new_child_volume))
1722        await asyncio.gather(*coros)
1723
1724    def get_announcement_volume(self, player_id: str, volume_override: int | None) -> int | None:
1725        """Get the (player specific) volume for a announcement."""
1726        volume_strategy = self.mass.config.get_raw_player_config_value(
1727            player_id,
1728            CONF_ENTRY_ANNOUNCE_VOLUME_STRATEGY.key,
1729            CONF_ENTRY_ANNOUNCE_VOLUME_STRATEGY.default_value,
1730        )
1731        volume_strategy_volume = self.mass.config.get_raw_player_config_value(
1732            player_id,
1733            CONF_ENTRY_ANNOUNCE_VOLUME.key,
1734            CONF_ENTRY_ANNOUNCE_VOLUME.default_value,
1735        )
1736        if volume_strategy == "none":
1737            return None
1738        volume_level = volume_override
1739        if volume_level is None and volume_strategy == "absolute":
1740            volume_level = int(cast("float", volume_strategy_volume))
1741        elif volume_level is None and volume_strategy == "relative":
1742            if (player := self.get_player(player_id)) and player.state.volume_level is not None:
1743                volume_level = int(
1744                    player.state.volume_level + cast("float", volume_strategy_volume)
1745                )
1746        elif volume_level is None and volume_strategy == "percentual":
1747            if (player := self.get_player(player_id)) and player.state.volume_level is not None:
1748                percentual = (player.state.volume_level / 100) * cast(
1749                    "float", volume_strategy_volume
1750                )
1751                volume_level = int(player.state.volume_level + percentual)
1752        if volume_level is not None:
1753            announce_volume_min = cast(
1754                "float",
1755                self.mass.config.get_raw_player_config_value(
1756                    player_id,
1757                    CONF_ENTRY_ANNOUNCE_VOLUME_MIN.key,
1758                    CONF_ENTRY_ANNOUNCE_VOLUME_MIN.default_value,
1759                ),
1760            )
1761            volume_level = max(int(announce_volume_min), volume_level)
1762            announce_volume_max = cast(
1763                "float",
1764                self.mass.config.get_raw_player_config_value(
1765                    player_id,
1766                    CONF_ENTRY_ANNOUNCE_VOLUME_MAX.key,
1767                    CONF_ENTRY_ANNOUNCE_VOLUME_MAX.default_value,
1768                ),
1769            )
1770            volume_level = min(int(announce_volume_max), volume_level)
1771        return None if volume_level is None else int(volume_level)
1772
1773    def iter_group_members(
1774        self,
1775        group_player: Player,
1776        only_powered: bool = False,
1777        only_playing: bool = False,
1778        active_only: bool = False,
1779        exclude_self: bool = True,
1780    ) -> Iterator[Player]:
1781        """Get (child) players attached to a group player or syncgroup."""
1782        for child_id in list(group_player.state.group_members):
1783            if child_player := self.get_player(child_id, False):
1784                if not child_player.state.available or not child_player.state.enabled:
1785                    continue
1786                if only_powered and child_player.state.powered is False:
1787                    continue
1788                if active_only and child_player.state.active_group != group_player.player_id:
1789                    continue
1790                if exclude_self and child_player.player_id == group_player.player_id:
1791                    continue
1792                if only_playing and child_player.state.playback_state not in (
1793                    PlaybackState.PLAYING,
1794                    PlaybackState.PAUSED,
1795                ):
1796                    continue
1797                yield child_player
1798
1799    async def wait_for_state(
1800        self,
1801        player: Player,
1802        wanted_state: PlaybackState,
1803        timeout: float = 60.0,
1804        minimal_time: float = 0,
1805    ) -> None:
1806        """Wait for the given player to reach the given state."""
1807        start_timestamp = time.time()
1808        self.logger.debug(
1809            "Waiting for player %s to reach state %s", player.state.name, wanted_state
1810        )
1811        try:
1812            async with asyncio.timeout(timeout):
1813                while player.state.playback_state != wanted_state:
1814                    await asyncio.sleep(0.1)
1815
1816        except TimeoutError:
1817            self.logger.debug(
1818                "Player %s did not reach state %s within the timeout of %s seconds",
1819                player.state.name,
1820                wanted_state,
1821                timeout,
1822            )
1823        elapsed_time = round(time.time() - start_timestamp, 2)
1824        if elapsed_time < minimal_time:
1825            self.logger.debug(
1826                "Player %s reached state %s too soon (%s vs %s seconds) - add fallback sleep...",
1827                player.state.name,
1828                wanted_state,
1829                elapsed_time,
1830                minimal_time,
1831            )
1832            await asyncio.sleep(minimal_time - elapsed_time)
1833        else:
1834            self.logger.debug(
1835                "Player %s reached state %s within %s seconds",
1836                player.state.name,
1837                wanted_state,
1838                elapsed_time,
1839            )
1840
1841    async def on_player_config_change(self, config: PlayerConfig, changed_keys: set[str]) -> None:
1842        """Call (by config manager) when the configuration of a player changes."""
1843        player = self.get_player(config.player_id)
1844        player_provider = self.mass.get_provider(config.provider)
1845        player_disabled = ATTR_ENABLED in changed_keys and not config.enabled
1846        player_enabled = ATTR_ENABLED in changed_keys and config.enabled
1847
1848        if player_disabled and player and player.state.available:
1849            # edge case: ensure that the player is powered off if the player gets disabled
1850            if player.state.power_control != PLAYER_CONTROL_NONE:
1851                await self._handle_cmd_power(config.player_id, False)
1852            elif player.state.playback_state != PlaybackState.IDLE:
1853                await self.cmd_stop(config.player_id)
1854
1855        # signal player provider that the player got enabled/disabled
1856        if (player_enabled or player_disabled) and player_provider:
1857            assert isinstance(player_provider, PlayerProvider)  # for type checking
1858            if player_disabled:
1859                player_provider.on_player_disabled(config.player_id)
1860            elif player_enabled:
1861                player_provider.on_player_enabled(config.player_id)
1862            return  # enabling/disabling a player will be handled by the provider
1863
1864        if not player:
1865            return  # guard against player not being registered (yet)
1866
1867        resume_queue: PlayerQueue | None = (
1868            self.mass.player_queues.get(player.state.active_source)
1869            if player.state.active_source
1870            else None
1871        )
1872
1873        # ensure player state gets updated with any updated config
1874        player.set_config(config)
1875        await player.on_config_updated()
1876        player.update_state()
1877        # if the PlayerQueue was playing, restart playback
1878        if resume_queue and resume_queue.state == PlaybackState.PLAYING:
1879            requires_restart = any(
1880                v for v in config.values.values() if v.key in changed_keys and v.requires_reload
1881            )
1882            if requires_restart:
1883                # always stop first to ensure the player uses the new config
1884                await self.mass.player_queues.stop(resume_queue.queue_id)
1885                self.mass.call_later(
1886                    1, self.mass.player_queues.resume, resume_queue.queue_id, False
1887                )
1888
1889    async def on_player_dsp_change(self, player_id: str) -> None:
1890        """Call (by config manager) when the DSP settings of a player change."""
1891        # signal player provider that the config changed
1892        if not (player := self.get_player(player_id)):
1893            return
1894        if player.state.playback_state == PlaybackState.PLAYING:
1895            self.logger.info("Restarting playback of Player %s after DSP change", player_id)
1896            # this will restart the queue stream/playback
1897            if player.mass_queue_active:
1898                self.mass.call_later(
1899                    0, self.mass.player_queues.resume, player.state.active_source, False
1900                )
1901                return
1902            # if the player is not using a queue, we need to stop and start playback
1903            await self.cmd_stop(player_id)
1904            await self.cmd_play(player_id)
1905
1906    async def _cleanup_player_memberships(self, player_id: str) -> None:
1907        """Ensure a player is detached from any groups or syncgroups."""
1908        if not (player := self.get_player(player_id)):
1909            return
1910
1911        if (
1912            player.state.active_group
1913            and (group := self.get_player(player.state.active_group))
1914            and group.supports_feature(PlayerFeature.SET_MEMBERS)
1915        ):
1916            # Ungroup the player if its part of an active group, this will ignore
1917            # static_group_members since that is only checked when using cmd_set_members
1918            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1919                await group.set_members(player_ids_to_remove=[player_id])
1920        elif player.state.synced_to and player.supports_feature(PlayerFeature.SET_MEMBERS):
1921            # Remove the player if it was synced, otherwise it will still show as
1922            # synced to the other player after it gets registered again
1923            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1924                await player.ungroup()
1925
1926    def _get_player_with_redirect(self, player_id: str) -> Player:
1927        """Get player with check if playback related command should be redirected."""
1928        player = self.get_player(player_id, True)
1929        assert player is not None  # for type checking
1930        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
1931            self.logger.info(
1932                "Player %s is synced to %s and can not accept "
1933                "playback related commands itself, "
1934                "redirected the command to the sync leader.",
1935                player.name,
1936                sync_leader.name,
1937            )
1938            return sync_leader
1939        if player.state.active_group and (
1940            active_group := self.get_player(player.state.active_group)
1941        ):
1942            self.logger.info(
1943                "Player %s is part of a playergroup and can not accept "
1944                "playback related commands itself, "
1945                "redirected the command to the group leader.",
1946                player.name,
1947            )
1948            return active_group
1949        return player
1950
1951    def _get_active_plugin_source(self, player: Player) -> PluginSource | None:
1952        """Get the active PluginSource for a player if any."""
1953        # Check if any plugin source is in use by this player
1954        for plugin_source in self.get_plugin_sources():
1955            if plugin_source.in_use_by == player.player_id:
1956                return plugin_source
1957            if player.state.active_source == plugin_source.id:
1958                return plugin_source
1959        return None
1960
1961    def _get_player_groups(
1962        self, player: Player, available_only: bool = True, powered_only: bool = False
1963    ) -> Iterator[Player]:
1964        """Return all groupplayers the given player belongs to."""
1965        for _player in self.all_players(return_unavailable=not available_only):
1966            if _player.player_id == player.player_id:
1967                continue
1968            if _player.state.type != PlayerType.GROUP:
1969                continue
1970            if powered_only and _player.state.powered is False:
1971                continue
1972            if player.player_id in _player.state.group_members:
1973                yield _player
1974
1975    # Protocol linking methods are provided by ProtocolLinkingMixin (protocol_linking.py)
1976
1977    async def _play_announcement(  # noqa: PLR0915
1978        self,
1979        player: Player,
1980        announcement: PlayerMedia,
1981        volume_level: int | None = None,
1982    ) -> None:
1983        """Handle (default/fallback) implementation of the play announcement feature.
1984
1985        This default implementation will;
1986        - stop playback of the current media (if needed)
1987        - power on the player (if needed)
1988        - raise the volume a bit
1989        - play the announcement (from given url)
1990        - wait for the player to finish playing
1991        - restore the previous power and volume
1992        - restore playback (if needed and if possible)
1993
1994        This default implementation will only be used if the player
1995        (provider) has no native support for the PLAY_ANNOUNCEMENT feature.
1996        """
1997        prev_state = player.state.playback_state
1998        prev_power = player.state.powered or prev_state != PlaybackState.IDLE
1999        prev_synced_to = player.state.synced_to
2000        prev_group = (
2001            self.get_player(player.state.active_group) if player.state.active_group else None
2002        )
2003        prev_source = player.state.active_source
2004        prev_media = player.state.current_media
2005        prev_media_name = prev_media.title or prev_media.uri if prev_media else None
2006        if prev_synced_to:
2007            # ungroup player if its currently synced
2008            self.logger.debug(
2009                "Announcement to player %s - ungrouping player from %s...",
2010                player.state.name,
2011                prev_synced_to,
2012            )
2013            await self.cmd_ungroup(player.player_id)
2014        elif prev_group:
2015            # if the player is part of a group player, we need to ungroup it
2016            if PlayerFeature.SET_MEMBERS in prev_group.supported_features:
2017                self.logger.debug(
2018                    "Announcement to player %s - ungrouping from group player %s...",
2019                    player.state.name,
2020                    prev_group.display_name,
2021                )
2022                await prev_group.set_members(player_ids_to_remove=[player.player_id])
2023            else:
2024                # if the player is part of a group player that does not support ungrouping,
2025                # we need to power off the groupplayer instead
2026                self.logger.debug(
2027                    "Announcement to player %s - turning off group player %s...",
2028                    player.state.name,
2029                    prev_group.display_name,
2030                )
2031                await self._handle_cmd_power(player.player_id, False)
2032        elif prev_state in (PlaybackState.PLAYING, PlaybackState.PAUSED):
2033            # normal/standalone player: stop player if its currently playing
2034            self.logger.debug(
2035                "Announcement to player %s - stop existing content (%s)...",
2036                player.state.name,
2037                prev_media_name,
2038            )
2039            await self.cmd_stop(player.player_id)
2040            # wait for the player to stop
2041            await self.wait_for_state(player, PlaybackState.IDLE, 10, 0.4)
2042        # adjust volume if needed
2043        # in case of a (sync) group, we need to do this for all child players
2044        prev_volumes: dict[str, int] = {}
2045        async with TaskManager(self.mass) as tg:
2046            for volume_player_id in player.state.group_members or (player.player_id,):
2047                if not (volume_player := self.get_player(volume_player_id)):
2048                    continue
2049                # catch any players that have a different source active
2050                if (
2051                    volume_player.state.active_source
2052                    not in (
2053                        player.state.active_source,
2054                        volume_player.player_id,
2055                        None,
2056                    )
2057                    and volume_player.state.playback_state == PlaybackState.PLAYING
2058                ):
2059                    self.logger.warning(
2060                        "Detected announcement to playergroup %s while group member %s is playing "
2061                        "other content, this may lead to unexpected behavior.",
2062                        player.state.name,
2063                        volume_player.state.name,
2064                    )
2065                    tg.create_task(self.cmd_stop(volume_player.player_id))
2066                if volume_player.state.volume_control == PLAYER_CONTROL_NONE:
2067                    continue
2068                if (prev_volume := volume_player.state.volume_level) is None:
2069                    continue
2070                announcement_volume = self.get_announcement_volume(volume_player_id, volume_level)
2071                if announcement_volume is None:
2072                    continue
2073                temp_volume = announcement_volume or player.state.volume_level
2074                if temp_volume != prev_volume:
2075                    prev_volumes[volume_player_id] = prev_volume
2076                    self.logger.debug(
2077                        "Announcement to player %s - setting temporary volume (%s)...",
2078                        volume_player.state.name,
2079                        announcement_volume,
2080                    )
2081                    tg.create_task(
2082                        self._handle_cmd_volume_set(volume_player.player_id, announcement_volume)
2083                    )
2084        # play the announcement
2085        self.logger.debug(
2086            "Announcement to player %s - playing the announcement on the player...",
2087            player.state.name,
2088        )
2089        await self.play_media(player_id=player.player_id, media=announcement)
2090        # wait for the player(s) to play
2091        await self.wait_for_state(player, PlaybackState.PLAYING, 10, minimal_time=0.1)
2092        # wait for the player to stop playing
2093        if not announcement.duration:
2094            if not announcement.custom_data:
2095                raise ValueError("Announcement missing duration and custom_data")
2096            media_info = await async_parse_tags(
2097                announcement.custom_data["announcement_url"], require_duration=True
2098            )
2099            announcement.duration = int(media_info.duration) if media_info.duration else None
2100
2101        if announcement.duration is None:
2102            raise ValueError("Announcement duration could not be determined")
2103
2104        await self.wait_for_state(
2105            player,
2106            PlaybackState.IDLE,
2107            timeout=announcement.duration + 10,
2108            minimal_time=float(announcement.duration) + 2,
2109        )
2110        self.logger.debug(
2111            "Announcement to player %s - restore previous state...", player.state.name
2112        )
2113        # restore volume
2114        async with TaskManager(self.mass) as tg:
2115            for volume_player_id, prev_volume in prev_volumes.items():
2116                tg.create_task(self._handle_cmd_volume_set(volume_player_id, prev_volume))
2117        await asyncio.sleep(0.2)
2118        # either power off the player or resume playing
2119        if not prev_power:
2120            if player.state.power_control != PLAYER_CONTROL_NONE:
2121                self.logger.debug(
2122                    "Announcement to player %s - turning player off again...", player.state.name
2123                )
2124                await self._handle_cmd_power(player.player_id, False)
2125            # nothing to do anymore, player was not previously powered
2126            # and does not support power control
2127            return
2128        if prev_synced_to:
2129            self.logger.debug(
2130                "Announcement to player %s - syncing back to %s...",
2131                player.state.name,
2132                prev_synced_to,
2133            )
2134            await self.cmd_set_members(prev_synced_to, player_ids_to_add=[player.player_id])
2135        elif prev_group:
2136            if PlayerFeature.SET_MEMBERS in prev_group.supported_features:
2137                self.logger.debug(
2138                    "Announcement to player %s - grouping back to group player %s...",
2139                    player.state.name,
2140                    prev_group.display_name,
2141                )
2142                await prev_group.set_members(player_ids_to_add=[player.player_id])
2143            elif prev_state == PlaybackState.PLAYING:
2144                # if the player is part of a group player that does not support set_members,
2145                # we need to restart the groupplayer
2146                self.logger.debug(
2147                    "Announcement to player %s - restarting playback on group player %s...",
2148                    player.state.name,
2149                    prev_group.display_name,
2150                )
2151                await self.cmd_play(prev_group.player_id)
2152        elif prev_state == PlaybackState.PLAYING:
2153            # player was playing something before the announcement - try to resume that here
2154            await self._handle_cmd_resume(player.player_id, prev_source, prev_media)
2155
2156    async def _poll_players(self) -> None:
2157        """Background task that polls players for updates."""
2158        while True:
2159            for player in list(self._players.values()):
2160                # if the player is playing, update elapsed time every tick
2161                # to ensure the queue has accurate details
2162                player_playing = player.state.playback_state == PlaybackState.PLAYING
2163                if player_playing:
2164                    self.mass.loop.call_soon(
2165                        self.mass.player_queues.on_player_update,
2166                        player,
2167                        {"corrected_elapsed_time": (None, player.corrected_elapsed_time)},
2168                    )
2169                # Poll player;
2170                if not player.needs_poll:
2171                    continue
2172                try:
2173                    last_poll: float = player.extra_data[ATTR_LAST_POLL]
2174                except KeyError:
2175                    last_poll = 0.0
2176                if (self.mass.loop.time() - last_poll) < player.poll_interval:
2177                    continue
2178                player.extra_data[ATTR_LAST_POLL] = self.mass.loop.time()
2179                try:
2180                    await player.poll()
2181                except Exception as err:
2182                    self.logger.warning(
2183                        "Error while requesting latest state from player %s: %s",
2184                        player.state.name,
2185                        str(err),
2186                        exc_info=err if self.logger.isEnabledFor(10) else None,
2187                    )
2188                # Yield to event loop to prevent blocking
2189                await asyncio.sleep(0)
2190            await asyncio.sleep(1)
2191
2192    async def _handle_select_plugin_source(
2193        self, player: Player, plugin_prov: PluginProvider
2194    ) -> None:
2195        """Handle playback/select of given plugin source on player."""
2196        plugin_source = plugin_prov.get_source()
2197        if plugin_source.in_use_by and plugin_source.in_use_by != player.player_id:
2198            self.logger.debug(
2199                "Plugin source %s is already in use by player %s, stopping playback there first.",
2200                plugin_source.name,
2201                plugin_source.in_use_by,
2202            )
2203            with suppress(PlayerCommandFailed):
2204                await self.cmd_stop(plugin_source.in_use_by)
2205        stream_url = await self.mass.streams.get_plugin_source_url(plugin_source, player.player_id)
2206        plugin_source.in_use_by = player.player_id
2207        # Call on_select callback if available
2208        if plugin_source.on_select:
2209            await plugin_source.on_select()
2210        await self.play_media(
2211            player_id=player.player_id,
2212            media=PlayerMedia(
2213                uri=stream_url,
2214                media_type=MediaType.PLUGIN_SOURCE,
2215                title=plugin_source.name,
2216                custom_data={
2217                    "provider": plugin_prov.instance_id,
2218                    "source_id": plugin_source.id,
2219                    "player_id": player.player_id,
2220                    "audio_format": plugin_source.audio_format,
2221                },
2222            ),
2223        )
2224        # trigger player update to ensure the source is set
2225        self.trigger_player_update(player.player_id)
2226
2227    def _handle_group_dsp_change(
2228        self, player: Player, prev_group_members: list[str], new_group_members: list[str]
2229    ) -> None:
2230        """Handle DSP reload when group membership changes."""
2231        prev_child_count = len(prev_group_members)
2232        new_child_count = len(new_group_members)
2233        is_player_group = player.state.type == PlayerType.GROUP
2234
2235        # handle special case for PlayerGroups: since there are no leaders,
2236        # DSP still always work with a single player in the group.
2237        multi_device_dsp_threshold = 1 if is_player_group else 0
2238
2239        prev_is_multiple_devices = prev_child_count > multi_device_dsp_threshold
2240        new_is_multiple_devices = new_child_count > multi_device_dsp_threshold
2241
2242        if prev_is_multiple_devices == new_is_multiple_devices:
2243            return  # no change in multi-device status
2244
2245        supports_multi_device_dsp = (
2246            PlayerFeature.MULTI_DEVICE_DSP in player.state.supported_features
2247        )
2248
2249        dsp_enabled: bool
2250        if player.state.type == PlayerType.GROUP:
2251            # Since player groups do not have leaders, we will use the only child
2252            # that was in the group before and after the change
2253            if prev_is_multiple_devices:
2254                if childs := new_group_members:
2255                    # We shrank the group from multiple players to a single player
2256                    # So the now only child will control the DSP
2257                    dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2258                else:
2259                    dsp_enabled = False
2260            elif childs := prev_group_members:
2261                # We grew the group from a single player to multiple players,
2262                # let's see if the previous single player had DSP enabled
2263                dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2264            else:
2265                dsp_enabled = False
2266        else:
2267            dsp_enabled = self.mass.config.get_player_dsp_config(player.player_id).enabled
2268
2269        if dsp_enabled and not supports_multi_device_dsp:
2270            # We now know that the group configuration has changed so:
2271            # - multi-device DSP is not supported
2272            # - we switched from a group with multiple players to a single player
2273            #   (or vice versa)
2274            # - the leader has DSP enabled
2275            self.mass.create_task(self.mass.players.on_player_dsp_change(player.player_id))
2276
2277    def _handle_external_source_takeover(
2278        self, player: Player, prev_source: str | None, new_source: str | None
2279    ) -> None:
2280        """
2281        Handle when an external source takes over playback on a player.
2282
2283        When a player has an active grouped output protocol (e.g., AirPlay group) and
2284        an external source (e.g., Spotify Connect, TV input) takes over playback,
2285        we need to clear the active output protocol and ungroup the protocol players.
2286
2287        This prevents the situation where the player appears grouped via protocol
2288        but is actually playing from a different source.
2289
2290        :param player: The player whose active_source changed.
2291        :param prev_source: The previous active_source value.
2292        :param new_source: The new active_source value.
2293        """
2294        # Only relevant for non-protocol players
2295        if player.type == PlayerType.PROTOCOL:
2296            return
2297
2298        # Not a takeover if the player is not actively playing
2299        if player.playback_state != PlaybackState.PLAYING:
2300            return
2301
2302        # Only relevant if we have an active output protocol (not native)
2303        if not player.active_output_protocol or player.active_output_protocol == "native":
2304            return
2305
2306        # Check if new source is external (not MA-managed)
2307        if self._is_ma_managed_source(player, new_source):
2308            return
2309
2310        # Get the active protocol player
2311        protocol_player = self.get_player(player.active_output_protocol)
2312        if not protocol_player:
2313            return
2314
2315        # If the source matches the active protocol's domain, it's expected - not a takeover
2316        # e.g., source "airplay" when using AirPlay protocol is normal
2317        if new_source and new_source.lower() == protocol_player.provider.domain.lower():
2318            return
2319
2320        # Confirmed external source takeover
2321        self.logger.info(
2322            "External source '%s' took over on %s while grouped via protocol %s - "
2323            "clearing active output protocol and ungrouping",
2324            new_source,
2325            player.display_name,
2326            protocol_player.provider.domain,
2327        )
2328
2329        # Clear active output protocol
2330        player.set_active_output_protocol(None)
2331
2332        # Ungroup the protocol player (async task)
2333        self.mass.create_task(protocol_player.ungroup())
2334
2335    def _is_ma_managed_source(self, player: Player, source: str | None) -> bool:
2336        """
2337        Check if a source is managed by Music Assistant.
2338
2339        MA-managed sources include:
2340        - None (=autodetect, no source explicitly set by player)
2341        - The player's own ID (MA queue)
2342        - Any active queue ID
2343        - Any plugin source ID
2344
2345        :param player: The player to check.
2346        :param source: The source ID to check.
2347        :return: True if the source is MA-managed, False if external.
2348        """
2349        if source is None:
2350            return True
2351
2352        # Player's own ID means MA queue is active
2353        if source == player.player_id:
2354            return True
2355
2356        # Check if it's a known queue ID
2357        if self.mass.player_queues.get(source):
2358            return True
2359
2360        # Check if it's a plugin source
2361        return any(plugin_source.id == source for plugin_source in self.get_plugin_sources())
2362
2363    def _schedule_update_all_players(self, delay: float = 2.0) -> None:
2364        """
2365        Schedule a debounced update of all players' state.
2366
2367        Used when a new player is registered to ensure all existing players
2368        update their dynamic properties (like can_group_with) that may have changed.
2369
2370        :param delay: Delay in seconds before triggering updates (default 2.0).
2371        """
2372        if self.mass.closing:
2373            return
2374
2375        async def _update_all_players() -> None:
2376            if self.mass.closing:
2377                return
2378
2379            for player in self.all_players(
2380                return_unavailable=True,
2381                return_disabled=False,
2382                return_protocol_players=True,
2383            ):
2384                # Use call_soon to schedule updates without blocking
2385                # This spreads the updates across event loop iterations
2386                self.mass.loop.call_soon(player.update_state)
2387
2388        # Use mass.call_later with task_id for automatic debouncing
2389        # Each call resets the timer, so rapid registrations only trigger one update
2390        task_id = "update_all_players_on_registration"
2391        self.mass.call_later(delay, _update_all_players, task_id=task_id)
2392
2393    async def _handle_set_members_with_protocols(
2394        self,
2395        parent_player: Player,
2396        player_ids_to_add: list[str],
2397        player_ids_to_remove: list[str],
2398    ) -> None:
2399        """
2400        Handle set_members considering protocol and native members.
2401
2402        Translates visible player IDs to protocol player IDs when appropriate,
2403        and forwards to the correct player's set_members.
2404
2405        :param parent_player: The parent player to add/remove members to/from.
2406        :param player_ids_to_add: List of visible player IDs to add as members.
2407        :param player_ids_to_remove: List of visible player IDs to remove from members.
2408        """
2409        # Get parent's active protocol domain and player if available
2410        parent_protocol_domain = None
2411        parent_protocol_player = None
2412        if (
2413            parent_player.active_output_protocol
2414            and parent_player.active_output_protocol != "native"
2415        ):
2416            parent_protocol_player = self.get_player(parent_player.active_output_protocol)
2417            if parent_protocol_player:
2418                parent_protocol_domain = parent_protocol_player.provider.domain
2419
2420        self.logger.debug(
2421            "set_members on %s: active_protocol=%s, adding=%s, removing=%s",
2422            parent_player.state.name,
2423            parent_protocol_domain or "none",
2424            player_ids_to_add,
2425            player_ids_to_remove,
2426        )
2427
2428        # Translate members to add
2429        (
2430            protocol_members_to_add,
2431            native_members_to_add,
2432            parent_protocol_player,
2433            parent_protocol_domain,
2434        ) = self._translate_members_for_protocols(
2435            parent_player, player_ids_to_add, parent_protocol_player, parent_protocol_domain
2436        )
2437
2438        self.logger.debug(
2439            "Translated members: protocol=%s (domain=%s), native=%s",
2440            protocol_members_to_add,
2441            parent_protocol_domain,
2442            native_members_to_add,
2443        )
2444
2445        # Translate members to remove
2446        protocol_members_to_remove, native_members_to_remove = (
2447            self._translate_members_to_remove_for_protocols(
2448                parent_player, player_ids_to_remove, parent_protocol_player, parent_protocol_domain
2449            )
2450        )
2451
2452        # Forward protocol members to protocol player's set_members
2453        if (protocol_members_to_add or protocol_members_to_remove) and parent_protocol_player:
2454            await self._forward_protocol_set_members(
2455                parent_player,
2456                parent_protocol_player,
2457                protocol_members_to_add,
2458                protocol_members_to_remove,
2459            )
2460
2461        # Forward native members to parent player's set_members
2462        if native_members_to_add or native_members_to_remove:
2463            filtered_native_add = self._filter_native_members(native_members_to_add, parent_player)
2464            # For removal, allow protocol players if they're actually in the parent's group_members
2465            # This handles native protocol players (e.g., native AirPlay) where group_members
2466            # contains protocol player IDs
2467            filtered_native_remove = [
2468                pid
2469                for pid in native_members_to_remove
2470                if (p := self.get_player(pid))
2471                and (p.type != PlayerType.PROTOCOL or pid in parent_player.group_members)
2472            ]
2473            self.logger.debug(
2474                "Native grouping on %s: filtered_add=%s, filtered_remove=%s",
2475                parent_player.state.name,
2476                filtered_native_add,
2477                filtered_native_remove,
2478            )
2479            if filtered_native_add or filtered_native_remove:
2480                self.logger.info(
2481                    "Calling set_members on native player %s with add=%s, remove=%s",
2482                    parent_player.state.name,
2483                    filtered_native_add,
2484                    filtered_native_remove,
2485                )
2486                await parent_player.set_members(
2487                    player_ids_to_add=filtered_native_add or None,
2488                    player_ids_to_remove=filtered_native_remove or None,
2489                )
2490
2491    # Private command handlers (no permission checks)
2492
2493    async def _handle_cmd_resume(
2494        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
2495    ) -> None:
2496        """
2497        Handle resume playback command.
2498
2499        Skips the permission checks (internal use only).
2500        """
2501        player = self._get_player_with_redirect(player_id)
2502        source = source or player.state.active_source
2503        media = media or player.state.current_media
2504        # power on the player if needed
2505        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
2506            await self._handle_cmd_power(player.player_id, True)
2507        # Redirect to queue controller if it is active
2508        if active_queue := self.mass.player_queues.get(source or player_id):
2509            await self.mass.player_queues.resume(active_queue.queue_id)
2510            return
2511        # try to handle command on player directly
2512        # TODO: check if player has an active source with native resume support
2513        active_source = next((x for x in player.state.source_list if x.id == source), None)
2514        if (
2515            player.state.playback_state in (PlaybackState.IDLE, PlaybackState.PAUSED)
2516            and active_source
2517            and active_source.can_play_pause
2518        ):
2519            # player has some other source active and native resume support
2520            await player.play()
2521            return
2522        if active_source and not active_source.passive:
2523            await self.select_source(player_id, active_source.id)
2524            return
2525        if media:
2526            # try to re-play the current media item
2527            await player.play_media(media)
2528            return
2529        # fallback: just send play command - which will fail if nothing can be played
2530        await player.play()
2531
2532    async def _handle_cmd_power(self, player_id: str, powered: bool) -> None:
2533        """
2534        Handle player power on/off command.
2535
2536        Skips the permission checks (internal use only).
2537        """
2538        player = self.get_player(player_id, True)
2539        assert player is not None  # for type checking
2540        player_state = player.state
2541
2542        if player_state.powered == powered:
2543            self.logger.debug(
2544                "Ignoring power %s command for player %s: already in state %s",
2545                "ON" if powered else "OFF",
2546                player_state.name,
2547                "ON" if player_state.powered else "OFF",
2548            )
2549            return  # nothing to do
2550
2551        # ungroup player at power off
2552        player_was_synced = player.state.synced_to is not None
2553        if player.type == PlayerType.PLAYER and not powered:
2554            # ungroup player if it is synced (or is a sync leader itself)
2555            # NOTE: ungroup will be ignored if the player is not grouped or synced
2556            await self.cmd_ungroup(player_id)
2557
2558        # always stop player at power off
2559        if (
2560            not powered
2561            and not player_was_synced
2562            and player_state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
2563        ):
2564            await self.cmd_stop(player_id)
2565            # short sleep: allow the stop command to process and prevent race conditions
2566            await asyncio.sleep(0.2)
2567
2568        # power off all synced childs when player is a sync leader
2569        elif not powered and player_state.type == PlayerType.PLAYER and player_state.group_members:
2570            async with TaskManager(self.mass) as tg:
2571                for member in self.iter_group_members(player, True):
2572                    if member.power_control == PLAYER_CONTROL_NONE:
2573                        continue
2574                    tg.create_task(self._handle_cmd_power(member.player_id, False))
2575
2576        # handle actual power command
2577        if player_state.power_control == PLAYER_CONTROL_NONE:
2578            self.logger.debug(
2579                "Player %s does not support power control, ignoring power command",
2580                player_state.name,
2581            )
2582            return
2583        if player_state.power_control == PLAYER_CONTROL_NATIVE:
2584            # player supports power command natively: forward to player provider
2585            await player.power(powered)
2586        elif player_state.power_control == PLAYER_CONTROL_FAKE:
2587            # user wants to use fake power control - so we (optimistically) update the state
2588            # and store the state in the cache
2589            player.extra_data[ATTR_FAKE_POWER] = powered
2590            player.update_state()  # trigger update of the player state
2591            await self.mass.cache.set(
2592                key=player_id,
2593                data=powered,
2594                provider=self.domain,
2595                category=CACHE_CATEGORY_PLAYER_POWER,
2596            )
2597        else:
2598            # handle external player control
2599            player_control = self._controls.get(player.state.power_control)
2600            control_name = player_control.name if player_control else player.state.power_control
2601            self.logger.debug("Redirecting power command to PlayerControl %s", control_name)
2602            if not player_control or not player_control.supports_power:
2603                raise UnsupportedFeaturedException(
2604                    f"Player control {control_name} is not available"
2605                )
2606            if powered:
2607                assert player_control.power_on is not None  # for type checking
2608                await player_control.power_on()
2609            else:
2610                assert player_control.power_off is not None  # for type checking
2611                await player_control.power_off()
2612
2613        # always trigger a state update to update the UI
2614        player.update_state()
2615
2616        # handle 'auto play on power on' feature
2617        if (
2618            not player_state.active_group
2619            and not player_state.synced_to
2620            and powered
2621            and player.config.get_value(CONF_AUTO_PLAY)
2622            and player_state.active_source in (None, player_id)
2623            and not player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)
2624        ):
2625            await self.mass.player_queues.resume(player_id)
2626
2627    async def _handle_cmd_volume_set(self, player_id: str, volume_level: int) -> None:
2628        """
2629        Handle Player volume set command.
2630
2631        Skips the permission checks (internal use only).
2632        """
2633        player = self.get_player(player_id, True)
2634        assert player is not None  # for type checker
2635        if player.type == PlayerType.GROUP:
2636            # redirect to special group volume control
2637            await self.cmd_group_volume(player_id, volume_level)
2638            return
2639
2640        # Check if player has mute lock (set when individually muted in a group)
2641        # If locked, don't auto-unmute when volume changes
2642        has_mute_lock = player.extra_data.get(ATTR_MUTE_LOCK, False)
2643        if (
2644            not has_mute_lock
2645            # use player.state here to get accumulated mute control from any linked protocol players
2646            and player.state.mute_control not in (PLAYER_CONTROL_NONE, PLAYER_CONTROL_FAKE)
2647            and player.state.volume_muted
2648        ):
2649            # if player is muted and not locked, we unmute it first
2650            # skip this for fake mute since it uses volume to simulate mute
2651            self.logger.debug(
2652                "Unmuting player %s before setting volume",
2653                player.state.name,
2654            )
2655            await self.cmd_volume_mute(player_id, False)
2656
2657        # Check if a plugin source is active with a volume callback
2658        if plugin_source := self._get_active_plugin_source(player):
2659            if plugin_source.on_volume:
2660                await plugin_source.on_volume(volume_level)
2661        # Handle native volume control support
2662        if player.volume_control == PLAYER_CONTROL_NATIVE:
2663            # player supports volume command natively: forward to player
2664            await player.volume_set(volume_level)
2665            return
2666        # Handle fake volume control support
2667        if player.volume_control == PLAYER_CONTROL_FAKE:
2668            # user wants to use fake volume control - so we (optimistically) update the state
2669            # and store the state in the cache
2670            player.extra_data[ATTR_FAKE_VOLUME] = volume_level
2671            # trigger update
2672            player.update_state()
2673            return
2674        # player has no volume support at all
2675        if player.volume_control == PLAYER_CONTROL_NONE:
2676            raise UnsupportedFeaturedException(
2677                f"Player {player.state.name} does not support volume control"
2678            )
2679        # handle external player control
2680        if player_control := self._controls.get(player.state.volume_control):
2681            control_name = player_control.name if player_control else player.state.volume_control
2682            self.logger.debug("Redirecting volume command to PlayerControl %s", control_name)
2683            if not player_control or not player_control.supports_volume:
2684                raise UnsupportedFeaturedException(
2685                    f"Player control {control_name} is not available"
2686                )
2687            assert player_control.volume_set is not None
2688            await player_control.volume_set(volume_level)
2689            return
2690        if protocol_player := self.get_player(player.state.volume_control):
2691            # redirect to protocol player volume control
2692            self.logger.debug(
2693                "Redirecting volume command to protocol player %s",
2694                protocol_player.provider.manifest.name,
2695            )
2696            await self._handle_cmd_volume_set(protocol_player.player_id, volume_level)
2697            return
2698
2699    async def _handle_play_media(self, player_id: str, media: PlayerMedia) -> None:
2700        """
2701        Handle play media command without group redirect.
2702
2703        Skips permission checks and all redirect logic (internal use only).
2704
2705        :param player_id: player_id of the player to handle the command.
2706        :param media: The Media that needs to be played on the player.
2707        """
2708        player = self.get_player(player_id, raise_unavailable=True)
2709        assert player is not None
2710        # set active source if media has a source_id (e.g. plugin source or mass queue source)
2711        if media.source_id:
2712            player.set_active_mass_source(media.source_id)
2713
2714        # Select best output protocol for playback
2715        target_player, output_protocol = self._select_best_output_protocol(player)
2716
2717        if target_player.player_id != player.player_id:
2718            # Playing via linked protocol - update active output protocol
2719            # output_protocol is guaranteed to be non-None when target_player != player
2720            assert output_protocol is not None
2721            self.logger.debug(
2722                "Starting playback on %s via protocol %s (target=%s), group_members=%s",
2723                player.state.name,
2724                output_protocol.output_protocol_id,
2725                target_player.display_name,
2726                target_player.state.group_members,
2727            )
2728            player.set_active_output_protocol(output_protocol.output_protocol_id)
2729            # if the (protocol)player has power control and is currently powered off,
2730            # we need to power it on before playback
2731            if (
2732                target_player.state.powered is False
2733                and target_player.power_control != PLAYER_CONTROL_NONE
2734            ):
2735                await self._handle_cmd_power(target_player.player_id, True)
2736            # forward play media command to protocol player
2737            await target_player.play_media(media)
2738            # notify the native player that protocol playback started
2739            await player.on_protocol_playback(output_protocol=output_protocol)
2740        else:
2741            # Native playback
2742            self.logger.debug(
2743                "Starting playback on %s via native, group_members=%s",
2744                player.state.name,
2745                player.state.group_members,
2746            )
2747            player.set_active_output_protocol("native")
2748            await player.play_media(media)
2749
2750    async def _handle_enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
2751        """
2752        Handle enqueue next media command without group redirect.
2753
2754        Skips permission checks and all redirect logic (internal use only).
2755
2756        :param player_id: player_id of the player to handle the command.
2757        :param media: The Media that needs to be enqueued on the player.
2758        """
2759        player = self.get_player(player_id, raise_unavailable=True)
2760        assert player is not None
2761        if target_player := self._get_control_target(
2762            player,
2763            required_feature=PlayerFeature.ENQUEUE,
2764            require_active=True,
2765        ):
2766            self.logger.debug(
2767                "Redirecting enqueue command to protocol player %s",
2768                target_player.provider.manifest.name,
2769            )
2770            await target_player.enqueue_next_media(media)
2771            return
2772
2773        if PlayerFeature.ENQUEUE not in player.state.supported_features:
2774            raise UnsupportedFeaturedException(
2775                f"Player {player.state.name} does not support enqueueing"
2776            )
2777        await player.enqueue_next_media(media)
2778
2779    async def _handle_select_source(self, player_id: str, source: str | None) -> None:
2780        """
2781        Handle select source command without group redirect.
2782
2783        Skips permission checks and all redirect logic (internal use only).
2784
2785        :param player_id: player_id of the player to handle the command.
2786        :param source: The ID of the source that needs to be activated/selected.
2787        """
2788        if source is None:
2789            source = player_id  # default to MA queue source
2790        player = self.get_player(player_id, True)
2791        assert player is not None
2792        # check if player is already playing and source is different
2793        # in that case we need to stop the player first
2794        prev_source = player.state.active_source
2795        if prev_source and source != prev_source:
2796            with suppress(PlayerCommandFailed, RuntimeError):
2797                # just try to stop (regardless of state)
2798                await self._handle_cmd_stop(player_id)
2799                await asyncio.sleep(2)  # small delay to allow stop to process
2800        # check if source is a pluginsource
2801        # in that case the source id is the instance_id of the plugin provider
2802        if plugin_prov := self.mass.get_provider(source):
2803            player.set_active_mass_source(source)
2804            await self._handle_select_plugin_source(player, cast("PluginProvider", plugin_prov))
2805            return
2806        # check if source is a mass queue
2807        # this can be used to restore the queue after a source switch
2808        if self.mass.player_queues.get(source):
2809            player.set_active_mass_source(source)
2810            return
2811        # basic check if player supports source selection
2812        if PlayerFeature.SELECT_SOURCE not in player.state.supported_features:
2813            raise UnsupportedFeaturedException(
2814                f"Player {player.state.name} does not support source selection"
2815            )
2816        # basic check if source is valid for player
2817        if not any(x for x in player.state.source_list if x.id == source):
2818            raise PlayerCommandFailed(
2819                f"{source} is an invalid source for player {player.state.name}"
2820            )
2821        # forward to player
2822        await player.select_source(source)
2823
2824    async def _handle_cmd_stop(self, player_id: str) -> None:
2825        """
2826        Handle stop command without any redirects.
2827
2828        Skips permission checks and all redirect logic (internal use only).
2829
2830        :param player_id: player_id of the player to handle the command.
2831        """
2832        player = self.get_player(player_id, raise_unavailable=True)
2833        assert player is not None
2834        player.mark_stop_called()
2835        # Delegate to active protocol player if one is active
2836        target_player = player
2837        if (
2838            player.active_output_protocol
2839            and player.active_output_protocol != "native"
2840            and (protocol_player := self.get_player(player.active_output_protocol))
2841        ):
2842            target_player = protocol_player
2843            if PlayerFeature.POWER in target_player.supported_features:
2844                # if protocol player supports/requires power,
2845                # we power it off instead of just stopping (which also stops playback)
2846                await self._handle_cmd_power(target_player.player_id, False)
2847                return
2848
2849        # handle command on player(protocol) directly
2850        await target_player.stop()
2851
2852    async def _handle_cmd_play(self, player_id: str) -> None:
2853        """
2854        Handle play command without group redirect.
2855
2856        Skips permission checks and all redirect logic (internal use only).
2857
2858        :param player_id: player_id of the player to handle the command.
2859        """
2860        player = self.get_player(player_id, raise_unavailable=True)
2861        assert player is not None
2862        if player.state.playback_state == PlaybackState.PLAYING:
2863            self.logger.info(
2864                "Ignore PLAY request to player %s: player is already playing", player.state.name
2865            )
2866            return
2867        # Check if a plugin source is active with a play callback
2868        if plugin_source := self._get_active_plugin_source(player):
2869            if plugin_source.can_play_pause and plugin_source.on_play:
2870                await plugin_source.on_play()
2871                return
2872        # handle unpause (=play if player is paused)
2873        if player.state.playback_state == PlaybackState.PAUSED:
2874            active_source = next(
2875                (x for x in player.state.source_list if x.id == player.state.active_source), None
2876            )
2877            # raise if active source does not support play/pause
2878            if active_source and not active_source.can_play_pause:
2879                msg = (
2880                    f"The active source ({active_source.name}) on player "
2881                    f"{player.state.name} does not support play/pause"
2882                )
2883                raise PlayerCommandFailed(msg)
2884            # Delegate to active protocol player if one is active
2885            if target_player := self._get_control_target(
2886                player, PlayerFeature.PAUSE, require_active=True
2887            ):
2888                await target_player.play()
2889                return
2890
2891        # player is not paused: try to resume the player
2892        # Note: We handle resume inline here without calling _handle_cmd_resume
2893        active_source = next(
2894            (x for x in player.state.source_list if x.id == player.state.active_source), None
2895        )
2896        media = player.state.current_media
2897        # power on the player if needed
2898        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
2899            await self._handle_cmd_power(player.player_id, True)
2900        if active_source and not active_source.passive:
2901            await self._handle_select_source(player_id, active_source.id)
2902            return
2903        if media:
2904            # try to re-play the current media item
2905            await player.play_media(media)
2906            return
2907        # fallback: just send play command - which will fail if nothing can be played
2908        await player.play()
2909
2910    async def _handle_cmd_pause(self, player_id: str) -> None:
2911        """
2912        Handle pause command without any redirects.
2913
2914        Skips permission checks and all redirect logic (internal use only).
2915
2916        :param player_id: player_id of the player to handle the command.
2917        """
2918        player = self.get_player(player_id, raise_unavailable=True)
2919        assert player is not None
2920        # Check if a plugin source is active with a pause callback
2921        if plugin_source := self._get_active_plugin_source(player):
2922            if plugin_source.can_play_pause and plugin_source.on_pause:
2923                await plugin_source.on_pause()
2924                return
2925        # handle command on player/source directly
2926        active_source = next(
2927            (x for x in player.state.source_list if x.id == player.state.active_source), None
2928        )
2929        if active_source and not active_source.can_play_pause:
2930            # raise if active source does not support play/pause
2931            msg = (
2932                f"The active source ({active_source.name}) on player "
2933                f"{player.state.name} does not support play/pause"
2934            )
2935            raise PlayerCommandFailed(msg)
2936        # Delegate to active protocol player if one is active
2937        if not (
2938            target_player := self._get_control_target(
2939                player, PlayerFeature.PAUSE, require_active=True
2940            )
2941        ):
2942            # if player(protocol) does not support pause, we need to send stop
2943            self.logger.debug(
2944                "Player/protocol %s does not support pause, using STOP instead",
2945                player.state.name,
2946            )
2947            await self._handle_cmd_stop(player.player_id)
2948            return
2949        # handle command on player(protocol) directly
2950        await target_player.pause()
2951
2952    def __iter__(self) -> Iterator[Player]:
2953        """Iterate over all players."""
2954        return iter(self._players.values())
2955