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