music-assistant-server

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