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        :param player_id: player_id of the player to handle the command.
1153        :param target_player: player_id of the syncgroup leader or group player.
1154
1155        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1156        :raises PlayerCommandFailed: if the target player is already synced to another player.
1157        :raises PlayerUnavailableError: if the target player is not available.
1158        :raises PlayerCommandFailed: if the player is already grouped to another player.
1159        """
1160        await self.cmd_set_members(target_player, player_ids_to_add=[player_id])
1161
1162    @api_command("players/cmd/group_many")
1163    async def cmd_group_many(self, target_player: str, child_player_ids: list[str]) -> None:
1164        """
1165        Join given player(s) to target player.
1166
1167        Will add the given player(s) to the target player (sync leader or group player).
1168        This is a (deprecated) alias for cmd_set_members.
1169        """
1170        await self.cmd_set_members(target_player, player_ids_to_add=child_player_ids)
1171
1172    @api_command("players/cmd/ungroup")
1173    @handle_player_command
1174    async def cmd_ungroup(self, player_id: str) -> None:
1175        """
1176        Handle UNGROUP command for given player.
1177
1178        Remove the given player from any (sync)groups it currently is synced to.
1179        If the player is not currently grouped to any other player,
1180        this will silently be ignored.
1181
1182        NOTE: This is a convenience helper for cmd_set_members.
1183        """
1184        if not (player := self.get_player(player_id)):
1185            self.logger.warning("Player %s is not available", player_id)
1186            return
1187
1188        if player.state.active_group:
1189            # the player is part of a (permanent) groupplayer and the user tries to ungroup
1190            await self.cmd_set_members(player.state.active_group, player_ids_to_remove=[player_id])
1191            return
1192
1193        if player.state.synced_to:
1194            # player is a sync member
1195            await self.cmd_set_members(player.state.synced_to, player_ids_to_remove=[player_id])
1196            return
1197
1198        if player.state.group_members:
1199            # player is a sync leader, so we ungroup all members from it
1200            await self.cmd_set_members(
1201                player.player_id, player_ids_to_remove=player.state.group_members
1202            )
1203            return
1204
1205    @api_command("players/cmd/ungroup_many")
1206    async def cmd_ungroup_many(self, player_ids: list[str]) -> None:
1207        """Handle UNGROUP command for all the given players."""
1208        for player_id in list(player_ids):
1209            await self.cmd_ungroup(player_id)
1210
1211    @api_command("players/create_group_player", required_role="admin")
1212    async def create_group_player(
1213        self, provider: str, name: str, members: list[str], dynamic: bool = True
1214    ) -> Player:
1215        """
1216        Create a new (permanent) Group Player.
1217
1218        :param provider: The provider (id) to create the group player for.
1219        :param name: Name of the new group player.
1220        :param members: List of player ids to add to the group.
1221        :param dynamic: Whether the group is dynamic (members can change).
1222        """
1223        if not (provider_instance := self.mass.get_provider(provider)):
1224            raise ProviderUnavailableError(f"Provider {provider} not found")
1225        provider_instance = cast("PlayerProvider", provider_instance)
1226        if ProviderFeature.CREATE_GROUP_PLAYER not in provider_instance.supported_features:
1227            raise UnsupportedFeaturedException(
1228                f"Provider {provider} does not support creating group players"
1229            )
1230        return await provider_instance.create_group_player(name, members, dynamic)
1231
1232    @api_command("players/remove_group_player", required_role="admin")
1233    async def remove_group_player(self, player_id: str) -> None:
1234        """Remove a group player."""
1235        if not (player := self.get_player(player_id)):
1236            # we simply permanently delete the player by wiping its config
1237            self.mass.config.remove(f"players/{player_id}")
1238            return
1239        if player.state.type != PlayerType.GROUP:
1240            raise UnsupportedFeaturedException(f"Player {player.state.name} is not a group player")
1241        player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1242        await player.provider.remove_group_player(player_id)
1243
1244    @api_command("players/add_currently_playing_to_favorites")
1245    async def add_currently_playing_to_favorites(self, player_id: str) -> None:
1246        """
1247        Add the currently playing item/track on given player to the favorites.
1248
1249        This tries to resolve the currently playing media to an actual media item
1250        and add that to the favorites in the library. Will raise an error if the
1251        player is not currently playing anything or if the currently playing media
1252        can not be resolved to a media item.
1253        """
1254        player = self._get_player_with_redirect(player_id)
1255        # handle mass player queue active
1256        if mass_queue := self.get_active_queue(player):
1257            if not (current_item := mass_queue.current_item) or not current_item.media_item:
1258                raise PlayerCommandFailed("No current item to add to favorites")
1259            # if we're playing a radio station, try to resolve the currently playing track
1260            if current_item.media_item.media_type == MediaType.RADIO:
1261                if not (
1262                    (streamdetails := mass_queue.current_item.streamdetails)
1263                    and (stream_title := streamdetails.stream_title)
1264                    and " - " in stream_title
1265                ):
1266                    # no stream title available, so we can't resolve the track
1267                    # this can happen if the radio station does not provide metadata
1268                    # or there's a commercial break
1269                    # Possible future improvement could be to actually detect the song with a
1270                    # shazam-like approach.
1271                    raise PlayerCommandFailed("No current item to add to favorites")
1272                # send the streamtitle into a global search query
1273                search_artist, search_title_title = stream_title.split(" - ", 1)
1274                # strip off any additional comments in the title (such as from Radio Paradise)
1275                search_title_title = search_title_title.split(" | ")[0].strip()
1276                if track := await self.mass.music.get_track_by_name(
1277                    search_title_title, search_artist
1278                ):
1279                    # we found a track, so add it to the favorites
1280                    await self.mass.music.add_item_to_favorites(track)
1281                    return
1282                # we could not resolve the track, so raise an error
1283                raise PlayerCommandFailed("No current item to add to favorites")
1284
1285            # else: any other media item, just add it to the favorites directly
1286            await self.mass.music.add_item_to_favorites(current_item.media_item)
1287            return
1288
1289        # guard for player with no active source
1290        if not player.state.active_source:
1291            raise PlayerCommandFailed("Player has no active source")
1292        # handle other source active using the current_media with uri
1293        if current_media := player.state.current_media:
1294            # prefer the uri of the current media item
1295            if current_media.uri:
1296                with suppress(MusicAssistantError):
1297                    await self.mass.music.add_item_to_favorites(current_media.uri)
1298                    return
1299            # fallback to search based on artist and title (and album if available)
1300            if current_media.artist and current_media.title:
1301                if track := await self.mass.music.get_track_by_name(
1302                    current_media.title,
1303                    current_media.artist,
1304                    current_media.album,
1305                ):
1306                    # we found a track, so add it to the favorites
1307                    await self.mass.music.add_item_to_favorites(track)
1308                    return
1309        # if we reach here, we could not resolve the currently playing item
1310        raise PlayerCommandFailed("No current item to add to favorites")
1311
1312    async def register(self, player: Player) -> None:
1313        """Register a player on the Player Controller."""
1314        if self.mass.closing:
1315            return
1316
1317        # Use lock to prevent race conditions during concurrent player registrations
1318        async with self._register_lock:
1319            player_id = player.player_id
1320
1321            if player_id in self._players:
1322                msg = f"Player {player_id} is already registered!"
1323                raise AlreadyRegisteredError(msg)
1324
1325            # ignore disabled players
1326            if not player.state.enabled:
1327                return
1328
1329            # register throttler for this player
1330            self._player_throttlers[player_id] = Throttler(1, 0.05)
1331
1332            # restore 'fake' power state from cache if available
1333            cached_value = await self.mass.cache.get(
1334                key=player.player_id,
1335                provider=self.domain,
1336                category=CACHE_CATEGORY_PLAYER_POWER,
1337                default=False,
1338            )
1339            if cached_value is not None:
1340                player.extra_data[ATTR_FAKE_POWER] = cached_value
1341
1342            # finally actually register it
1343            self._players[player_id] = player
1344            # update state without signaling event first (ensure all attributes are set)
1345            player.update_state(signal_event=False)
1346
1347            # ensure we fetch and set the latest/full config for the player
1348            player_config = await self.mass.config.get_player_config(player_id)
1349            player.set_config(player_config)
1350            # call hook after the player is registered and config is set
1351            await player.on_config_updated()
1352
1353            # Handle protocol linking
1354            # First enrich identifiers with real MAC (resolves virtual MACs via ARP)
1355            await self._enrich_player_identifiers(player)
1356            self._evaluate_protocol_links(player)
1357
1358            self.logger.info(
1359                "Player (type %s) registered: %s/%s",
1360                player.state.type.value,
1361                player_id,
1362                player.state.name,
1363            )
1364            # signal event that a player was added
1365
1366            if player.state.type != PlayerType.PROTOCOL:
1367                self.mass.signal_event(
1368                    EventType.PLAYER_ADDED, object_id=player.player_id, data=player
1369                )
1370
1371            # register playerqueue for this player
1372            # Skip if this is a protocol player pending evaluation (queue created when promoted)
1373            if (
1374                player.state.type != PlayerType.PROTOCOL
1375                and player.player_id not in self._pending_protocol_evaluations
1376            ):
1377                await self.mass.player_queues.on_player_register(player)
1378
1379        # always call update to fix special attributes like display name, group volume etc.
1380        player.update_state()
1381
1382        # Schedule debounced update of all players since can_group_with values may change
1383        # when a new player is added (provider IDs expand to include the new player)
1384        self._schedule_update_all_players()
1385
1386    async def register_or_update(self, player: Player) -> None:
1387        """Register a new player on the controller or update existing one."""
1388        if self.mass.closing:
1389            return
1390
1391        if player.player_id in self._players:
1392            self._players[player.player_id] = player
1393            player.update_state()
1394            # Also schedule update when replacing existing player
1395            self._schedule_update_all_players()
1396            return
1397
1398        await self.register(player)
1399
1400    def trigger_player_update(
1401        self, player_id: str, force_update: bool = False, debounce_delay: float = 0.25
1402    ) -> None:
1403        """Trigger a (debounced) update for the given player."""
1404        if self.mass.closing:
1405            return
1406        if not (player := self.get_player(player_id)):
1407            return
1408        task_id = f"player_update_state_{player_id}"
1409        self.mass.call_later(
1410            debounce_delay,
1411            player.update_state,
1412            force_update=force_update,
1413            task_id=task_id,
1414        )
1415
1416    async def unregister(self, player_id: str, permanent: bool = False) -> None:
1417        """
1418        Unregister a player from the player controller.
1419
1420        Called (by a PlayerProvider) when a player is removed or no longer available
1421        (for a longer period of time). This will remove the player from the player
1422        controller and optionally remove the player's config from the mass config.
1423        If the player is not registered, this will silently be ignored.
1424
1425        :param player_id: Player ID of the player to unregister.
1426        :param permanent: If True, remove the player permanently by deleting its config.
1427                          If False, the player config will not be removed.
1428        """
1429        player = self._players.get(player_id)
1430        if player is None:
1431            return
1432        await self._cleanup_player_memberships(player_id)
1433        del self._players[player_id]
1434        self.mass.player_queues.on_player_remove(player_id, permanent=permanent)
1435        await player.on_unload()
1436        if permanent:
1437            # player permanent removal: cleanup protocol links, delete config
1438            # and signal PLAYER_REMOVED event
1439            self._cleanup_protocol_links(player)
1440            self.delete_player_config(player_id)
1441            self.logger.info("Player removed: %s", player.name)
1442            if player.state.type != PlayerType.PROTOCOL:
1443                self.mass.signal_event(EventType.PLAYER_REMOVED, player_id)
1444        else:
1445            # temporary unavailable: mark player as unavailable
1446            # note: the player will be re-registered later if it comes back online
1447            player.state.available = False
1448            self.logger.info("Player unavailable: %s", player.name)
1449            if player.state.type != PlayerType.PROTOCOL:
1450                self.mass.signal_event(
1451                    EventType.PLAYER_UPDATED, object_id=player.player_id, data=player.state
1452                )
1453        # Schedule debounced update of all players since can_group_with values may change
1454        self._schedule_update_all_players()
1455
1456    @api_command("players/remove", required_role="admin")
1457    async def remove(self, player_id: str) -> None:
1458        """
1459        Remove a player from a provider.
1460
1461        Can only be called when a PlayerProvider supports ProviderFeature.REMOVE_PLAYER.
1462        """
1463        player = self.get_player(player_id)
1464        if player is None:
1465            # we simply permanently delete the player config since it is not registered
1466            self.delete_player_config(player_id)
1467            return
1468        if player.state.type == PlayerType.GROUP:
1469            # Handle group player removal
1470            player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1471            await player.provider.remove_group_player(player_id)
1472            return
1473        player.provider.check_feature(ProviderFeature.REMOVE_PLAYER)
1474        await player.provider.remove_player(player_id)
1475        # check for group memberships that need to be updated
1476        if player.state.active_group and (
1477            group_player := self.mass.players.get_player(player.state.active_group)
1478        ):
1479            # try to remove from the group
1480            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1481                await group_player.set_members(
1482                    player_ids_to_remove=[player_id],
1483                )
1484        # We removed the player and can now clean up its config
1485        self.delete_player_config(player_id)
1486
1487    def delete_player_config(self, player_id: str) -> None:
1488        """
1489        Permanently delete a player's configuration.
1490
1491        Should only be called for players that are not registered by the player controller.
1492        """
1493        # we simply permanently delete the player by wiping its config
1494        conf_key = f"{CONF_PLAYERS}/{player_id}"
1495        dsp_conf_key = f"{CONF_PLAYER_DSP}/{player_id}"
1496        for key in (conf_key, dsp_conf_key):
1497            self.mass.config.remove(key)
1498
1499    def signal_player_state_update(
1500        self,
1501        player: Player,
1502        changed_values: dict[str, tuple[Any, Any]],
1503        force_update: bool = False,
1504        skip_forward: bool = False,
1505    ) -> None:
1506        """
1507        Signal a player state update.
1508
1509        Called by a Player when its state has changed.
1510        This will update the player state in the controller and signal the event bus.
1511        """
1512        player_id = player.player_id
1513        if self.mass.closing:
1514            return
1515
1516        # ignore updates for disabled players
1517        if not player.state.enabled and ATTR_ENABLED not in changed_values:
1518            return
1519
1520        if len(changed_values) == 0 and not force_update:
1521            # nothing changed
1522            return
1523
1524        # always signal update to the playerqueue
1525        if player.state.type != PlayerType.PROTOCOL:
1526            self.mass.player_queues.on_player_update(player, changed_values)
1527
1528        # to prevent spamming the eventbus on small changes (e.g. elapsed time),
1529        # we check if there are only changes in the elapsed time
1530        clean_changed_keys = set(changed_values.keys()) - {"current_media.elapsed_time"}
1531        if clean_changed_keys == {ATTR_ELAPSED_TIME} and not force_update:
1532            # ignore small changes in elapsed time
1533            prev_value = changed_values[ATTR_ELAPSED_TIME][0] or 0
1534            new_value = changed_values[ATTR_ELAPSED_TIME][1] or 0
1535            if abs(prev_value - new_value) < 5:
1536                return
1537
1538        # handle DSP reload of the leader when grouping/ungrouping
1539        if ATTR_GROUP_MEMBERS in changed_values:
1540            prev_group_members, new_group_members = changed_values[ATTR_GROUP_MEMBERS]
1541            self._handle_group_dsp_change(player, prev_group_members or [], new_group_members)
1542
1543        if ATTR_GROUP_MEMBERS in changed_values:
1544            # Removed group members also need to be updated since they are no longer part
1545            # of this group and are available for playback again
1546            prev_group_members = changed_values[ATTR_GROUP_MEMBERS][0] or []
1547            new_group_members = changed_values[ATTR_GROUP_MEMBERS][1] or []
1548            removed_members = set(prev_group_members) - set(new_group_members)
1549            for _removed_player_id in removed_members:
1550                if removed_player := self.get_player(_removed_player_id):
1551                    removed_player.update_state()
1552
1553        # Handle external source takeover - detect when active_source changes to
1554        # something external while we have a grouped protocol active
1555        if ATTR_ACTIVE_SOURCE in changed_values:
1556            prev_source, new_source = changed_values[ATTR_ACTIVE_SOURCE]
1557            task_id = f"external_source_takeover_{player_id}"
1558            self.mass.call_later(
1559                3,
1560                self._handle_external_source_takeover,
1561                player,
1562                prev_source,
1563                new_source,
1564                task_id=task_id,
1565            )
1566        became_inactive = False
1567        if ATTR_AVAILABLE in changed_values:
1568            became_inactive = changed_values[ATTR_AVAILABLE][1] is False
1569        if not became_inactive and ATTR_ENABLED in changed_values:
1570            became_inactive = changed_values[ATTR_ENABLED][1] is False
1571        if became_inactive and (player.state.active_group or player.state.synced_to):
1572            self.mass.create_task(self._cleanup_player_memberships(player.player_id))
1573
1574        # signal player update on the eventbus
1575        if player.state.type != PlayerType.PROTOCOL:
1576            self.mass.signal_event(EventType.PLAYER_UPDATED, object_id=player_id, data=player)
1577
1578        # signal a separate PlayerOptionsUpdated event
1579        if options := changed_values.get("options"):
1580            self.mass.signal_event(
1581                EventType.PLAYER_OPTIONS_UPDATED, object_id=player_id, data=options
1582            )
1583
1584        if skip_forward and not force_update:
1585            return
1586
1587        # update/signal group player(s) child's when group updates
1588        for child_player in self.iter_group_members(player, exclude_self=True):
1589            self.trigger_player_update(child_player.player_id)
1590        # update/signal group player(s) when child updates
1591        for group_player in self._get_player_groups(player, powered_only=False):
1592            self.trigger_player_update(group_player.player_id)
1593        # update/signal manually synced to player when child updates
1594        if (synced_to := player.state.synced_to) and (
1595            synced_to_player := self.get_player(synced_to)
1596        ):
1597            self.trigger_player_update(synced_to_player.player_id)
1598        # update/signal active groups when a group member updates
1599        if (active_group := player.state.active_group) and (
1600            active_group_player := self.get_player(active_group)
1601        ):
1602            self.trigger_player_update(active_group_player.player_id)
1603        # If this is a protocol player, forward the state update to the parent player
1604        if player.protocol_parent_id and (
1605            parent_player := self.mass.players.get_player(player.protocol_parent_id)
1606        ):
1607            self.trigger_player_update(parent_player.player_id)
1608        # If this is a parent player with linked protocols, forward state updates
1609        # to linked protocol players so their state reflects parent dependencies
1610        if player.state.type != PlayerType.PROTOCOL and player.linked_output_protocols:
1611            for linked in player.linked_output_protocols:
1612                if protocol_player := self.mass.players.get_player(linked.output_protocol_id):
1613                    self.mass.players.trigger_player_update(protocol_player.player_id)
1614        # trigger update of all players in a provider if group related fields changed
1615        if any(key in changed_values for key in ("group_members", "synced_to", "available")):
1616            for prov_player in player.provider.players:
1617                self.trigger_player_update(prov_player.player_id)
1618
1619    async def register_player_control(self, player_control: PlayerControl) -> None:
1620        """Register a new PlayerControl on the controller."""
1621        if self.mass.closing:
1622            return
1623        control_id = player_control.id
1624
1625        if control_id in self._controls:
1626            msg = f"PlayerControl {control_id} is already registered"
1627            raise AlreadyRegisteredError(msg)
1628
1629        # make sure that the playercontrol's provider is set to the instance_id
1630        prov = self.mass.get_provider(player_control.provider)
1631        if not prov or prov.instance_id != player_control.provider:
1632            raise RuntimeError(f"Invalid provider ID given: {player_control.provider}")
1633
1634        self._controls[control_id] = player_control
1635
1636        self.logger.info(
1637            "PlayerControl registered: %s/%s",
1638            control_id,
1639            player_control.name,
1640        )
1641
1642        # always call update to update any attached players etc.
1643        self.update_player_control(player_control.id)
1644
1645    async def register_or_update_player_control(self, player_control: PlayerControl) -> None:
1646        """Register a new playercontrol on the controller or update existing one."""
1647        if self.mass.closing:
1648            return
1649        if player_control.id in self._controls:
1650            self._controls[player_control.id] = player_control
1651            self.update_player_control(player_control.id)
1652            return
1653        await self.register_player_control(player_control)
1654
1655    def update_player_control(self, control_id: str) -> None:
1656        """Update playercontrol state."""
1657        if self.mass.closing:
1658            return
1659        # update all players that are using this control
1660        for player in list(self._players.values()):
1661            if control_id in (
1662                player.state.power_control,
1663                player.state.volume_control,
1664                player.state.mute_control,
1665            ):
1666                self.mass.loop.call_soon(player.update_state)
1667
1668    def remove_player_control(self, control_id: str) -> None:
1669        """Remove a player_control from the player manager."""
1670        control = self._controls.pop(control_id, None)
1671        if control is None:
1672            return
1673        self._controls.pop(control_id, None)
1674        self.logger.info("PlayerControl removed: %s", control.name)
1675
1676    def get_player_provider(self, player_id: str) -> PlayerProvider:
1677        """Return PlayerProvider for given player."""
1678        player = self._players[player_id]
1679        assert player  # for type checker
1680        return player.provider
1681
1682    def get_active_queue(self, player: Player) -> PlayerQueue | None:
1683        """Return the current active queue for a player (if any)."""
1684        # account for player that is synced (sync child)
1685        if player.synced_to and player.synced_to != player.player_id:
1686            if sync_leader := self.get_player(player.synced_to):
1687                return self.get_active_queue(sync_leader)
1688        # handle active group player
1689        if player.state.active_group and player.state.active_group != player.player_id:
1690            if group_player := self.get_player(player.state.active_group):
1691                return self.get_active_queue(group_player)
1692        # active_source may be filled queue id (or None)
1693        active_source = player.state.active_source or player.player_id
1694        if active_queue := self.mass.player_queues.get(active_source):
1695            return active_queue
1696        # handle active protocol player with parent player queue
1697        if player.type == PlayerType.PROTOCOL and player.protocol_parent_id:
1698            if parent_player := self.mass.players.get_player(player.protocol_parent_id):
1699                return self.get_active_queue(parent_player)
1700        return None
1701
1702    async def set_group_volume(self, group_player: Player, volume_level: int) -> None:
1703        """Handle adjusting the overall/group volume to a playergroup (or synced players)."""
1704        cur_volume = group_player.state.group_volume
1705        volume_dif = volume_level - cur_volume
1706        coros = []
1707        # handle group volume by only applying the volume to powered members
1708        for child_player in self.iter_group_members(
1709            group_player, only_powered=True, exclude_self=False
1710        ):
1711            if child_player.state.volume_control == PLAYER_CONTROL_NONE:
1712                continue
1713            cur_child_volume = child_player.state.volume_level or 0
1714            new_child_volume = int(cur_child_volume + volume_dif)
1715            new_child_volume = max(0, new_child_volume)
1716            new_child_volume = min(100, new_child_volume)
1717            # Use private method to skip permission check - already validated on group
1718            # ATTR_MUTE_LOCK on muted players prevents auto-unmute during group volume changes
1719            coros.append(self._handle_cmd_volume_set(child_player.player_id, new_child_volume))
1720        await asyncio.gather(*coros)
1721
1722    def get_announcement_volume(self, player_id: str, volume_override: int | None) -> int | None:
1723        """Get the (player specific) volume for a announcement."""
1724        volume_strategy = self.mass.config.get_raw_player_config_value(
1725            player_id,
1726            CONF_ENTRY_ANNOUNCE_VOLUME_STRATEGY.key,
1727            CONF_ENTRY_ANNOUNCE_VOLUME_STRATEGY.default_value,
1728        )
1729        volume_strategy_volume = self.mass.config.get_raw_player_config_value(
1730            player_id,
1731            CONF_ENTRY_ANNOUNCE_VOLUME.key,
1732            CONF_ENTRY_ANNOUNCE_VOLUME.default_value,
1733        )
1734        if volume_strategy == "none":
1735            return None
1736        volume_level = volume_override
1737        if volume_level is None and volume_strategy == "absolute":
1738            volume_level = int(cast("float", volume_strategy_volume))
1739        elif volume_level is None and volume_strategy == "relative":
1740            if (player := self.get_player(player_id)) and player.state.volume_level is not None:
1741                volume_level = int(
1742                    player.state.volume_level + cast("float", volume_strategy_volume)
1743                )
1744        elif volume_level is None and volume_strategy == "percentual":
1745            if (player := self.get_player(player_id)) and player.state.volume_level is not None:
1746                percentual = (player.state.volume_level / 100) * cast(
1747                    "float", volume_strategy_volume
1748                )
1749                volume_level = int(player.state.volume_level + percentual)
1750        if volume_level is not None:
1751            announce_volume_min = cast(
1752                "float",
1753                self.mass.config.get_raw_player_config_value(
1754                    player_id,
1755                    CONF_ENTRY_ANNOUNCE_VOLUME_MIN.key,
1756                    CONF_ENTRY_ANNOUNCE_VOLUME_MIN.default_value,
1757                ),
1758            )
1759            volume_level = max(int(announce_volume_min), volume_level)
1760            announce_volume_max = cast(
1761                "float",
1762                self.mass.config.get_raw_player_config_value(
1763                    player_id,
1764                    CONF_ENTRY_ANNOUNCE_VOLUME_MAX.key,
1765                    CONF_ENTRY_ANNOUNCE_VOLUME_MAX.default_value,
1766                ),
1767            )
1768            volume_level = min(int(announce_volume_max), volume_level)
1769        return None if volume_level is None else int(volume_level)
1770
1771    def iter_group_members(
1772        self,
1773        group_player: Player,
1774        only_powered: bool = False,
1775        only_playing: bool = False,
1776        active_only: bool = False,
1777        exclude_self: bool = True,
1778    ) -> Iterator[Player]:
1779        """Get (child) players attached to a group player or syncgroup."""
1780        for child_id in list(group_player.state.group_members):
1781            if child_player := self.get_player(child_id, False):
1782                if not child_player.state.available or not child_player.state.enabled:
1783                    continue
1784                if only_powered and child_player.state.powered is False:
1785                    continue
1786                if active_only and child_player.state.active_group != group_player.player_id:
1787                    continue
1788                if exclude_self and child_player.player_id == group_player.player_id:
1789                    continue
1790                if only_playing and child_player.state.playback_state not in (
1791                    PlaybackState.PLAYING,
1792                    PlaybackState.PAUSED,
1793                ):
1794                    continue
1795                yield child_player
1796
1797    async def wait_for_state(
1798        self,
1799        player: Player,
1800        wanted_state: PlaybackState,
1801        timeout: float = 60.0,
1802        minimal_time: float = 0,
1803    ) -> None:
1804        """Wait for the given player to reach the given state."""
1805        start_timestamp = time.time()
1806        self.logger.debug(
1807            "Waiting for player %s to reach state %s", player.state.name, wanted_state
1808        )
1809        try:
1810            async with asyncio.timeout(timeout):
1811                while player.state.playback_state != wanted_state:
1812                    await asyncio.sleep(0.1)
1813
1814        except TimeoutError:
1815            self.logger.debug(
1816                "Player %s did not reach state %s within the timeout of %s seconds",
1817                player.state.name,
1818                wanted_state,
1819                timeout,
1820            )
1821        elapsed_time = round(time.time() - start_timestamp, 2)
1822        if elapsed_time < minimal_time:
1823            self.logger.debug(
1824                "Player %s reached state %s too soon (%s vs %s seconds) - add fallback sleep...",
1825                player.state.name,
1826                wanted_state,
1827                elapsed_time,
1828                minimal_time,
1829            )
1830            await asyncio.sleep(minimal_time - elapsed_time)
1831        else:
1832            self.logger.debug(
1833                "Player %s reached state %s within %s seconds",
1834                player.state.name,
1835                wanted_state,
1836                elapsed_time,
1837            )
1838
1839    async def on_player_config_change(self, config: PlayerConfig, changed_keys: set[str]) -> None:
1840        """Call (by config manager) when the configuration of a player changes."""
1841        player = self.get_player(config.player_id)
1842        player_provider = self.mass.get_provider(config.provider)
1843        player_disabled = ATTR_ENABLED in changed_keys and not config.enabled
1844        player_enabled = ATTR_ENABLED in changed_keys and config.enabled
1845
1846        if player_disabled and player and player.state.available:
1847            # edge case: ensure that the player is powered off if the player gets disabled
1848            if player.state.power_control != PLAYER_CONTROL_NONE:
1849                await self._handle_cmd_power(config.player_id, False)
1850            elif player.state.playback_state != PlaybackState.IDLE:
1851                await self.cmd_stop(config.player_id)
1852
1853        # signal player provider that the player got enabled/disabled
1854        if (player_enabled or player_disabled) and player_provider:
1855            assert isinstance(player_provider, PlayerProvider)  # for type checking
1856            if player_disabled:
1857                player_provider.on_player_disabled(config.player_id)
1858            elif player_enabled:
1859                player_provider.on_player_enabled(config.player_id)
1860            return  # enabling/disabling a player will be handled by the provider
1861
1862        if not player:
1863            return  # guard against player not being registered (yet)
1864
1865        resume_queue: PlayerQueue | None = (
1866            self.mass.player_queues.get(player.state.active_source)
1867            if player.state.active_source
1868            else None
1869        )
1870
1871        # ensure player state gets updated with any updated config
1872        player.set_config(config)
1873        await player.on_config_updated()
1874        player.update_state()
1875        # if the PlayerQueue was playing, restart playback
1876        if resume_queue and resume_queue.state == PlaybackState.PLAYING:
1877            requires_restart = any(
1878                v for v in config.values.values() if v.key in changed_keys and v.requires_reload
1879            )
1880            if requires_restart:
1881                # always stop first to ensure the player uses the new config
1882                await self.mass.player_queues.stop(resume_queue.queue_id)
1883                self.mass.call_later(
1884                    1, self.mass.player_queues.resume, resume_queue.queue_id, False
1885                )
1886
1887    async def on_player_dsp_change(self, player_id: str) -> None:
1888        """Call (by config manager) when the DSP settings of a player change."""
1889        # signal player provider that the config changed
1890        if not (player := self.get_player(player_id)):
1891            return
1892        if player.state.playback_state == PlaybackState.PLAYING:
1893            self.logger.info("Restarting playback of Player %s after DSP change", player_id)
1894            # this will restart the queue stream/playback
1895            if player.mass_queue_active:
1896                self.mass.call_later(
1897                    0, self.mass.player_queues.resume, player.state.active_source, False
1898                )
1899                return
1900            # if the player is not using a queue, we need to stop and start playback
1901            await self.cmd_stop(player_id)
1902            await self.cmd_play(player_id)
1903
1904    async def _cleanup_player_memberships(self, player_id: str) -> None:
1905        """Ensure a player is detached from any groups or syncgroups."""
1906        if not (player := self.get_player(player_id)):
1907            return
1908
1909        if (
1910            player.state.active_group
1911            and (group := self.get_player(player.state.active_group))
1912            and group.supports_feature(PlayerFeature.SET_MEMBERS)
1913        ):
1914            # Ungroup the player if its part of an active group, this will ignore
1915            # static_group_members since that is only checked when using cmd_set_members
1916            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1917                await group.set_members(player_ids_to_remove=[player_id])
1918        elif player.state.synced_to and player.supports_feature(PlayerFeature.SET_MEMBERS):
1919            # Remove the player if it was synced, otherwise it will still show as
1920            # synced to the other player after it gets registered again
1921            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1922                await player.ungroup()
1923
1924    def _get_player_with_redirect(self, player_id: str) -> Player:
1925        """Get player with check if playback related command should be redirected."""
1926        player = self.get_player(player_id, True)
1927        assert player is not None  # for type checking
1928        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
1929            self.logger.info(
1930                "Player %s is synced to %s and can not accept "
1931                "playback related commands itself, "
1932                "redirected the command to the sync leader.",
1933                player.name,
1934                sync_leader.name,
1935            )
1936            return sync_leader
1937        if player.state.active_group and (
1938            active_group := self.get_player(player.state.active_group)
1939        ):
1940            self.logger.info(
1941                "Player %s is part of a playergroup and can not accept "
1942                "playback related commands itself, "
1943                "redirected the command to the group leader.",
1944                player.name,
1945            )
1946            return active_group
1947        return player
1948
1949    def _get_active_plugin_source(self, player: Player) -> PluginSource | None:
1950        """Get the active PluginSource for a player if any."""
1951        # Check if any plugin source is in use by this player
1952        for plugin_source in self.get_plugin_sources():
1953            if plugin_source.in_use_by == player.player_id:
1954                return plugin_source
1955            if player.state.active_source == plugin_source.id:
1956                return plugin_source
1957        return None
1958
1959    def _get_player_groups(
1960        self, player: Player, available_only: bool = True, powered_only: bool = False
1961    ) -> Iterator[Player]:
1962        """Return all groupplayers the given player belongs to."""
1963        for _player in self.all_players(return_unavailable=not available_only):
1964            if _player.player_id == player.player_id:
1965                continue
1966            if _player.state.type != PlayerType.GROUP:
1967                continue
1968            if powered_only and _player.state.powered is False:
1969                continue
1970            if player.player_id in _player.state.group_members:
1971                yield _player
1972
1973    # Protocol linking methods are provided by ProtocolLinkingMixin (protocol_linking.py)
1974
1975    async def _play_announcement(  # noqa: PLR0915
1976        self,
1977        player: Player,
1978        announcement: PlayerMedia,
1979        volume_level: int | None = None,
1980    ) -> None:
1981        """Handle (default/fallback) implementation of the play announcement feature.
1982
1983        This default implementation will;
1984        - stop playback of the current media (if needed)
1985        - power on the player (if needed)
1986        - raise the volume a bit
1987        - play the announcement (from given url)
1988        - wait for the player to finish playing
1989        - restore the previous power and volume
1990        - restore playback (if needed and if possible)
1991
1992        This default implementation will only be used if the player
1993        (provider) has no native support for the PLAY_ANNOUNCEMENT feature.
1994        """
1995        prev_state = player.state.playback_state
1996        prev_power = player.state.powered or prev_state != PlaybackState.IDLE
1997        prev_synced_to = player.state.synced_to
1998        prev_group = (
1999            self.get_player(player.state.active_group) if player.state.active_group else None
2000        )
2001        prev_source = player.state.active_source
2002        prev_media = player.state.current_media
2003        prev_media_name = prev_media.title or prev_media.uri if prev_media else None
2004        if prev_synced_to:
2005            # ungroup player if its currently synced
2006            self.logger.debug(
2007                "Announcement to player %s - ungrouping player from %s...",
2008                player.state.name,
2009                prev_synced_to,
2010            )
2011            await self.cmd_ungroup(player.player_id)
2012        elif prev_group:
2013            # if the player is part of a group player, we need to ungroup it
2014            if PlayerFeature.SET_MEMBERS in prev_group.supported_features:
2015                self.logger.debug(
2016                    "Announcement to player %s - ungrouping from group player %s...",
2017                    player.state.name,
2018                    prev_group.display_name,
2019                )
2020                await prev_group.set_members(player_ids_to_remove=[player.player_id])
2021            else:
2022                # if the player is part of a group player that does not support ungrouping,
2023                # we need to power off the groupplayer instead
2024                self.logger.debug(
2025                    "Announcement to player %s - turning off group player %s...",
2026                    player.state.name,
2027                    prev_group.display_name,
2028                )
2029                await self._handle_cmd_power(player.player_id, False)
2030        elif prev_state in (PlaybackState.PLAYING, PlaybackState.PAUSED):
2031            # normal/standalone player: stop player if its currently playing
2032            self.logger.debug(
2033                "Announcement to player %s - stop existing content (%s)...",
2034                player.state.name,
2035                prev_media_name,
2036            )
2037            await self.cmd_stop(player.player_id)
2038            # wait for the player to stop
2039            await self.wait_for_state(player, PlaybackState.IDLE, 10, 0.4)
2040        # adjust volume if needed
2041        # in case of a (sync) group, we need to do this for all child players
2042        prev_volumes: dict[str, int] = {}
2043        async with TaskManager(self.mass) as tg:
2044            for volume_player_id in player.state.group_members or (player.player_id,):
2045                if not (volume_player := self.get_player(volume_player_id)):
2046                    continue
2047                # catch any players that have a different source active
2048                if (
2049                    volume_player.state.active_source
2050                    not in (
2051                        player.state.active_source,
2052                        volume_player.player_id,
2053                        None,
2054                    )
2055                    and volume_player.state.playback_state == PlaybackState.PLAYING
2056                ):
2057                    self.logger.warning(
2058                        "Detected announcement to playergroup %s while group member %s is playing "
2059                        "other content, this may lead to unexpected behavior.",
2060                        player.state.name,
2061                        volume_player.state.name,
2062                    )
2063                    tg.create_task(self.cmd_stop(volume_player.player_id))
2064                if volume_player.state.volume_control == PLAYER_CONTROL_NONE:
2065                    continue
2066                if (prev_volume := volume_player.state.volume_level) is None:
2067                    continue
2068                announcement_volume = self.get_announcement_volume(volume_player_id, volume_level)
2069                if announcement_volume is None:
2070                    continue
2071                temp_volume = announcement_volume or player.state.volume_level
2072                if temp_volume != prev_volume:
2073                    prev_volumes[volume_player_id] = prev_volume
2074                    self.logger.debug(
2075                        "Announcement to player %s - setting temporary volume (%s)...",
2076                        volume_player.state.name,
2077                        announcement_volume,
2078                    )
2079                    tg.create_task(
2080                        self._handle_cmd_volume_set(volume_player.player_id, announcement_volume)
2081                    )
2082        # play the announcement
2083        self.logger.debug(
2084            "Announcement to player %s - playing the announcement on the player...",
2085            player.state.name,
2086        )
2087        await self.play_media(player_id=player.player_id, media=announcement)
2088        # wait for the player(s) to play
2089        await self.wait_for_state(player, PlaybackState.PLAYING, 10, minimal_time=0.1)
2090        # wait for the player to stop playing
2091        if not announcement.duration:
2092            if not announcement.custom_data:
2093                raise ValueError("Announcement missing duration and custom_data")
2094            media_info = await async_parse_tags(
2095                announcement.custom_data["announcement_url"], require_duration=True
2096            )
2097            announcement.duration = int(media_info.duration) if media_info.duration else None
2098
2099        if announcement.duration is None:
2100            raise ValueError("Announcement duration could not be determined")
2101
2102        await self.wait_for_state(
2103            player,
2104            PlaybackState.IDLE,
2105            timeout=announcement.duration + 10,
2106            minimal_time=float(announcement.duration) + 2,
2107        )
2108        self.logger.debug(
2109            "Announcement to player %s - restore previous state...", player.state.name
2110        )
2111        # restore volume
2112        async with TaskManager(self.mass) as tg:
2113            for volume_player_id, prev_volume in prev_volumes.items():
2114                tg.create_task(self._handle_cmd_volume_set(volume_player_id, prev_volume))
2115        await asyncio.sleep(0.2)
2116        # either power off the player or resume playing
2117        if not prev_power:
2118            if player.state.power_control != PLAYER_CONTROL_NONE:
2119                self.logger.debug(
2120                    "Announcement to player %s - turning player off again...", player.state.name
2121                )
2122                await self._handle_cmd_power(player.player_id, False)
2123            # nothing to do anymore, player was not previously powered
2124            # and does not support power control
2125            return
2126        if prev_synced_to:
2127            self.logger.debug(
2128                "Announcement to player %s - syncing back to %s...",
2129                player.state.name,
2130                prev_synced_to,
2131            )
2132            await self.cmd_set_members(prev_synced_to, player_ids_to_add=[player.player_id])
2133        elif prev_group:
2134            if PlayerFeature.SET_MEMBERS in prev_group.supported_features:
2135                self.logger.debug(
2136                    "Announcement to player %s - grouping back to group player %s...",
2137                    player.state.name,
2138                    prev_group.display_name,
2139                )
2140                await prev_group.set_members(player_ids_to_add=[player.player_id])
2141            elif prev_state == PlaybackState.PLAYING:
2142                # if the player is part of a group player that does not support set_members,
2143                # we need to restart the groupplayer
2144                self.logger.debug(
2145                    "Announcement to player %s - restarting playback on group player %s...",
2146                    player.state.name,
2147                    prev_group.display_name,
2148                )
2149                await self.cmd_play(prev_group.player_id)
2150        elif prev_state == PlaybackState.PLAYING:
2151            # player was playing something before the announcement - try to resume that here
2152            await self._handle_cmd_resume(player.player_id, prev_source, prev_media)
2153
2154    async def _poll_players(self) -> None:
2155        """Background task that polls players for updates."""
2156        while True:
2157            for player in list(self._players.values()):
2158                # if the player is playing, update elapsed time every tick
2159                # to ensure the queue has accurate details
2160                player_playing = player.state.playback_state == PlaybackState.PLAYING
2161                if player_playing:
2162                    self.mass.loop.call_soon(
2163                        self.mass.player_queues.on_player_update,
2164                        player,
2165                        {"corrected_elapsed_time": (None, player.corrected_elapsed_time)},
2166                    )
2167                # Poll player;
2168                if not player.needs_poll:
2169                    continue
2170                try:
2171                    last_poll: float = player.extra_data[ATTR_LAST_POLL]
2172                except KeyError:
2173                    last_poll = 0.0
2174                if (self.mass.loop.time() - last_poll) < player.poll_interval:
2175                    continue
2176                player.extra_data[ATTR_LAST_POLL] = self.mass.loop.time()
2177                try:
2178                    await player.poll()
2179                except Exception as err:
2180                    self.logger.warning(
2181                        "Error while requesting latest state from player %s: %s",
2182                        player.state.name,
2183                        str(err),
2184                        exc_info=err if self.logger.isEnabledFor(10) else None,
2185                    )
2186                # Yield to event loop to prevent blocking
2187                await asyncio.sleep(0)
2188            await asyncio.sleep(1)
2189
2190    async def _handle_select_plugin_source(
2191        self, player: Player, plugin_prov: PluginProvider
2192    ) -> None:
2193        """Handle playback/select of given plugin source on player."""
2194        plugin_source = plugin_prov.get_source()
2195        if plugin_source.in_use_by and plugin_source.in_use_by != player.player_id:
2196            self.logger.debug(
2197                "Plugin source %s is already in use by player %s, stopping playback there first.",
2198                plugin_source.name,
2199                plugin_source.in_use_by,
2200            )
2201            with suppress(PlayerCommandFailed):
2202                await self.cmd_stop(plugin_source.in_use_by)
2203        stream_url = await self.mass.streams.get_plugin_source_url(plugin_source, player.player_id)
2204        plugin_source.in_use_by = player.player_id
2205        # Call on_select callback if available
2206        if plugin_source.on_select:
2207            await plugin_source.on_select()
2208        await self.play_media(
2209            player_id=player.player_id,
2210            media=PlayerMedia(
2211                uri=stream_url,
2212                media_type=MediaType.PLUGIN_SOURCE,
2213                title=plugin_source.name,
2214                custom_data={
2215                    "provider": plugin_prov.instance_id,
2216                    "source_id": plugin_source.id,
2217                    "player_id": player.player_id,
2218                    "audio_format": plugin_source.audio_format,
2219                },
2220            ),
2221        )
2222        # trigger player update to ensure the source is set
2223        self.trigger_player_update(player.player_id)
2224
2225    def _handle_group_dsp_change(
2226        self, player: Player, prev_group_members: list[str], new_group_members: list[str]
2227    ) -> None:
2228        """Handle DSP reload when group membership changes."""
2229        prev_child_count = len(prev_group_members)
2230        new_child_count = len(new_group_members)
2231        is_player_group = player.state.type == PlayerType.GROUP
2232
2233        # handle special case for PlayerGroups: since there are no leaders,
2234        # DSP still always work with a single player in the group.
2235        multi_device_dsp_threshold = 1 if is_player_group else 0
2236
2237        prev_is_multiple_devices = prev_child_count > multi_device_dsp_threshold
2238        new_is_multiple_devices = new_child_count > multi_device_dsp_threshold
2239
2240        if prev_is_multiple_devices == new_is_multiple_devices:
2241            return  # no change in multi-device status
2242
2243        supports_multi_device_dsp = (
2244            PlayerFeature.MULTI_DEVICE_DSP in player.state.supported_features
2245        )
2246
2247        dsp_enabled: bool
2248        if player.state.type == PlayerType.GROUP:
2249            # Since player groups do not have leaders, we will use the only child
2250            # that was in the group before and after the change
2251            if prev_is_multiple_devices:
2252                if childs := new_group_members:
2253                    # We shrank the group from multiple players to a single player
2254                    # So the now only child will control the DSP
2255                    dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2256                else:
2257                    dsp_enabled = False
2258            elif childs := prev_group_members:
2259                # We grew the group from a single player to multiple players,
2260                # let's see if the previous single player had DSP enabled
2261                dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
2262            else:
2263                dsp_enabled = False
2264        else:
2265            dsp_enabled = self.mass.config.get_player_dsp_config(player.player_id).enabled
2266
2267        if dsp_enabled and not supports_multi_device_dsp:
2268            # We now know that the group configuration has changed so:
2269            # - multi-device DSP is not supported
2270            # - we switched from a group with multiple players to a single player
2271            #   (or vice versa)
2272            # - the leader has DSP enabled
2273            self.mass.create_task(self.mass.players.on_player_dsp_change(player.player_id))
2274
2275    def _handle_external_source_takeover(
2276        self, player: Player, prev_source: str | None, new_source: str | None
2277    ) -> None:
2278        """
2279        Handle when an external source takes over playback on a player.
2280
2281        When a player has an active grouped output protocol (e.g., AirPlay group) and
2282        an external source (e.g., Spotify Connect, TV input) takes over playback,
2283        we need to clear the active output protocol and ungroup the protocol players.
2284
2285        This prevents the situation where the player appears grouped via protocol
2286        but is actually playing from a different source.
2287
2288        :param player: The player whose active_source changed.
2289        :param prev_source: The previous active_source value.
2290        :param new_source: The new active_source value.
2291        """
2292        # Only relevant for non-protocol players
2293        if player.type == PlayerType.PROTOCOL:
2294            return
2295
2296        # Not a takeover if the player is not actively playing
2297        if player.playback_state != PlaybackState.PLAYING:
2298            return
2299
2300        # Only relevant if we have an active output protocol (not native)
2301        if not player.active_output_protocol or player.active_output_protocol == "native":
2302            return
2303
2304        # Check if new source is external (not MA-managed)
2305        if self._is_ma_managed_source(player, new_source):
2306            return
2307
2308        # Get the active protocol player
2309        protocol_player = self.get_player(player.active_output_protocol)
2310        if not protocol_player:
2311            return
2312
2313        # If the source matches the active protocol's domain, it's expected - not a takeover
2314        # e.g., source "airplay" when using AirPlay protocol is normal
2315        if new_source and new_source.lower() == protocol_player.provider.domain.lower():
2316            return
2317
2318        # Confirmed external source takeover
2319        self.logger.info(
2320            "External source '%s' took over on %s while grouped via protocol %s - "
2321            "clearing active output protocol and ungrouping",
2322            new_source,
2323            player.display_name,
2324            protocol_player.provider.domain,
2325        )
2326
2327        # Clear active output protocol
2328        player.set_active_output_protocol(None)
2329
2330        # Ungroup the protocol player (async task)
2331        self.mass.create_task(protocol_player.ungroup())
2332
2333    def _is_ma_managed_source(self, player: Player, source: str | None) -> bool:
2334        """
2335        Check if a source is managed by Music Assistant.
2336
2337        MA-managed sources include:
2338        - None (=autodetect, no source explicitly set by player)
2339        - The player's own ID (MA queue)
2340        - Any active queue ID
2341        - Any plugin source ID
2342
2343        :param player: The player to check.
2344        :param source: The source ID to check.
2345        :return: True if the source is MA-managed, False if external.
2346        """
2347        if source is None:
2348            return True
2349
2350        # Player's own ID means MA queue is active
2351        if source == player.player_id:
2352            return True
2353
2354        # Check if it's a known queue ID
2355        if self.mass.player_queues.get(source):
2356            return True
2357
2358        # Check if it's a plugin source
2359        return any(plugin_source.id == source for plugin_source in self.get_plugin_sources())
2360
2361    def _schedule_update_all_players(self, delay: float = 2.0) -> None:
2362        """
2363        Schedule a debounced update of all players' state.
2364
2365        Used when a new player is registered to ensure all existing players
2366        update their dynamic properties (like can_group_with) that may have changed.
2367
2368        :param delay: Delay in seconds before triggering updates (default 2.0).
2369        """
2370        if self.mass.closing:
2371            return
2372
2373        async def _update_all_players() -> None:
2374            if self.mass.closing:
2375                return
2376
2377            for player in self.all_players(
2378                return_unavailable=True,
2379                return_disabled=False,
2380                return_protocol_players=True,
2381            ):
2382                # Use call_soon to schedule updates without blocking
2383                # This spreads the updates across event loop iterations
2384                self.mass.loop.call_soon(player.update_state)
2385
2386        # Use mass.call_later with task_id for automatic debouncing
2387        # Each call resets the timer, so rapid registrations only trigger one update
2388        task_id = "update_all_players_on_registration"
2389        self.mass.call_later(delay, _update_all_players, task_id=task_id)
2390
2391    async def _handle_set_members_with_protocols(
2392        self,
2393        parent_player: Player,
2394        player_ids_to_add: list[str],
2395        player_ids_to_remove: list[str],
2396    ) -> None:
2397        """
2398        Handle set_members considering protocol and native members.
2399
2400        Translates visible player IDs to protocol player IDs when appropriate,
2401        and forwards to the correct player's set_members.
2402
2403        :param parent_player: The parent player to add/remove members to/from.
2404        :param player_ids_to_add: List of visible player IDs to add as members.
2405        :param player_ids_to_remove: List of visible player IDs to remove from members.
2406        """
2407        # Get parent's active protocol domain and player if available
2408        parent_protocol_domain = None
2409        parent_protocol_player = None
2410        if (
2411            parent_player.active_output_protocol
2412            and parent_player.active_output_protocol != "native"
2413        ):
2414            parent_protocol_player = self.get_player(parent_player.active_output_protocol)
2415            if parent_protocol_player:
2416                parent_protocol_domain = parent_protocol_player.provider.domain
2417
2418        self.logger.debug(
2419            "set_members on %s: active_protocol=%s, adding=%s, removing=%s",
2420            parent_player.state.name,
2421            parent_protocol_domain or "none",
2422            player_ids_to_add,
2423            player_ids_to_remove,
2424        )
2425
2426        # Translate members to add
2427        (
2428            protocol_members_to_add,
2429            native_members_to_add,
2430            parent_protocol_player,
2431            parent_protocol_domain,
2432        ) = self._translate_members_for_protocols(
2433            parent_player, player_ids_to_add, parent_protocol_player, parent_protocol_domain
2434        )
2435
2436        self.logger.debug(
2437            "Translated members: protocol=%s (domain=%s), native=%s",
2438            protocol_members_to_add,
2439            parent_protocol_domain,
2440            native_members_to_add,
2441        )
2442
2443        # Translate members to remove
2444        protocol_members_to_remove, native_members_to_remove = (
2445            self._translate_members_to_remove_for_protocols(
2446                parent_player, player_ids_to_remove, parent_protocol_player, parent_protocol_domain
2447            )
2448        )
2449
2450        # Forward protocol members to protocol player's set_members
2451        if (protocol_members_to_add or protocol_members_to_remove) and parent_protocol_player:
2452            await self._forward_protocol_set_members(
2453                parent_player,
2454                parent_protocol_player,
2455                protocol_members_to_add,
2456                protocol_members_to_remove,
2457            )
2458
2459        # Forward native members to parent player's set_members
2460        if native_members_to_add or native_members_to_remove:
2461            filtered_native_add = self._filter_native_members(native_members_to_add, parent_player)
2462            # For removal, allow protocol players if they're actually in the parent's group_members
2463            # This handles native protocol players (e.g., native AirPlay) where group_members
2464            # contains protocol player IDs
2465            filtered_native_remove = [
2466                pid
2467                for pid in native_members_to_remove
2468                if (p := self.get_player(pid))
2469                and (p.type != PlayerType.PROTOCOL or pid in parent_player.group_members)
2470            ]
2471            self.logger.debug(
2472                "Native grouping on %s: filtered_add=%s, filtered_remove=%s",
2473                parent_player.state.name,
2474                filtered_native_add,
2475                filtered_native_remove,
2476            )
2477            if filtered_native_add or filtered_native_remove:
2478                self.logger.info(
2479                    "Calling set_members on native player %s with add=%s, remove=%s",
2480                    parent_player.state.name,
2481                    filtered_native_add,
2482                    filtered_native_remove,
2483                )
2484                await parent_player.set_members(
2485                    player_ids_to_add=filtered_native_add or None,
2486                    player_ids_to_remove=filtered_native_remove or None,
2487                )
2488
2489    # Private command handlers (no permission checks)
2490
2491    async def _handle_cmd_resume(
2492        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
2493    ) -> None:
2494        """
2495        Handle resume playback command.
2496
2497        Skips the permission checks (internal use only).
2498        """
2499        player = self._get_player_with_redirect(player_id)
2500        source = source or player.state.active_source
2501        media = media or player.state.current_media
2502        # power on the player if needed
2503        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
2504            await self._handle_cmd_power(player.player_id, True)
2505        # Redirect to queue controller if it is active
2506        if active_queue := self.mass.player_queues.get(source or player_id):
2507            await self.mass.player_queues.resume(active_queue.queue_id)
2508            return
2509        # try to handle command on player directly
2510        # TODO: check if player has an active source with native resume support
2511        active_source = next((x for x in player.state.source_list if x.id == source), None)
2512        if (
2513            player.state.playback_state in (PlaybackState.IDLE, PlaybackState.PAUSED)
2514            and active_source
2515            and active_source.can_play_pause
2516        ):
2517            # player has some other source active and native resume support
2518            await player.play()
2519            return
2520        if active_source and not active_source.passive:
2521            await self.select_source(player_id, active_source.id)
2522            return
2523        if media:
2524            # try to re-play the current media item
2525            await player.play_media(media)
2526            return
2527        # fallback: just send play command - which will fail if nothing can be played
2528        await player.play()
2529
2530    async def _handle_cmd_power(self, player_id: str, powered: bool) -> None:
2531        """
2532        Handle player power on/off command.
2533
2534        Skips the permission checks (internal use only).
2535        """
2536        player = self.get_player(player_id, True)
2537        assert player is not None  # for type checking
2538        player_state = player.state
2539
2540        if player_state.powered == powered:
2541            self.logger.debug(
2542                "Ignoring power %s command for player %s: already in state %s",
2543                "ON" if powered else "OFF",
2544                player_state.name,
2545                "ON" if player_state.powered else "OFF",
2546            )
2547            return  # nothing to do
2548
2549        # ungroup player at power off
2550        player_was_synced = player.state.synced_to is not None
2551        if player.type == PlayerType.PLAYER and not powered:
2552            # ungroup player if it is synced (or is a sync leader itself)
2553            # NOTE: ungroup will be ignored if the player is not grouped or synced
2554            await self.cmd_ungroup(player_id)
2555
2556        # always stop player at power off
2557        if (
2558            not powered
2559            and not player_was_synced
2560            and player_state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
2561        ):
2562            await self.cmd_stop(player_id)
2563            # short sleep: allow the stop command to process and prevent race conditions
2564            await asyncio.sleep(0.2)
2565
2566        # power off all synced childs when player is a sync leader
2567        elif not powered and player_state.type == PlayerType.PLAYER and player_state.group_members:
2568            async with TaskManager(self.mass) as tg:
2569                for member in self.iter_group_members(player, True):
2570                    if member.power_control == PLAYER_CONTROL_NONE:
2571                        continue
2572                    tg.create_task(self._handle_cmd_power(member.player_id, False))
2573
2574        # handle actual power command
2575        if player_state.power_control == PLAYER_CONTROL_NONE:
2576            self.logger.debug(
2577                "Player %s does not support power control, ignoring power command",
2578                player_state.name,
2579            )
2580            return
2581        if player_state.power_control == PLAYER_CONTROL_NATIVE:
2582            # player supports power command natively: forward to player provider
2583            await player.power(powered)
2584        elif player_state.power_control == PLAYER_CONTROL_FAKE:
2585            # user wants to use fake power control - so we (optimistically) update the state
2586            # and store the state in the cache
2587            player.extra_data[ATTR_FAKE_POWER] = powered
2588            player.update_state()  # trigger update of the player state
2589            await self.mass.cache.set(
2590                key=player_id,
2591                data=powered,
2592                provider=self.domain,
2593                category=CACHE_CATEGORY_PLAYER_POWER,
2594            )
2595        else:
2596            # handle external player control
2597            player_control = self._controls.get(player.state.power_control)
2598            control_name = player_control.name if player_control else player.state.power_control
2599            self.logger.debug("Redirecting power command to PlayerControl %s", control_name)
2600            if not player_control or not player_control.supports_power:
2601                raise UnsupportedFeaturedException(
2602                    f"Player control {control_name} is not available"
2603                )
2604            if powered:
2605                assert player_control.power_on is not None  # for type checking
2606                await player_control.power_on()
2607            else:
2608                assert player_control.power_off is not None  # for type checking
2609                await player_control.power_off()
2610
2611        # always trigger a state update to update the UI
2612        player.update_state()
2613
2614        # handle 'auto play on power on' feature
2615        if (
2616            not player_state.active_group
2617            and not player_state.synced_to
2618            and powered
2619            and player.config.get_value(CONF_AUTO_PLAY)
2620            and player_state.active_source in (None, player_id)
2621            and not player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)
2622        ):
2623            await self.mass.player_queues.resume(player_id)
2624
2625    async def _handle_cmd_volume_set(self, player_id: str, volume_level: int) -> None:
2626        """
2627        Handle Player volume set command.
2628
2629        Skips the permission checks (internal use only).
2630        """
2631        player = self.get_player(player_id, True)
2632        assert player is not None  # for type checker
2633        if player.type == PlayerType.GROUP:
2634            # redirect to special group volume control
2635            await self.cmd_group_volume(player_id, volume_level)
2636            return
2637
2638        # Check if player has mute lock (set when individually muted in a group)
2639        # If locked, don't auto-unmute when volume changes
2640        has_mute_lock = player.extra_data.get(ATTR_MUTE_LOCK, False)
2641        if (
2642            not has_mute_lock
2643            # use player.state here to get accumulated mute control from any linked protocol players
2644            and player.state.mute_control not in (PLAYER_CONTROL_NONE, PLAYER_CONTROL_FAKE)
2645            and player.state.volume_muted
2646        ):
2647            # if player is muted and not locked, we unmute it first
2648            # skip this for fake mute since it uses volume to simulate mute
2649            self.logger.debug(
2650                "Unmuting player %s before setting volume",
2651                player.state.name,
2652            )
2653            await self.cmd_volume_mute(player_id, False)
2654
2655        # Check if a plugin source is active with a volume callback
2656        if plugin_source := self._get_active_plugin_source(player):
2657            if plugin_source.on_volume:
2658                await plugin_source.on_volume(volume_level)
2659        # Handle native volume control support
2660        if player.volume_control == PLAYER_CONTROL_NATIVE:
2661            # player supports volume command natively: forward to player
2662            await player.volume_set(volume_level)
2663            return
2664        # Handle fake volume control support
2665        if player.volume_control == PLAYER_CONTROL_FAKE:
2666            # user wants to use fake volume control - so we (optimistically) update the state
2667            # and store the state in the cache
2668            player.extra_data[ATTR_FAKE_VOLUME] = volume_level
2669            # trigger update
2670            player.update_state()
2671            return
2672        # player has no volume support at all
2673        if player.volume_control == PLAYER_CONTROL_NONE:
2674            raise UnsupportedFeaturedException(
2675                f"Player {player.state.name} does not support volume control"
2676            )
2677        # handle external player control
2678        if player_control := self._controls.get(player.state.volume_control):
2679            control_name = player_control.name if player_control else player.state.volume_control
2680            self.logger.debug("Redirecting volume command to PlayerControl %s", control_name)
2681            if not player_control or not player_control.supports_volume:
2682                raise UnsupportedFeaturedException(
2683                    f"Player control {control_name} is not available"
2684                )
2685            assert player_control.volume_set is not None
2686            await player_control.volume_set(volume_level)
2687            return
2688        if protocol_player := self.get_player(player.state.volume_control):
2689            # redirect to protocol player volume control
2690            self.logger.debug(
2691                "Redirecting volume command to protocol player %s",
2692                protocol_player.provider.manifest.name,
2693            )
2694            await self._handle_cmd_volume_set(protocol_player.player_id, volume_level)
2695            return
2696
2697    async def _handle_play_media(self, player_id: str, media: PlayerMedia) -> None:
2698        """
2699        Handle play media command without group redirect.
2700
2701        Skips permission checks and all redirect logic (internal use only).
2702
2703        :param player_id: player_id of the player to handle the command.
2704        :param media: The Media that needs to be played on the player.
2705        """
2706        player = self.get_player(player_id, raise_unavailable=True)
2707        assert player is not None
2708        # set active source if media has a source_id (e.g. plugin source or mass queue source)
2709        if media.source_id:
2710            player.set_active_mass_source(media.source_id)
2711
2712        # Select best output protocol for playback
2713        target_player, output_protocol = self._select_best_output_protocol(player)
2714
2715        if target_player.player_id != player.player_id:
2716            # Playing via linked protocol - update active output protocol
2717            # output_protocol is guaranteed to be non-None when target_player != player
2718            assert output_protocol is not None
2719            self.logger.debug(
2720                "Starting playback on %s via protocol %s (target=%s), group_members=%s",
2721                player.state.name,
2722                output_protocol.output_protocol_id,
2723                target_player.display_name,
2724                target_player.state.group_members,
2725            )
2726            player.set_active_output_protocol(output_protocol.output_protocol_id)
2727            # if the (protocol)player has power control and is currently powered off,
2728            # we need to power it on before playback
2729            if (
2730                target_player.state.powered is False
2731                and target_player.power_control != PLAYER_CONTROL_NONE
2732            ):
2733                await self._handle_cmd_power(target_player.player_id, True)
2734            # forward play media command to protocol player
2735            await target_player.play_media(media)
2736            # notify the native player that protocol playback started
2737            await player.on_protocol_playback(output_protocol=output_protocol)
2738        else:
2739            # Native playback
2740            self.logger.debug(
2741                "Starting playback on %s via native, group_members=%s",
2742                player.state.name,
2743                player.state.group_members,
2744            )
2745            player.set_active_output_protocol("native")
2746            await player.play_media(media)
2747
2748    async def _handle_enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
2749        """
2750        Handle enqueue next media command without group redirect.
2751
2752        Skips permission checks and all redirect logic (internal use only).
2753
2754        :param player_id: player_id of the player to handle the command.
2755        :param media: The Media that needs to be enqueued on the player.
2756        """
2757        player = self.get_player(player_id, raise_unavailable=True)
2758        assert player is not None
2759        if target_player := self._get_control_target(
2760            player,
2761            required_feature=PlayerFeature.ENQUEUE,
2762            require_active=True,
2763        ):
2764            self.logger.debug(
2765                "Redirecting enqueue command to protocol player %s",
2766                target_player.provider.manifest.name,
2767            )
2768            await target_player.enqueue_next_media(media)
2769            return
2770
2771        if PlayerFeature.ENQUEUE not in player.state.supported_features:
2772            raise UnsupportedFeaturedException(
2773                f"Player {player.state.name} does not support enqueueing"
2774            )
2775        await player.enqueue_next_media(media)
2776
2777    async def _handle_select_source(self, player_id: str, source: str | None) -> None:
2778        """
2779        Handle select source command without group redirect.
2780
2781        Skips permission checks and all redirect logic (internal use only).
2782
2783        :param player_id: player_id of the player to handle the command.
2784        :param source: The ID of the source that needs to be activated/selected.
2785        """
2786        if source is None:
2787            source = player_id  # default to MA queue source
2788        player = self.get_player(player_id, True)
2789        assert player is not None
2790        # check if player is already playing and source is different
2791        # in that case we need to stop the player first
2792        prev_source = player.state.active_source
2793        if prev_source and source != prev_source:
2794            with suppress(PlayerCommandFailed, RuntimeError):
2795                # just try to stop (regardless of state)
2796                await self._handle_cmd_stop(player_id)
2797                await asyncio.sleep(2)  # small delay to allow stop to process
2798        # check if source is a pluginsource
2799        # in that case the source id is the instance_id of the plugin provider
2800        if plugin_prov := self.mass.get_provider(source):
2801            player.set_active_mass_source(source)
2802            await self._handle_select_plugin_source(player, cast("PluginProvider", plugin_prov))
2803            return
2804        # check if source is a mass queue
2805        # this can be used to restore the queue after a source switch
2806        if self.mass.player_queues.get(source):
2807            player.set_active_mass_source(source)
2808            return
2809        # basic check if player supports source selection
2810        if PlayerFeature.SELECT_SOURCE not in player.state.supported_features:
2811            raise UnsupportedFeaturedException(
2812                f"Player {player.state.name} does not support source selection"
2813            )
2814        # basic check if source is valid for player
2815        if not any(x for x in player.state.source_list if x.id == source):
2816            raise PlayerCommandFailed(
2817                f"{source} is an invalid source for player {player.state.name}"
2818            )
2819        # forward to player
2820        await player.select_source(source)
2821
2822    async def _handle_cmd_stop(self, player_id: str) -> None:
2823        """
2824        Handle stop command without any redirects.
2825
2826        Skips permission checks and all redirect logic (internal use only).
2827
2828        :param player_id: player_id of the player to handle the command.
2829        """
2830        player = self.get_player(player_id, raise_unavailable=True)
2831        assert player is not None
2832        player.mark_stop_called()
2833        # Delegate to active protocol player if one is active
2834        target_player = player
2835        if (
2836            player.active_output_protocol
2837            and player.active_output_protocol != "native"
2838            and (protocol_player := self.get_player(player.active_output_protocol))
2839        ):
2840            target_player = protocol_player
2841            if PlayerFeature.POWER in target_player.supported_features:
2842                # if protocol player supports/requires power,
2843                # we power it off instead of just stopping (which also stops playback)
2844                await self._handle_cmd_power(target_player.player_id, False)
2845                return
2846
2847        # handle command on player(protocol) directly
2848        await target_player.stop()
2849
2850    async def _handle_cmd_play(self, player_id: str) -> None:
2851        """
2852        Handle play command without group redirect.
2853
2854        Skips permission checks and all redirect logic (internal use only).
2855
2856        :param player_id: player_id of the player to handle the command.
2857        """
2858        player = self.get_player(player_id, raise_unavailable=True)
2859        assert player is not None
2860        if player.state.playback_state == PlaybackState.PLAYING:
2861            self.logger.info(
2862                "Ignore PLAY request to player %s: player is already playing", player.state.name
2863            )
2864            return
2865        # Check if a plugin source is active with a play callback
2866        if plugin_source := self._get_active_plugin_source(player):
2867            if plugin_source.can_play_pause and plugin_source.on_play:
2868                await plugin_source.on_play()
2869                return
2870        # handle unpause (=play if player is paused)
2871        if player.state.playback_state == PlaybackState.PAUSED:
2872            active_source = next(
2873                (x for x in player.state.source_list if x.id == player.state.active_source), None
2874            )
2875            # raise if active source does not support play/pause
2876            if active_source and not active_source.can_play_pause:
2877                msg = (
2878                    f"The active source ({active_source.name}) on player "
2879                    f"{player.state.name} does not support play/pause"
2880                )
2881                raise PlayerCommandFailed(msg)
2882            # Delegate to active protocol player if one is active
2883            if target_player := self._get_control_target(
2884                player, PlayerFeature.PAUSE, require_active=True
2885            ):
2886                await target_player.play()
2887                return
2888
2889        # player is not paused: try to resume the player
2890        # Note: We handle resume inline here without calling _handle_cmd_resume
2891        active_source = next(
2892            (x for x in player.state.source_list if x.id == player.state.active_source), None
2893        )
2894        media = player.state.current_media
2895        # power on the player if needed
2896        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
2897            await self._handle_cmd_power(player.player_id, True)
2898        if active_source and not active_source.passive:
2899            await self._handle_select_source(player_id, active_source.id)
2900            return
2901        if media:
2902            # try to re-play the current media item
2903            await player.play_media(media)
2904            return
2905        # fallback: just send play command - which will fail if nothing can be played
2906        await player.play()
2907
2908    async def _handle_cmd_pause(self, player_id: str) -> None:
2909        """
2910        Handle pause command without any redirects.
2911
2912        Skips permission checks and all redirect logic (internal use only).
2913
2914        :param player_id: player_id of the player to handle the command.
2915        """
2916        player = self.get_player(player_id, raise_unavailable=True)
2917        assert player is not None
2918        # Check if a plugin source is active with a pause callback
2919        if plugin_source := self._get_active_plugin_source(player):
2920            if plugin_source.can_play_pause and plugin_source.on_pause:
2921                await plugin_source.on_pause()
2922                return
2923        # handle command on player/source directly
2924        active_source = next(
2925            (x for x in player.state.source_list if x.id == player.state.active_source), None
2926        )
2927        if active_source and not active_source.can_play_pause:
2928            # raise if active source does not support play/pause
2929            msg = (
2930                f"The active source ({active_source.name}) on player "
2931                f"{player.state.name} does not support play/pause"
2932            )
2933            raise PlayerCommandFailed(msg)
2934        # Delegate to active protocol player if one is active
2935        if not (
2936            target_player := self._get_control_target(
2937                player, PlayerFeature.PAUSE, require_active=True
2938            )
2939        ):
2940            # if player(protocol) does not support pause, we need to send stop
2941            self.logger.debug(
2942                "Player/protocol %s does not support pause, using STOP instead",
2943                player.state.name,
2944            )
2945            await self._handle_cmd_stop(player.player_id)
2946            return
2947        # handle command on player(protocol) directly
2948        await target_player.pause()
2949
2950    def __iter__(self) -> Iterator[Player]:
2951        """Iterate over all players."""
2952        return iter(self._players.values())
2953