music-assistant-server

1"""
2Protocol Linking Mixin for the Player Controller.
3
4Handles all logic for linking protocol players (AirPlay, Chromecast, DLNA) to
5native players or wrapping them in Universal Players.
6
7This module provides the ProtocolLinkingMixin class which is inherited by
8PlayerController to add protocol linking capabilities.
9"""
10
11from __future__ import annotations
12
13import asyncio
14import logging
15from contextlib import suppress
16from copy import deepcopy
17from typing import TYPE_CHECKING, cast
18
19from music_assistant_models.enums import (
20    EventType,
21    IdentifierType,
22    PlaybackState,
23    PlayerFeature,
24    PlayerType,
25    ProviderType,
26)
27from music_assistant_models.errors import PlayerCommandFailed, PlayerUnavailableError
28
29from music_assistant.constants import (
30    CONF_CACHED_ARP_MAC,
31    CONF_GROUP_MEMBERS,
32    CONF_LINKED_PROTOCOL_IDS,
33    CONF_PLAYER_DSP,
34    CONF_PLAYER_QUEUES,
35    CONF_PLAYERS,
36    CONF_PREFERRED_OUTPUT_PROTOCOL,
37    CONF_PROTOCOL_KEY_SPLITTER,
38    CONF_PROTOCOL_PARENT_ID,
39    CONF_REPORTED_MAC,
40    CONF_UNDERLYING_PLAYER_ID,
41    PROTOCOL_PRIORITY,
42    VERBOSE_LOG_LEVEL,
43)
44from music_assistant.helpers.util import (
45    is_locally_administered_mac,
46    is_valid_mac_address,
47    normalize_mac_for_matching,
48)
49from music_assistant.models.player import LinkedOutputProtocol, Player
50from music_assistant.providers.sync_group.constants import CONF_ALLOWED_MEMBERS
51from music_assistant.providers.universal_player import UniversalPlayer, UniversalPlayerProvider
52from music_assistant.providers.universal_player.constants import (
53    CONF_DEVICE_IDENTIFIERS,
54    CONF_DEVICE_INFO,
55)
56
57if TYPE_CHECKING:
58    from collections.abc import Coroutine
59    from typing import Any
60
61    from music_assistant_models.player import OutputProtocol
62
63    from music_assistant import MusicAssistant
64
65# Config value keys that are bookkeeping of the universal player wrapper itself
66# (protocol links and device-identity caches) and must never be carried over
67# when a native player replaces a universal player.
68UNIVERSAL_PLAYER_INTERNAL_CONF_KEYS = (
69    CONF_LINKED_PROTOCOL_IDS,
70    CONF_PROTOCOL_PARENT_ID,
71    CONF_UNDERLYING_PLAYER_ID,
72    CONF_DEVICE_IDENTIFIERS,
73    CONF_DEVICE_INFO,
74    CONF_CACHED_ARP_MAC,
75    CONF_REPORTED_MAC,
76)
77
78
79class ProtocolLinkingMixin:
80    """
81    Mixin class providing protocol linking functionality for PlayerController.
82
83    Handles the complex logic of:
84    - Matching protocol players to native players via device identifiers
85    - Creating Universal Players for devices without native support
86    - Managing protocol links and their lifecycle
87    - Selecting the best output protocol for playback
88
89    This mixin expects to be mixed with a class that provides:
90    - mass: MusicAssistant instance
91    - _players: dict of registered players
92    - _pending_protocol_evaluations: dict of pending protocol evaluations
93    - logger: logging.Logger instance
94    - all(): method to get all players
95    - get(): method to get a player by ID
96    - unregister(): method to unregister a player
97    """
98
99    # Type hints for attributes provided by the class this mixin is used with
100    if TYPE_CHECKING:
101        mass: MusicAssistant
102        _players: dict[str, Player]
103        _pending_protocol_evaluations: dict[str, asyncio.TimerHandle]
104        _delayed_evaluation_lock: asyncio.Lock
105        logger: logging.Logger
106
107        def all_players(  # noqa: D102
108            self,
109            return_unavailable: bool = True,
110            return_disabled: bool = False,
111            provider_filter: str | None = None,
112            return_protocol_players: bool = False,
113        ) -> list[Player]: ...
114
115        def get_player(self, player_id: str) -> Player | None: ...  # noqa: D102
116
117        def unregister(  # noqa: D102
118            self, player_id: str, permanent: bool = False
119        ) -> Coroutine[Any, Any, None]: ...
120
121    def _is_protocol_player(self, player: Player) -> bool:
122        """
123        Check if a player is a generic protocol player without native support.
124
125        Protocol players have PlayerType.PROTOCOL set by their provider, indicating
126        they are generic streaming endpoints (e.g., AirPlay receiver, Chromecast device)
127        without vendor-specific native support in Music Assistant.
128        """
129        return player.state.type == PlayerType.PROTOCOL
130
131    def _evaluate_protocol_links(self, player: Player) -> None:
132        """
133        Evaluate and establish protocol links for a player.
134
135        Called when a player is registered to:
136        1. If it's from a protocol provider - try to link to a native player.
137        2. If it's a native player - try to link any existing protocol players.
138        """
139        if player.state.type == PlayerType.PROTOCOL:
140            # Protocol player: try to find a native parent
141            self._try_link_protocol_to_native(player)
142        elif player.state.type == PlayerType.GROUP:
143            return
144        else:
145            # A player that registers with a non-protocol type can no longer be a
146            # protocol child: drop a leftover persisted parent link (e.g. from a
147            # bridge client that turned web player) so the startup repair pass
148            # doesn't heal its player type back to protocol.
149            if self._get_cached_protocol_parent_id(player.player_id):
150                self._clear_protocol_parent_id(player.player_id)
151            # Native player (including STEREO_PAIR): try to find protocol players to link
152            self._try_link_protocols_to_native(player)
153
154    def _try_link_protocol_to_native(self, protocol_player: Player) -> None:
155        """Try to link a protocol player to a native player."""
156        protocol_domain = protocol_player.provider.domain
157
158        # Derived protocol players (e.g. Sendspin bridges riding on another
159        # protocol) resolve strictly via their underlying player - no identifier
160        # matching or delayed evaluation. If the underlying player has no parent
161        # yet, the link is established by _link_derived_protocols_of as soon as
162        # the underlying player gets linked.
163        if protocol_player.underlying_player_id:
164            self._try_link_derived_protocol(protocol_player)
165            return
166
167        # Check for cached parent_id from previous session and restore link immediately
168        cached_parent_id = self._get_cached_protocol_parent_id(protocol_player.player_id)
169        if cached_parent_id:
170            result = self._try_restore_cached_parent(
171                protocol_player, cached_parent_id, protocol_domain
172            )
173            if result:
174                return
175            # Link was refused or parent has active domain - fall through to search
176
177        # Look for a matching native player
178        if self._try_link_to_existing_player(protocol_player, protocol_domain):
179            return
180
181        # No native player found - schedule delayed evaluation to allow other protocols to register
182        if not protocol_player.protocol_parent_id:
183            self._schedule_protocol_evaluation(protocol_player)
184
185    def _try_restore_cached_parent(
186        self, protocol_player: Player, cached_parent_id: str, protocol_domain: str
187    ) -> bool:
188        """
189        Try to restore a cached parent link from a previous session.
190
191        :param protocol_player: The protocol player to link.
192        :param cached_parent_id: The cached parent player ID.
193        :param protocol_domain: The protocol domain (e.g., "airplay").
194        :return: True if handled (linked or waiting), False if should fall through.
195        """
196        if parent_player := self.get_player(cached_parent_id):
197            if parent_player.state.type == PlayerType.GROUP:
198                self._clear_protocol_parent_id(protocol_player.player_id)
199                return False
200            already_linked = any(
201                link.output_protocol_id == protocol_player.player_id
202                for link in parent_player.linked_output_protocols
203            )
204            if already_linked:
205                # Already linked from a previous call - just restore parent and identifiers
206                protocol_player.set_protocol_parent_id(cached_parent_id)
207            else:
208                # Try to add the link (may be refused if domain already has active link)
209                self._add_protocol_link(parent_player, protocol_player, protocol_domain)
210            if protocol_player.protocol_parent_id:
211                protocol_player.refresh_state()
212                parent_player.refresh_state()
213                # Merge the protocol player's identifiers into the universal player
214                # so identifiers discovered since the last persist (e.g. an
215                # ARP-resolved MAC) are included and new protocol players
216                # (like Sendspin bridges) can match via identifiers.
217                if parent_player.provider.domain == "universal_player" and isinstance(
218                    parent_player, UniversalPlayer
219                ):
220                    for conn_type, value in protocol_player.device_info.identifiers.items():
221                        parent_player.device_info.add_identifier(conn_type, value)
222                    self._update_universal_device_info(parent_player, protocol_player)
223                    # Check if this universal player should now be merged with another
224                    # (e.g., DLNA brought a MAC via ARP that matches an AirPlay universal)
225                    self._check_merge_universal_players(parent_player)
226                return True
227            # Link was refused (domain already active on parent) - fall through
228            return False
229
230        # Parent is not registered yet. Leave the protocol player unparented
231        # so the caller schedules delayed evaluation, which can wait for the
232        # cached parent without stranding the protocol player on a dangling id.
233        return False
234
235    def _try_link_to_existing_player(self, protocol_player: Player, protocol_domain: str) -> bool:
236        """
237        Try to link a protocol player to an existing native or universal player.
238
239        :param protocol_player: The protocol player to link.
240        :param protocol_domain: The protocol domain (e.g., "airplay").
241        :return: True if linked successfully, False if no match found.
242        """
243        # Protocol players should only link to:
244        # 1. True native players (Sonos, etc.)
245        # 2. Universal players
246        # NOT to other protocol players (they get merged via universal_player)
247        for native_player in self.all_players(return_protocol_players=False):
248            if native_player.player_id == protocol_player.player_id:
249                continue
250            if native_player.state.type in (PlayerType.PROTOCOL, PlayerType.GROUP):
251                continue
252
253            # For universal players, check if this protocol player is in its stored list
254            # or if identifiers match (for new protocol players like Sendspin bridges
255            # that weren't previously known to the Universal Player)
256            if native_player.provider.domain == "universal_player":
257                if isinstance(native_player, UniversalPlayer):
258                    is_known = protocol_player.player_id in native_player._protocol_player_ids
259                    is_match = not is_known and self._identifiers_match(
260                        native_player, protocol_player, protocol_domain
261                    )
262                    if is_known or is_match:
263                        self._add_protocol_link(native_player, protocol_player, protocol_domain)
264                        # Check if linking actually succeeded (may be refused for
265                        # duplicate domain)
266                        if not protocol_player.protocol_parent_id:
267                            continue
268                        # Merge the protocol player's identifiers into the universal
269                        # player so newly discovered identifiers are included as well
270                        for conn_type, value in protocol_player.device_info.identifiers.items():
271                            native_player.device_info.add_identifier(conn_type, value)
272                        # Update model/manufacturer if universal player has generic values
273                        self._update_universal_device_info(native_player, protocol_player)
274                        # Register newly matched protocol player with the universal player
275                        if is_match:
276                            native_player.add_protocol_player(protocol_player.player_id)
277                        # Persist updated data to config (async via task)
278                        self._save_universal_player_data(native_player)
279                        # Check if this universal player should now be merged with another
280                        self._check_merge_universal_players(native_player)
281                        protocol_player.refresh_state()
282                        native_player.refresh_state()
283                        return True
284                continue
285
286            # Check cached protocol IDs first for fast matching on restart
287            cached_ids = self._get_cached_protocol_ids(native_player.player_id)
288            if protocol_player.player_id in cached_ids:
289                self._add_protocol_link(native_player, protocol_player, protocol_domain)
290                if protocol_player.protocol_parent_id:
291                    protocol_player.refresh_state()
292                    native_player.refresh_state()
293                    return True
294                # Link refused (domain duplicate) - try next native player
295                continue
296
297            # Fallback to identifier matching
298            if self._identifiers_match(native_player, protocol_player, protocol_domain):
299                self._add_protocol_link(native_player, protocol_player, protocol_domain)
300                if protocol_player.protocol_parent_id:
301                    protocol_player.refresh_state()
302                    native_player.refresh_state()
303                    return True
304                # Link refused (domain duplicate) - try next native player
305                continue
306
307            # Final fallback: check if any already-linked protocol player on this native
308            # player shares identifiers with the new protocol player ("sibling matching").
309            # This handles native players (e.g., HEOS) that don't have their own MAC/serial
310            # identifiers but have protocol players (e.g., AirPlay) from the same device
311            # that do share identifiers with the new protocol player (e.g., Sendspin bridge).
312            if self._match_via_linked_protocols(native_player, protocol_player, protocol_domain):
313                return True
314
315        return False
316
317    def _match_via_linked_protocols(
318        self,
319        native_player: Player,
320        protocol_player: Player,
321        protocol_domain: str,
322    ) -> bool:
323        """
324        Try to match a protocol player to a native player via sibling protocol identifiers.
325
326        Check if any of the native player's already-linked protocol players share
327        identifiers with the new protocol player. This handles native players that lack
328        their own device identifiers but have sibling protocols from the same physical device.
329
330        :param native_player: The native player to potentially link to.
331        :param protocol_player: The new protocol player to link.
332        :param protocol_domain: The protocol domain of the new player.
333        :return: True if linked successfully, False if no match found.
334        """
335        for linked in native_player.linked_output_protocols:
336            linked_player = self.get_player(linked.output_protocol_id)
337            if not linked_player:
338                continue
339            if self._identifiers_match(linked_player, protocol_player, protocol_domain):
340                self._add_protocol_link(native_player, protocol_player, protocol_domain)
341                if protocol_player.protocol_parent_id:
342                    protocol_player.refresh_state()
343                    native_player.refresh_state()
344                    return True
345                # Link refused (domain duplicate) - stop checking siblings
346                break
347        return False
348
349    def _try_link_derived_protocol(self, protocol_player: Player) -> bool:
350        """
351        Link a derived protocol player to the parent of its underlying player.
352
353        Derived protocol players carry an underlying_player_id declared by their
354        bridge, which makes the parent resolution deterministic: they always join
355        the parent of the player they ride on (or that player itself when it is
356        not a protocol player). Callers must ensure the player is not linked yet.
357
358        :param protocol_player: The derived protocol player to link.
359        :return: True if the player got linked, False if the underlying player
360            (or its parent) is not available yet or the link was refused.
361        """
362        underlying = self.get_player(protocol_player.underlying_player_id or "")
363        if underlying is None:
364            return False
365        if underlying.state.type == PlayerType.PROTOCOL:
366            parent = (
367                self.get_player(underlying.protocol_parent_id)
368                if underlying.protocol_parent_id
369                else None
370            )
371        else:
372            parent = underlying
373        if parent is None or parent.state.type == PlayerType.GROUP:
374            return False
375
376        self._add_protocol_link(parent, protocol_player, protocol_player.provider.domain)
377        if not protocol_player.protocol_parent_id:
378            # Link refused (e.g. parent already has an active link from this domain)
379            return False
380
381        if parent.provider.domain == "universal_player" and isinstance(parent, UniversalPlayer):
382            # Track membership and identifiers on the universal player so the
383            # derived protocol restores quickly on the next start.
384            parent.add_protocol_player(protocol_player.player_id)
385            for conn_type, value in protocol_player.device_info.identifiers.items():
386                parent.device_info.add_identifier(conn_type, value)
387            self._save_universal_player_data(parent)
388
389        protocol_player.refresh_state()
390        parent.refresh_state()
391        self.logger.debug(
392            "Linked derived protocol %s to %s (via underlying %s)",
393            protocol_player.player_id,
394            parent.player_id,
395            underlying.player_id,
396        )
397        return True
398
399    def _link_derived_protocols_of(self, underlying_player: Player) -> None:
400        """
401        Link any waiting derived protocol players that ride on the given player.
402
403        Called after a player is linked to a parent (or registered as a native
404        player), so derived protocol players that registered earlier can join
405        the same parent.
406        """
407        for candidate in self.all_players(return_protocol_players=True):
408            if candidate.underlying_player_id != underlying_player.player_id:
409                continue
410            if candidate.protocol_parent_id:
411                continue
412            self._try_link_derived_protocol(candidate)
413
414    def _schedule_protocol_evaluation(self, protocol_player: Player) -> None:
415        """
416        Schedule a delayed protocol evaluation.
417
418        Delays evaluation to allow other protocol players and native players to register.
419        Uses a longer delay (30s) if this protocol player was previously linked to a native
420        player that hasn't registered yet, giving native providers time to start up.
421        """
422        player_id = protocol_player.player_id
423
424        # Cancel any existing pending evaluation for this player
425        if player_id in self._pending_protocol_evaluations:
426            self._pending_protocol_evaluations[player_id].cancel()
427
428        # Check if this protocol player has a cached parent (was previously linked)
429        cached_parent_id = self._get_cached_protocol_parent_id(player_id)
430        if cached_parent_id and not self.get_player(cached_parent_id):
431            # Previously linked to a native player that hasn't registered yet
432            # Use longer delay to give native providers time to start up
433            delay = 45.0
434            self.logger.debug(
435                "Protocol player %s waiting for cached parent %s (45s delay)",
436                player_id,
437                cached_parent_id,
438            )
439        else:
440            # Standard delay for protocol player discovery
441            # Allows time for other protocols and native players to register
442            delay = 15.0
443
444        # Schedule evaluation after the delay
445        handle = self.mass.loop.call_later(
446            delay,
447            lambda: self.mass.create_task(self._delayed_protocol_evaluation(player_id)),
448        )
449        self._pending_protocol_evaluations[player_id] = handle
450
451    async def _delayed_protocol_evaluation(self, player_id: str) -> None:
452        """
453        Perform delayed protocol evaluation.
454
455        Called after a delay to allow all protocol players for a device to register.
456        Decides whether to create a universal player, join an existing one, or
457        promote a single protocol player directly.
458
459        Uses a shared lock to serialize evaluations - multiple protocol players from the
460        same device may trigger concurrent evaluations that would otherwise race each other.
461        """
462        self._pending_protocol_evaluations.pop(player_id, None)
463
464        async with self._delayed_evaluation_lock:
465            protocol_player = self.get_player(player_id)
466            if not protocol_player or protocol_player.protocol_parent_id:
467                return
468            if protocol_player.state.type != PlayerType.PROTOCOL:
469                # The player changed type while the evaluation was pending
470                # (e.g. re-registered as a regular player); it must never be
471                # linked as a protocol or wrapped in a universal player.
472                return
473
474            # Derived protocol players resolve strictly via their underlying
475            # player and never match by identifiers or wrap into universal
476            # players; they wait for _link_derived_protocols_of otherwise.
477            if protocol_player.underlying_player_id:
478                self._try_link_derived_protocol(protocol_player)
479                return
480
481            protocol_domain = protocol_player.provider.domain
482
483            # Re-try linking to an existing native/universal player
484            if self._try_link_to_existing_player(protocol_player, protocol_domain):
485                return
486
487            # Check if there's an existing universal player we should join
488            if existing_universal := self._find_matching_universal_player(protocol_player):
489                await self._add_protocol_to_existing_universal(
490                    existing_universal, protocol_player, protocol_domain
491                )
492                if protocol_player.protocol_parent_id is not None:
493                    return
494                # Link refused (domain duplicate) - fall through to create separate UP
495
496            # Refuse to create a universal player wrapper when the cached parent
497            # config exists but is disabled. The user explicitly turned the
498            # parent device off; surfacing its protocols as a separate player
499            # would defeat that intent.
500            cached_parent_id = self._get_cached_protocol_parent_id(player_id)
501            if cached_parent_id:
502                parent_raw = self.mass.config.get(f"{CONF_PLAYERS}/{cached_parent_id}")
503                if parent_raw and not parent_raw.get("enabled", True):
504                    self.logger.debug(
505                        "Skipping universal player creation for %s: cached parent %s is disabled",
506                        player_id,
507                        cached_parent_id,
508                    )
509                    return
510
511            # Find all protocol players that match this device's identifiers
512            matching_protocols = self._find_matching_protocol_players(protocol_player)
513
514            # Create or update UniversalPlayer for all protocol players
515            await self._create_or_update_universal_player(matching_protocols)
516
517    def _find_matching_protocol_players(self, protocol_player: Player) -> list[Player]:
518        """
519        Find all protocol players that match the same device as the given player.
520
521        Searches through all registered protocol players to find ones that share
522        identifiers (MAC, IP, UUID) with the given player, indicating they represent
523        the same physical device.
524        """
525        matching = [protocol_player]
526        protocol_domain = protocol_player.provider.domain
527
528        for other_player in self.all_players(return_protocol_players=True):
529            if other_player.player_id == protocol_player.player_id:
530                continue
531            if other_player.state.type != PlayerType.PROTOCOL:
532                continue
533            if other_player.protocol_parent_id:
534                continue
535            if other_player.underlying_player_id:
536                # Derived protocol players follow their underlying player
537                # once it is linked; they never seed a universal player.
538                continue
539            # Skip players from the same protocol domain
540            # Multiple instances of the same protocol on one host are separate players
541            if other_player.provider.domain == protocol_domain:
542                continue
543            if self._identifiers_match(protocol_player, other_player):
544                matching.append(other_player)
545
546        return matching
547
548    def _find_matching_universal_player(self, protocol_player: Player) -> Player | None:
549        """Find an existing universal player that matches this protocol player."""
550        for player in self._players.values():
551            if player.provider.domain != "universal_player":
552                continue
553            if self._identifiers_match(protocol_player, player, ""):
554                return player
555        return None
556
557    async def _add_protocol_to_existing_universal(
558        self, universal_player: Player, protocol_player: Player, protocol_domain: str
559    ) -> None:
560        """Add a protocol player to an existing universal player."""
561        # Refuse if the universal player already has a registered player from this domain.
562        # This prevents a second instance (e.g., two snapcast players on the same host)
563        # from replacing the first. The caller falls through to create a separate UP.
564        for link in universal_player.linked_output_protocols:
565            if link.protocol_domain == protocol_domain and self.get_player(link.output_protocol_id):
566                return
567
568        self._add_protocol_link(universal_player, protocol_player, protocol_domain)
569
570        # Check if linking actually succeeded (may be refused for duplicate domain)
571        if not protocol_player.protocol_parent_id:
572            return
573
574        if isinstance(universal_player, UniversalPlayer):
575            universal_player.add_protocol_player(protocol_player.player_id)
576            for conn_type, value in protocol_player.device_info.identifiers.items():
577                universal_player.device_info.add_identifier(conn_type, value)
578            # Update model/manufacturer if universal player has generic values
579            self._update_universal_device_info(universal_player, protocol_player)
580
581            # Persist all player data (protocol IDs, identifiers, device info) to config
582            for provider in self.mass.get_providers(ProviderType.PLAYER):
583                if provider.domain == "universal_player":
584                    await cast("UniversalPlayerProvider", provider)._save_player_data(
585                        universal_player.player_id, universal_player
586                    )
587                    break
588
589            # Check if this universal player should now be merged with another
590            self._check_merge_universal_players(universal_player)
591
592        protocol_player.refresh_state()
593        universal_player.refresh_state()
594
595    def _update_universal_device_info(
596        self, universal_player: UniversalPlayer, protocol_player: Player
597    ) -> None:
598        """
599        Update universal player's device info from protocol player if needed.
600
601        A universal player carries generic placeholder device info
602        (model="Universal Player", manufacturer="Music Assistant") when no real
603        values are known for it (yet). This method updates those values from a
604        protocol player that has real device info.
605        """
606        # Check if universal player has generic placeholder device info
607        device_info = universal_player.device_info
608        protocol_info = protocol_player.device_info
609
610        # Update model if universal player has generic value
611        if device_info.model in (None, "Universal Player") and protocol_info.model:
612            device_info.model = protocol_info.model
613
614        # Update manufacturer if universal player has generic value
615        if device_info.manufacturer in (None, "Music Assistant") and protocol_info.manufacturer:
616            device_info.manufacturer = protocol_info.manufacturer
617
618    def _save_universal_player_data(self, universal_player: UniversalPlayer) -> None:
619        """
620        Save universal player data to config via background task.
621
622        This is a helper to persist player data from synchronous code.
623        """
624
625        async def _do_save() -> None:
626            for provider in self.mass.get_providers(ProviderType.PLAYER):
627                if provider.domain == "universal_player":
628                    await cast("UniversalPlayerProvider", provider)._save_player_data(
629                        universal_player.player_id, universal_player
630                    )
631                    break
632
633        self.mass.create_task(_do_save())
634
635    def _get_known_protocol_ids(self, parent: Player) -> list[str]:
636        """
637        Get all protocol IDs tracked for a parent player.
638
639        Includes both active links and cached/inactive protocol IDs so callers can
640        safely migrate or clean up the full parent/protocol relationship.
641        """
642        result: list[str] = []
643        seen: set[str] = set()
644
645        for linked in parent.linked_output_protocols:
646            if linked.output_protocol_id not in seen:
647                result.append(linked.output_protocol_id)
648                seen.add(linked.output_protocol_id)
649
650        if parent.provider.domain == "universal_player" and isinstance(parent, UniversalPlayer):
651            cached_ids = parent._protocol_player_ids
652        else:
653            cached_ids = self._get_cached_protocol_ids(parent.player_id)
654
655        for protocol_id in cached_ids:
656            if protocol_id not in seen:
657                result.append(protocol_id)
658                seen.add(protocol_id)
659
660        return result
661
662    def _migrate_protocol_ids_to_parent(self, parent: Player, protocol_ids: set[str]) -> None:
663        """
664        Persist protocol ownership on a new parent without requiring active links.
665
666        This is used when protocol ownership moves from one parent to another during
667        promotion/merge flows. Active protocols are already linked in memory, but
668        disabled or temporarily unavailable protocols still need their cached parent
669        relationship moved as well.
670        """
671        if not protocol_ids:
672            return
673
674        if parent.provider.domain == "universal_player" and isinstance(parent, UniversalPlayer):
675            for protocol_id in protocol_ids:
676                parent.add_protocol_player(protocol_id)
677            self._save_universal_player_data(parent)
678        else:
679            conf_key = f"{CONF_PLAYERS}/{parent.player_id}/values/{CONF_LINKED_PROTOCOL_IDS}"
680            cached_ids = self._get_cached_protocol_ids(parent.player_id)
681            changed = False
682            for protocol_id in protocol_ids:
683                if protocol_id not in cached_ids:
684                    cached_ids.append(protocol_id)
685                    changed = True
686            if changed:
687                self.mass.config.set(conf_key, cached_ids)
688
689        for protocol_id in protocol_ids:
690            if self.mass.config.get(f"{CONF_PLAYERS}/{protocol_id}"):
691                self._save_protocol_parent_id(protocol_id, parent.player_id)
692
693    def _remove_protocol_ids_from_parent(self, parent: Player, protocol_ids: set[str]) -> None:
694        """
695        Remove protocol ownership from a parent before it is permanently cleaned up.
696
697        This prevents `_cleanup_protocol_links` from treating already-migrated
698        protocols as orphaned when the obsolete parent is unregistered.
699        """
700        if not protocol_ids:
701            return
702
703        remaining_links = [
704            link
705            for link in parent.linked_output_protocols
706            if link.output_protocol_id not in protocol_ids
707        ]
708        if len(remaining_links) != len(parent.linked_output_protocols):
709            parent.set_linked_output_protocols(remaining_links)
710
711        if parent.provider.domain == "universal_player" and isinstance(parent, UniversalPlayer):
712            for protocol_id in protocol_ids:
713                parent.remove_protocol_player(protocol_id)
714            if self.mass.config.get(f"{CONF_PLAYERS}/{parent.player_id}"):
715                self.mass.config.set(
716                    f"{CONF_PLAYERS}/{parent.player_id}/values/{CONF_LINKED_PROTOCOL_IDS}",
717                    parent._protocol_player_ids,
718                )
719        else:
720            for protocol_id in protocol_ids:
721                self._remove_protocol_id_from_cache(parent.player_id, protocol_id)
722
723    def _check_merge_universal_players(self, universal_player: UniversalPlayer) -> None:
724        """
725        Check if another universal player should be merged into this one.
726
727        Called after identifiers are copied from a protocol player to a universal player.
728        When a protocol player brings new identifiers (e.g., MAC from ARP enrichment),
729        the universal player may now match another universal player that was created
730        from a different protocol (e.g., DLNA-based universal player now matches
731        AirPlay-based universal player because they share the same MAC address).
732
733        The universal player with more protocol links absorbs the other one.
734        """
735        for player in list(self._players.values()):
736            if player.provider.domain != "universal_player":
737                continue
738            if player.player_id == universal_player.player_id:
739                continue
740            if not isinstance(player, UniversalPlayer):
741                continue
742
743            if not self._identifiers_match(universal_player, player, ""):
744                continue
745
746            # Do not merge if both UPs have protocols from the same domain.
747            # Multiple instances of the same protocol on one host (e.g., several
748            # squeezelite players on the same VM) are separate devices that happen
749            # to share an IP. Merging them would orphan one instance's protocol.
750            domains_a = {
751                link.protocol_domain
752                for link in universal_player.linked_output_protocols
753                if link.protocol_domain
754            }
755            domains_b = {
756                link.protocol_domain
757                for link in player.linked_output_protocols
758                if link.protocol_domain
759            }
760            if domains_a & domains_b:
761                self.logger.debug(
762                    "Skipping merge of %s and %s: shared protocol domain(s) %s",
763                    universal_player.player_id,
764                    player.player_id,
765                    domains_a & domains_b,
766                )
767                continue
768
769            # Determine which player absorbs the other (more protocols wins).
770            # On ties, fall back to a deterministic tiebreaker on player_id so
771            # the merge outcome is stable across server restarts. Without this,
772            # which UniversalPlayer "wins" depends on iteration order of
773            # self._players.values(), which can shift between runs and causes
774            # downstream player_id reshuffling (and broken entity bindings in
775            # consumers like the Home Assistant MA integration).
776            len_u = len(universal_player.linked_output_protocols)
777            len_p = len(player.linked_output_protocols)
778            if len_u > len_p:
779                keep, remove = universal_player, player
780            elif len_u < len_p:
781                keep, remove = player, universal_player
782            elif universal_player.player_id < player.player_id:
783                keep, remove = universal_player, player
784            else:
785                keep, remove = player, universal_player
786
787            self.logger.info(
788                "Merging universal player %s into %s (shared identifiers)",
789                remove.player_id,
790                keep.player_id,
791            )
792
793            known_protocol_ids = set(self._get_known_protocol_ids(remove))
794            active_protocol_ids = {
795                link.output_protocol_id for link in remove.linked_output_protocols
796            }
797            moved_protocol_ids: set[str] = set()
798
799            # Transfer protocol links from the removed player to the keeper
800            for linked in list(remove.linked_output_protocols):
801                if protocol_player := self.get_player(linked.output_protocol_id):
802                    protocol_player.set_protocol_parent_id(None)
803                    domain = linked.protocol_domain or protocol_player.provider.domain
804
805                    # Check if keeper already has an active link from this domain
806                    if self._parent_has_active_protocol_from_domain(keep, domain):
807                        self.logger.debug(
808                            "Skipping duplicate %s link during merge: %s",
809                            domain,
810                            linked.output_protocol_id,
811                        )
812                        continue
813
814                    self._add_protocol_link(keep, protocol_player, domain)
815                    if protocol_player.protocol_parent_id == keep.player_id:
816                        moved_protocol_ids.add(protocol_player.player_id)
817                        protocol_player.refresh_state()
818
819            # Move cached-only protocol ownership as well so old-parent cleanup
820            # does not wipe protocols that were intentionally preserved.
821            cached_only_ids = known_protocol_ids - active_protocol_ids
822            preserved_protocol_ids = moved_protocol_ids | cached_only_ids
823            self._migrate_protocol_ids_to_parent(keep, preserved_protocol_ids)
824            self._remove_protocol_ids_from_parent(remove, preserved_protocol_ids)
825
826            # Merge identifiers
827            for conn_type, value in remove.device_info.identifiers.items():
828                keep.device_info.add_identifier(conn_type, value)
829            keep.refresh_state()
830
831            # Persist updated data before the obsolete player is removed
832            self._save_universal_player_data(keep)
833
834            # Carry over the user's configuration and re-point group memberships
835            # before the permanent removal below deletes the losing wrapper's config
836            self._migrate_universal_player_config(remove.player_id, keep.player_id)
837            self._repoint_group_memberships(remove.player_id, keep.player_id)
838
839            # Stop playback and remove the obsolete player
840            self.mass.create_task(self._stop_and_unregister(remove))
841
842            # Only merge one at a time (re-evaluation will catch cascading merges)
843            break
844
845    def _link_protocols_to_universal(
846        self, universal_player: Player, protocol_players: list[Player]
847    ) -> None:
848        """Link protocol players to a universal player, cleaning up existing links."""
849        for player in protocol_players:
850            # Clean up if linked to another player
851            if player.protocol_parent_id:
852                if parent := self.get_player(player.protocol_parent_id):
853                    self._remove_protocol_link(parent, player.player_id)
854                player.set_protocol_parent_id(None)
855            # Link to universal player
856            self._add_protocol_link(universal_player, player, player.provider.domain)
857            player.refresh_state()
858
859        # Update availability from protocol players
860        universal_player.refresh_state()
861
862    async def _create_or_update_universal_player(self, protocol_players: list[Player]) -> None:
863        """
864        Create or update a UniversalPlayer for a set of protocol players.
865
866        Delegates to the universal player provider which handles orchestration,
867        locking, and player creation. The controller then links the protocols
868        to the universal player.
869        """
870        # Filter out players that got linked during the async delay
871        protocol_players = [p for p in protocol_players if not p.protocol_parent_id]
872        if not protocol_players:
873            return
874
875        # Get the universal_player provider
876        universal_provider: UniversalPlayerProvider | None = None
877        for provider in self.mass.get_providers(ProviderType.PLAYER):
878            if provider.domain == "universal_player":
879                universal_provider = cast("UniversalPlayerProvider", provider)
880                break
881
882        if not universal_provider:
883            return
884
885        # Delegate to provider - it handles locking, create/update decision, etc.
886        universal_player = await universal_provider.ensure_universal_player_for_protocols(
887            protocol_players
888        )
889
890        if not universal_player:
891            return
892
893        # Link the protocols to the universal player (controller manages cross-provider state)
894        # Filter out players that were already linked
895        # (e.g., via _add_protocol_to_existing_universal)
896        unlinked_players = [p for p in protocol_players if not p.protocol_parent_id]
897
898        # Split unlinked players: those that can join the main universal player
899        # vs those that got separate universal players (domain-duplicates)
900        for player in list(unlinked_players):
901            # Check if a separate universal player was created for this player
902            fallback_key = player.player_id.replace(":", "").replace("-", "").lower()
903            separate_id = f"up{fallback_key}"
904            if separate_up := self.get_player(separate_id):
905                # Link to the separate universal player instead
906                self._add_protocol_link(separate_up, player, player.provider.domain)
907                player.refresh_state()
908                separate_up.refresh_state()
909                unlinked_players.remove(player)
910
911        self._link_protocols_to_universal(universal_player, unlinked_players)
912        universal_player.refresh_state()
913
914    def _try_link_protocols_to_native(self, native_player: Player) -> None:
915        """Try to link protocol players to a native player."""
916        # First, check if there's a universal player for this device that should be replaced
917        self._check_replace_universal_player(native_player)
918
919        # Look for protocol players that should be linked
920        for protocol_player in self.all_players(return_protocol_players=True):
921            if protocol_player.state.type != PlayerType.PROTOCOL:
922                continue
923            if protocol_player.protocol_parent_id:
924                # Already linked to a parent (could be this native player after replacement)
925                continue
926            if protocol_player.underlying_player_id:
927                # Derived protocol players link via their underlying player instead
928                continue
929
930            protocol_domain = protocol_player.provider.domain
931
932            # Skip if this native player already has an active link from this domain
933            # (prevents a second instance of the same protocol from trying to link)
934            if self._parent_has_active_protocol_from_domain(native_player, protocol_domain):
935                continue
936
937            if self._identifiers_match(native_player, protocol_player, protocol_domain):
938                self._add_protocol_link(native_player, protocol_player, protocol_domain)
939                # Check if linking succeeded (may be refused for duplicate domain)
940                if protocol_player.protocol_parent_id is not None:
941                    protocol_player.refresh_state()
942                    native_player.refresh_state()
943
944        # Proactively recover disabled/missing protocols from config
945        # This ensures disabled protocols show up in the UI so they can be re-enabled
946        self._recover_cached_protocol_links(native_player)
947
948        # Second pass: match remaining unlinked protocol players via sibling identifiers.
949        # After cache recovery, the native player has linked protocols (e.g., AirPlay)
950        # whose identifiers can be used to match new protocol players (e.g., Sendspin bridge)
951        # that share the same device identifiers but couldn't match the native player directly.
952        for protocol_player in self.all_players(return_protocol_players=True):
953            if protocol_player.state.type != PlayerType.PROTOCOL:
954                continue
955            if protocol_player.protocol_parent_id:
956                continue
957            if protocol_player.underlying_player_id:
958                continue
959            protocol_domain = protocol_player.provider.domain
960            if self._parent_has_active_protocol_from_domain(native_player, protocol_domain):
961                continue
962            if self._match_via_linked_protocols(native_player, protocol_player, protocol_domain):
963                self.logger.debug(
964                    "Linked %s to %s via sibling protocol identifiers",
965                    protocol_player.player_id,
966                    native_player.player_id,
967                )
968
969        # Finally, link derived protocol players that ride directly on this
970        # native player (derived players riding on the protocol players linked
971        # above are handled by _add_protocol_link itself).
972        self._link_derived_protocols_of(native_player)
973
974    def _check_replace_universal_player(self, native_player: Player) -> None:
975        """Check if a universal player should be replaced by this native player."""
976        # Skip if native_player is itself a universal player (prevent self-replacement)
977        if native_player.provider.domain == "universal_player":
978            return
979
980        # Look for universal players that match this native player
981        for player in list(self._players.values()):
982            if player.provider.domain != "universal_player":
983                continue
984
985            # Check by identifiers first
986            identifiers_match = self._identifiers_match(native_player, player, "")
987
988            # Also check if native player's ID is in the universal player's stored protocol list
989            # This handles players that changed type (e.g., sendspin web players changed from
990            # PROTOCOL to PLAYER type) and have no identifiers to match against
991            player_id_in_protocols = (
992                isinstance(player, UniversalPlayer)
993                and native_player.player_id in player._protocol_player_ids
994            )
995
996            if not identifiers_match and not player_id_in_protocols:
997                continue
998
999            known_protocol_ids = set(self._get_known_protocol_ids(player))
1000            active_protocol_ids = {
1001                link.output_protocol_id for link in player.linked_output_protocols
1002            }
1003            moved_protocol_ids: set[str] = set()
1004
1005            # Transfer all protocol links from universal player to native player
1006            for linked in list(player.linked_output_protocols):
1007                if protocol_player := self.get_player(linked.output_protocol_id):
1008                    protocol_player.set_protocol_parent_id(None)
1009                    domain = linked.protocol_domain or protocol_player.provider.domain
1010                    self._add_protocol_link(native_player, protocol_player, domain)
1011                    if protocol_player.protocol_parent_id == native_player.player_id:
1012                        moved_protocol_ids.add(protocol_player.player_id)
1013                        protocol_player.refresh_state()
1014                    else:
1015                        # Link refused, keep the protocol owned by the universal player.
1016                        protocol_player.set_protocol_parent_id(player.player_id)
1017
1018            if active_protocol_ids - moved_protocol_ids:
1019                # A link was refused, keep the universal player and hand over only
1020                # what moved so the refused protocols are not orphaned.
1021                self._migrate_protocol_ids_to_parent(native_player, moved_protocol_ids)
1022                self._remove_protocol_ids_from_parent(player, moved_protocol_ids)
1023                native_player.refresh_state()
1024                continue
1025
1026            cached_only_ids = known_protocol_ids - active_protocol_ids
1027            preserved_protocol_ids = moved_protocol_ids | cached_only_ids
1028            # A device that kept its id across a type change lists itself here.
1029            # It must never become its own protocol, and it must also be dropped
1030            # from the obsolete universal player so the permanent cleanup below
1031            # doesn't treat it as an orphaned protocol (which would re-wrap the
1032            # native player in a fresh universal player).
1033            preserved_protocol_ids.discard(native_player.player_id)
1034            self._migrate_protocol_ids_to_parent(native_player, preserved_protocol_ids)
1035            self._remove_protocol_ids_from_parent(
1036                player, preserved_protocol_ids | {native_player.player_id}
1037            )
1038            native_player.refresh_state()
1039
1040            # Carry over the user's configuration and re-point group memberships
1041            # before the permanent removal below deletes the universal player's config
1042            self._migrate_universal_player_config(player.player_id, native_player.player_id)
1043            self._repoint_group_memberships(player.player_id, native_player.player_id)
1044
1045            # Stop playback and remove the now-obsolete universal player
1046            self.mass.create_task(self._stop_and_unregister(player))
1047
1048    def _migrate_universal_player_config(self, universal_id: str, native_id: str) -> None:
1049        """
1050        Carry over user-set configuration from a replaced universal player.
1051
1052        Copies the custom display name, player config values, DSP settings and
1053        per-queue settings of the (obsolete) universal player onto the native
1054        player that replaces it, without overwriting values explicitly set on
1055        the native player itself. Must be called while the universal player's
1056        config still exists, as the permanent removal deletes it.
1057
1058        :param universal_id: Player id of the obsolete universal player being replaced.
1059        :param native_id: Player id of the native player that replaces it.
1060        """
1061        source_raw = self.mass.config.get(f"{CONF_PLAYERS}/{universal_id}")
1062        source_raw = source_raw if isinstance(source_raw, dict) else {}
1063        target_key = f"{CONF_PLAYERS}/{native_id}"
1064        target_raw = self.mass.config.get(target_key)
1065        target_raw = target_raw if isinstance(target_raw, dict) else {}
1066        player_config_changed = False
1067
1068        # only carry an actual user rename, not the auto-generated default name;
1069        # likewise a name on the native player only counts as a user override when
1070        # it differs from the default name (fresh configs store name == default_name)
1071        custom_name = source_raw.get("name")
1072        target_name = target_raw.get("name")
1073        target_has_custom_name = bool(target_name) and target_name != target_raw.get("default_name")
1074        if (
1075            custom_name
1076            and custom_name != source_raw.get("default_name")
1077            and not target_has_custom_name
1078        ):
1079            self.mass.config.set(f"{target_key}/name", custom_name)
1080            player_config_changed = True
1081
1082        source_values = source_raw.get("values")
1083        source_values = source_values if isinstance(source_values, dict) else {}
1084        target_values = target_raw.get("values")
1085        target_values = target_values if isinstance(target_values, dict) else {}
1086        for key, value in source_values.items():
1087            if key in UNIVERSAL_PLAYER_INTERNAL_CONF_KEYS:
1088                continue
1089            if CONF_PROTOCOL_KEY_SPLITTER in key:
1090                # stale virtual mirror of a protocol player's own config
1091                continue
1092            if key in target_values:
1093                continue
1094            self.mass.config.set(f"{target_key}/values/{key}", deepcopy(value))
1095            player_config_changed = True
1096
1097        # DSP settings follow wholesale, unless the native player has its own
1098        dsp_changed = False
1099        source_dsp = self.mass.config.get(f"{CONF_PLAYER_DSP}/{universal_id}")
1100        if source_dsp and not self.mass.config.get(f"{CONF_PLAYER_DSP}/{native_id}"):
1101            self.mass.config.set(f"{CONF_PLAYER_DSP}/{native_id}", deepcopy(source_dsp))
1102            dsp_changed = True
1103
1104        queue_changed = self._migrate_universal_queue_config(universal_id, native_id)
1105
1106        if not (player_config_changed or dsp_changed or queue_changed):
1107            return
1108        self.logger.info(
1109            "Carried over configuration of universal player %s to %s", universal_id, native_id
1110        )
1111        if player_config_changed:
1112            # the native player's in-place config was loaded before the carry-over,
1113            # so reload it to make the migrated values (e.g. custom name) effective
1114            self.mass.create_task(self._reapply_player_config(native_id))
1115
1116    def _migrate_universal_queue_config(self, universal_id: str, native_id: str) -> bool:
1117        """
1118        Move the per-queue settings of a replaced universal player to its replacement.
1119
1120        Queue ids equal player ids, so the source entry is removed once it is carried over.
1121
1122        :param universal_id: Player id of the obsolete universal player.
1123        :param native_id: Player id of the native player that replaces it.
1124        :return: True if any queue setting was carried over.
1125        """
1126        queue_changed = False
1127        source_queue_raw = self.mass.config.get(f"{CONF_PLAYER_QUEUES}/{universal_id}")
1128        source_queue_raw = source_queue_raw if isinstance(source_queue_raw, dict) else None
1129        if source_queue_values := (source_queue_raw or {}).get("values"):
1130            target_queue_key = f"{CONF_PLAYER_QUEUES}/{native_id}"
1131            target_queue_raw = self.mass.config.get(target_queue_key)
1132            target_queue_raw = (
1133                deepcopy(target_queue_raw) if isinstance(target_queue_raw, dict) else {}
1134            )
1135            target_queue_values = target_queue_raw.setdefault("values", {})
1136            for key, value in source_queue_values.items():
1137                if key in target_queue_values:
1138                    continue
1139                target_queue_values[key] = deepcopy(value)
1140                queue_changed = True
1141            if queue_changed:
1142                target_queue_raw["queue_id"] = native_id
1143                self.mass.config.set(target_queue_key, target_queue_raw)
1144        if source_queue_raw is not None:
1145            self.mass.config.remove(f"{CONF_PLAYER_QUEUES}/{universal_id}")
1146        return queue_changed
1147
1148    async def _reapply_player_config(self, player_id: str) -> None:
1149        """Reload the stored config onto a registered player and refresh its state."""
1150        if not (player := self.get_player(player_id)):
1151            return
1152        config = await self.mass.config.get_player_config(player_id)
1153        player.set_config(config)
1154        player.update_state()
1155        self.mass.signal_event(EventType.PLAYER_CONFIG_UPDATED, object_id=player_id, data=config)
1156
1157    def _repoint_group_memberships(self, old_player_id: str, new_player_id: str) -> None:
1158        """
1159        Re-point group memberships from a removed player to its successor.
1160
1161        When a universal player is replaced by a native player or merged into
1162        another universal player, other players that list the removed player as
1163        a group member (or allowed member) must follow its successor so those
1164        memberships are not silently lost. Updates the persisted config and keeps
1165        any registered player whose membership changed in sync.
1166
1167        :param old_player_id: Player id that is being removed.
1168        :param new_player_id: Player id that replaces it.
1169        """
1170        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
1171        if not isinstance(all_player_configs, dict):
1172            return
1173        for other_id, other_cfg in all_player_configs.items():
1174            if not isinstance(other_cfg, dict):
1175                continue
1176            other_values = other_cfg.get("values")
1177            if not isinstance(other_values, dict):
1178                continue
1179            for key in (CONF_GROUP_MEMBERS, CONF_ALLOWED_MEMBERS):
1180                members = other_values.get(key)
1181                if not isinstance(members, list) or old_player_id not in members:
1182                    continue
1183                new_members: list[str] = []
1184                for member_id in members:
1185                    resolved = new_player_id if member_id == old_player_id else member_id
1186                    if resolved not in new_members:
1187                        new_members.append(resolved)
1188                self.mass.config.set(f"{CONF_PLAYERS}/{other_id}/values/{key}", new_members)
1189                # keep a registered player's in-place config copy and state in sync
1190                if other_player := self.get_player(other_id):
1191                    if entry := other_player.config.values.get(key):
1192                        entry.value = new_members
1193                    other_player.refresh_state()
1194
1195    async def _stop_and_unregister(self, player: Player) -> None:
1196        """
1197        Stop active playback on a player and then permanently unregister it.
1198
1199        Used when an obsolete universal player is replaced or merged away: while
1200        it is not idle its protocol child keeps playing the dead queue's stream
1201        until the buffer drains, so playback is stopped first. Queue ownership is
1202        intentionally not transferred.
1203
1204        :param player: The obsolete player to stop and permanently remove.
1205        """
1206        if player.playback_state != PlaybackState.IDLE:
1207            with suppress(PlayerCommandFailed, PlayerUnavailableError):
1208                await self.mass.player_queues.stop(player.player_id)
1209        await self.unregister(player.player_id, permanent=True)
1210
1211    def _parent_has_active_protocol_from_domain(
1212        self, parent: Player, domain: str, exclude_player_id: str | None = None
1213    ) -> bool:
1214        """
1215        Check if a parent already has an active (registered) protocol player from a given domain.
1216
1217        This prevents a second protocol player of the same domain (e.g., a second AirPlay
1218        instance on the same host) from replacing the first one's link on the same parent.
1219
1220        :param parent: The parent player to check.
1221        :param domain: The protocol domain to check for (e.g., "airplay", "dlna").
1222        :param exclude_player_id: Optional player ID to exclude from the check
1223            (used when checking if a player's own domain is already linked).
1224        """
1225        for link in parent.linked_output_protocols:
1226            if link.protocol_domain != domain:
1227                continue
1228            if exclude_player_id and link.output_protocol_id == exclude_player_id:
1229                continue
1230            # A registered player from this domain blocks the link, even if unavailable.
1231            # Being offline doesn't make it a different device — it's still occupying
1232            # this domain slot. The provider should remove stale players explicitly.
1233            if self.get_player(link.output_protocol_id):
1234                return True
1235        return False
1236
1237    def _add_protocol_link(
1238        self, native_player: Player, protocol_player: Player, protocol_domain: str
1239    ) -> None:
1240        """Add a protocol link from native player to protocol player."""
1241        # Never link a player to itself (hides it as its own protocol child).
1242        if native_player.player_id == protocol_player.player_id:
1243            return
1244        # Guard: refuse to replace an existing active link from the same domain.
1245        # This prevents a second instance of the same protocol (e.g., two AirPlay
1246        # instances on the same host) from silently replacing the first one.
1247        if self._parent_has_active_protocol_from_domain(
1248            native_player, protocol_domain, exclude_player_id=protocol_player.player_id
1249        ):
1250            self.logger.debug(
1251                "Refusing to link %s to %s: parent already has an active %s link",
1252                protocol_player.player_id,
1253                native_player.player_id,
1254                protocol_domain,
1255            )
1256            return
1257
1258        # Remove any existing link for the same protocol domain
1259        updated_protocols = [
1260            link
1261            for link in native_player.linked_output_protocols
1262            if link.protocol_domain != protocol_domain
1263        ]
1264
1265        # Get priority for this protocol
1266        priority = PROTOCOL_PRIORITY.get(protocol_domain, 100)
1267
1268        # Derived transports (e.g. a Sendspin bridge riding on an AirPlay player)
1269        # reference the base output they run on top of; "native" when they ride
1270        # on the parent player itself
1271        derived_from = protocol_player.underlying_player_id
1272        if derived_from == native_player.player_id:
1273            derived_from = "native"
1274
1275        # Add the new link
1276        updated_protocols.append(
1277            LinkedOutputProtocol(
1278                output_protocol_id=protocol_player.player_id,
1279                protocol_domain=protocol_domain,
1280                priority=priority,
1281                derived_from=derived_from,
1282            )
1283        )
1284        native_player.set_linked_output_protocols(updated_protocols)
1285
1286        # Set protocol player's parent
1287        protocol_player.set_protocol_parent_id(native_player.player_id)
1288
1289        # Persist linked protocol IDs to config for fast restart
1290        # (only for non-universal players, as universal players handle this themselves)
1291        if native_player.provider.domain != "universal_player":
1292            self._save_linked_protocol_ids(native_player)
1293        # Always save the parent ID on the protocol player for reverse lookup on restart
1294        # (needed for both native and universal parents to enable fast restore)
1295        self._save_protocol_parent_id(protocol_player.player_id, native_player.player_id)
1296
1297        # The freshly linked player may have derived protocol players (e.g. a
1298        # Sendspin bridge riding on it) waiting to join the same parent.
1299        self._link_derived_protocols_of(protocol_player)
1300
1301    def _remove_protocol_link(
1302        self, native_player: Player, protocol_player_id: str, permanent: bool = False
1303    ) -> None:
1304        """
1305        Remove a protocol link.
1306
1307        :param native_player: The parent player to remove the link from.
1308        :param protocol_player_id: The protocol player ID to unlink.
1309        :param permanent: If True, also removes the protocol ID from the cached list.
1310            Use this when the protocol player config is being deleted. If False,
1311            the protocol ID remains in the cache so it can be shown as disabled
1312            and re-enabled later.
1313        """
1314        updated_protocols = [
1315            link
1316            for link in native_player.linked_output_protocols
1317            if link.output_protocol_id != protocol_player_id
1318        ]
1319        native_player.set_linked_output_protocols(updated_protocols)
1320
1321        # Clear parent reference on protocol player if it still exists
1322        if protocol_player := self.get_player(protocol_player_id):
1323            if protocol_player.protocol_parent_id == native_player.player_id:
1324                protocol_player.set_protocol_parent_id(None)
1325
1326        # Update persisted linked protocol IDs
1327        if native_player.provider.domain != "universal_player":
1328            if permanent:
1329                # Permanently remove from cache (player config is being deleted)
1330                self._remove_protocol_id_from_cache(native_player.player_id, protocol_player_id)
1331            # Note: we don't call _save_linked_protocol_ids here anymore for non-permanent
1332            # removals because the merge approach will preserve the ID in the cache
1333        # Always clear the cached parent ID (for both native and universal parents)
1334        self._clear_protocol_parent_id(protocol_player_id)
1335
1336    def _save_linked_protocol_ids(self, native_player: Player) -> None:
1337        """
1338        Save linked protocol IDs to config for persistence across restarts.
1339
1340        This method merges active protocol IDs with existing cached IDs to preserve
1341        disabled protocol players in the cache. This allows disabled protocols to be
1342        shown in the UI so they can be re-enabled.
1343        """
1344        conf_key = f"{CONF_PLAYERS}/{native_player.player_id}/values/{CONF_LINKED_PROTOCOL_IDS}"
1345        # Get existing cached IDs to preserve disabled protocols
1346        existing_ids: list[str] = self.mass.config.get(conf_key, [])
1347        # Get currently active protocol IDs
1348        active_ids = {link.output_protocol_id for link in native_player.linked_output_protocols}
1349        # Merge: keep existing IDs and add any new active ones
1350        merged_ids = list(existing_ids)
1351        for protocol_id in active_ids:
1352            if protocol_id not in merged_ids:
1353                merged_ids.append(protocol_id)
1354        self.mass.config.set(conf_key, merged_ids)
1355
1356    def _get_cached_protocol_ids(self, player_id: str) -> list[str]:
1357        """Get cached linked protocol IDs from config."""
1358        conf_key = f"{CONF_PLAYERS}/{player_id}/values/{CONF_LINKED_PROTOCOL_IDS}"
1359        result = self.mass.config.get(conf_key, [])
1360        return list(result) if result else []
1361
1362    def _remove_protocol_id_from_cache(
1363        self, parent_player_id: str, protocol_player_id: str
1364    ) -> None:
1365        """
1366        Permanently remove a protocol player ID from the cached linked protocol IDs.
1367
1368        Use this when a protocol player config is being deleted, not just disabled.
1369        """
1370        conf_key = f"{CONF_PLAYERS}/{parent_player_id}/values/{CONF_LINKED_PROTOCOL_IDS}"
1371        cached_ids: list[str] = self.mass.config.get(conf_key, [])
1372        if protocol_player_id in cached_ids:
1373            cached_ids.remove(protocol_player_id)
1374            self.mass.config.set(conf_key, cached_ids)
1375
1376    def _save_protocol_parent_id(self, protocol_player_id: str, parent_id: str) -> None:
1377        """Save the parent ID for a protocol player for persistence across restarts."""
1378        # Only save if the player config still exists to avoid creating partial entries
1379        if not self.mass.config.get(f"{CONF_PLAYERS}/{protocol_player_id}"):
1380            return
1381        conf_key = f"{CONF_PLAYERS}/{protocol_player_id}/values/{CONF_PROTOCOL_PARENT_ID}"
1382        self.mass.config.set(conf_key, parent_id)
1383
1384    def _save_underlying_player_id(self, player: Player) -> None:
1385        """
1386        Persist the derived-transport edge of a player to config.
1387
1388        Allows the edge to be resolved (e.g. by the config UI) even while the
1389        player is not registered. Clears a previously persisted edge when the
1390        player is no longer derived (e.g. a bridge client turned web player).
1391        """
1392        # Only save if the player config still exists to avoid creating partial entries
1393        if not self.mass.config.get(f"{CONF_PLAYERS}/{player.player_id}"):
1394            return
1395        conf_key = f"{CONF_PLAYERS}/{player.player_id}/values/{CONF_UNDERLYING_PLAYER_ID}"
1396        if player.underlying_player_id:
1397            self.mass.config.set(conf_key, player.underlying_player_id)
1398        elif self.mass.config.get(conf_key) is not None:
1399            self.mass.config.set(conf_key, None)
1400
1401    def _get_cached_protocol_parent_id(self, protocol_player_id: str) -> str | None:
1402        """Get cached parent ID for a protocol player from config."""
1403        conf_key = f"{CONF_PLAYERS}/{protocol_player_id}/values/{CONF_PROTOCOL_PARENT_ID}"
1404        result = self.mass.config.get(conf_key, None)
1405        return str(result) if result else None
1406
1407    def _clear_protocol_parent_id(self, protocol_player_id: str) -> None:
1408        """Clear the cached parent ID for a protocol player."""
1409        # Only clear if the player config still exists to avoid creating partial entries
1410        if not self.mass.config.get(f"{CONF_PLAYERS}/{protocol_player_id}"):
1411            return
1412        conf_key = f"{CONF_PLAYERS}/{protocol_player_id}/values/{CONF_PROTOCOL_PARENT_ID}"
1413        self.mass.config.set(conf_key, None)
1414
1415    def _recover_cached_protocol_links(self, native_player: Player) -> None:
1416        """
1417        Recover protocol links from config for disabled/missing protocols.
1418
1419        This ensures that disabled protocols show up in the output_protocols list
1420        so they can be re-enabled by the user. It also handles the case where
1421        protocol players haven't registered yet during startup.
1422        """
1423        # Get currently linked protocol IDs
1424        linked_protocol_ids = {
1425            link.output_protocol_id for link in native_player.linked_output_protocols
1426        }
1427
1428        # Get cached protocol IDs from config (includes protocols that were explicitly linked)
1429        cached_protocol_ids = self._get_cached_protocol_ids(native_player.player_id)
1430
1431        # Also check all protocol players that have protocol_parent_id pointing to this player
1432        # (this handles disabled protocols that may not be in linked_protocol_ids)
1433        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
1434        for protocol_id, protocol_config in all_player_configs.items():
1435            # Skip if not a protocol player
1436            if protocol_config.get("player_type") != "protocol":
1437                continue
1438            # Check if this protocol has a parent_id pointing to this native player
1439            protocol_values = protocol_config.get("values", {})
1440            protocol_parent_id = protocol_values.get(CONF_PROTOCOL_PARENT_ID)
1441            if protocol_parent_id == native_player.player_id:
1442                if protocol_id not in cached_protocol_ids:
1443                    cached_protocol_ids.append(protocol_id)
1444
1445        if not cached_protocol_ids:
1446            return
1447
1448        # Add link entries for any cached protocols that aren't currently linked
1449        for protocol_id in cached_protocol_ids:
1450            if protocol_id in linked_protocol_ids:
1451                continue  # Already linked
1452
1453            # Get protocol player config to determine the protocol domain
1454            protocol_config = self.mass.config.get(f"{CONF_PLAYERS}/{protocol_id}")
1455            if not protocol_config:
1456                continue
1457
1458            # Determine protocol domain from provider
1459            protocol_provider: str = protocol_config.get("provider")
1460            if not protocol_provider:
1461                continue
1462
1463            # Extract domain from provider instance_id (e.g., "airplay--uuid" -> "airplay")
1464            protocol_domain = protocol_provider.split("--", maxsplit=1)[0]
1465
1466            # Skip if parent already has a link from this domain
1467            existing_domains = {
1468                link.protocol_domain for link in native_player.linked_output_protocols
1469            }
1470            if protocol_domain in existing_domains:
1471                continue
1472
1473            # Get priority for this protocol
1474            priority = PROTOCOL_PRIORITY.get(protocol_domain, 100)
1475
1476            # Resolve the derived-transport edge from the live player when
1477            # registered, else from the persisted edge in config
1478            protocol_player = self.get_player(protocol_id)
1479            derived_from = (
1480                protocol_player.underlying_player_id
1481                if protocol_player
1482                else protocol_config.get("values", {}).get(CONF_UNDERLYING_PLAYER_ID)
1483            )
1484            if derived_from == native_player.player_id:
1485                derived_from = "native"
1486
1487            # Add the link entry
1488            native_player.linked_output_protocols.append(
1489                LinkedOutputProtocol(
1490                    output_protocol_id=protocol_id,
1491                    protocol_domain=protocol_domain,
1492                    priority=priority,
1493                    derived_from=derived_from,
1494                )
1495            )
1496            self.logger.debug(
1497                "Recovered cached protocol link %s -> %s",
1498                native_player.player_id,
1499                protocol_id,
1500            )
1501
1502    def _cleanup_protocol_links(self, player: Player) -> None:
1503        """Clean up protocol links when a player is permanently removed."""
1504        if player.state.type == PlayerType.PROTOCOL:
1505            # Protocol player being removed: remove link from parent
1506            if parent_id := player.protocol_parent_id:
1507                if parent_player := self.get_player(parent_id):
1508                    # Use permanent=True to also remove from cached protocol IDs
1509                    self._remove_protocol_link(parent_player, player.player_id, permanent=True)
1510                    if (
1511                        parent_player.provider.domain == "universal_player"
1512                        and len(parent_player.linked_output_protocols) == 0
1513                    ):
1514                        # No protocols left - remove universal player
1515                        self.logger.info(
1516                            "Universal player %s has no protocols left, removing",
1517                            parent_id,
1518                        )
1519                        self.mass.create_task(
1520                            self.mass.players.unregister(parent_id, permanent=True)
1521                        )
1522                    else:
1523                        parent_player.refresh_state()
1524                else:
1525                    # Parent not registered yet — still purge the cached id
1526                    self._remove_protocol_id_from_cache(parent_id, player.player_id)
1527        else:
1528            # Native/universal player being removed: handle all linked protocol players.
1529            # Collect all known protocol IDs from both active links and cached state,
1530            # since disabled/inactive protocols may only exist in the cached parent data.
1531            all_protocol_ids = set(self._get_known_protocol_ids(player))
1532            for protocol_id in all_protocol_ids:
1533                if protocol_player := self.get_player(protocol_id):
1534                    # Protocol player is available: clear parent and schedule re-evaluation
1535                    # so it can be matched to a new parent or a new universal player
1536                    self.logger.debug(
1537                        "Player %s removed - scheduling evaluation for protocol %s",
1538                        player.player_id,
1539                        protocol_id,
1540                    )
1541                    self._detach_protocol_child(protocol_player)
1542                else:
1543                    # Clear cached parent ID in config so protocol won't try to
1544                    # restore a link to the deleted player on next restart
1545                    self._clear_protocol_parent_id(protocol_id)
1546                    # Protocol player is not registered yet — it may still be
1547                    # mid-discovery (e.g., DLNA connecting via SSDP). Don't delete
1548                    # its config as that would cause a KeyError when it finishes
1549                    # registering. Stale configs are harmless and get cleaned up
1550                    # naturally on subsequent restarts.
1551                    self.logger.debug(
1552                        "Player %s removed - protocol %s not registered, skipping cleanup",
1553                        player.player_id,
1554                        protocol_id,
1555                    )
1556
1557    def _detach_protocol_children(self, parent_id: str) -> None:
1558        """
1559        Detach the registered protocol players of a parent player that is going away.
1560
1561        Covers the removal paths that don't unregister the parent first (e.g. its
1562        provider is unloaded), where the parent is not around anymore to enumerate
1563        its protocol players.
1564
1565        :param parent_id: Player id of the parent that is being removed.
1566        """
1567        for protocol_player in list(self._players.values()):
1568            if protocol_player.state.type != PlayerType.PROTOCOL:
1569                continue
1570            # a protocol player waiting for a parent that never registered only has
1571            # the link in its config, so fall back to the cached parent
1572            linked_parent_id = protocol_player.protocol_parent_id or (
1573                self._get_cached_protocol_parent_id(protocol_player.player_id)
1574            )
1575            if linked_parent_id != parent_id:
1576                continue
1577            self.logger.debug(
1578                "Player %s removed - scheduling evaluation for protocol %s",
1579                parent_id,
1580                protocol_player.player_id,
1581            )
1582            self._detach_protocol_child(protocol_player)
1583
1584    def _detach_protocol_child(self, protocol_player: Player) -> None:
1585        """Clear a protocol player's parent link and schedule a fresh evaluation."""
1586        self._clear_protocol_parent_id(protocol_player.player_id)
1587        protocol_player.set_protocol_parent_id(None)
1588        protocol_player.refresh_state()
1589        self._schedule_protocol_evaluation(protocol_player)
1590
1591    def _identifiers_match(
1592        self, player_a: Player, player_b: Player, protocol_domain: str = ""
1593    ) -> bool:
1594        """
1595        Check if identifiers match between two players.
1596
1597        Matching is done by comparing connection identifiers (MAC, serial, UUID).
1598        As a last resort, IP address is used when at least one player has a
1599        locally-administered MAC, indicating the device uses MAC randomization
1600        and ARP could not resolve the real hardware address.
1601
1602        Invalid identifiers (e.g., 00:00:00:00:00:00 MAC addresses) are filtered out
1603        to prevent false matches between unrelated devices.
1604        """
1605        identifiers_a = player_a.device_info.identifiers
1606        identifiers_b = player_b.device_info.identifiers
1607
1608        # Check identifiers in order of reliability
1609        # MAC_ADDRESS > SERIAL_NUMBER > UUID > CAST_UUID > AIRPLAY_ID
1610        for conn_type in (
1611            IdentifierType.MAC_ADDRESS,
1612            IdentifierType.SERIAL_NUMBER,
1613            IdentifierType.UUID,
1614            IdentifierType.CAST_UUID,
1615            IdentifierType.AIRPLAY_ID,
1616        ):
1617            val_a = identifiers_a.get(conn_type)
1618            val_b = identifiers_b.get(conn_type)
1619
1620            if not val_a or not val_b:
1621                continue
1622
1623            # Filter out invalid MAC addresses (00:00:00:00:00:00, ff:ff:ff:ff:ff:ff)
1624            if conn_type == IdentifierType.MAC_ADDRESS:
1625                if not is_valid_mac_address(val_a) or not is_valid_mac_address(val_b):
1626                    self.logger.log(
1627                        VERBOSE_LOG_LEVEL,
1628                        "Skipping invalid MAC address for matching: %s=%s, %s=%s",
1629                        player_a.display_name,
1630                        val_a,
1631                        player_b.display_name,
1632                        val_b,
1633                    )
1634                    continue
1635
1636            # Normalize values for comparison
1637            if conn_type == IdentifierType.MAC_ADDRESS:
1638                # Use MAC normalization that handles locally-administered bit differences
1639                # Some protocols (like AirPlay) report a locally-administered MAC variant
1640                # where bit 1 of the first octet is set (e.g., 54:78:... vs 56:78:...)
1641                val_a_norm = normalize_mac_for_matching(val_a)
1642                val_b_norm = normalize_mac_for_matching(val_b)
1643
1644                # Direct match on current MAC
1645                if val_a_norm == val_b_norm:
1646                    return True
1647
1648                # Multi-MAC matching: also check original reported MACs.
1649                # Devices with multiple interfaces (WiFi + Ethernet) may have ARP
1650                # resolve one MAC while the protocol reports a different one.
1651                macs_a = {val_a_norm}
1652                macs_b = {val_b_norm}
1653                reported_a = player_a.extra_data.get("reported_mac")
1654                reported_b = player_b.extra_data.get("reported_mac")
1655                if reported_a and is_valid_mac_address(reported_a):
1656                    macs_a.add(normalize_mac_for_matching(reported_a))
1657                if reported_b and is_valid_mac_address(reported_b):
1658                    macs_b.add(normalize_mac_for_matching(reported_b))
1659                if macs_a & macs_b:
1660                    return True
1661
1662                # No MAC match - continue to next identifier type
1663                continue
1664
1665            val_a_norm = val_a.lower().replace(":", "").replace("-", "")
1666            val_b_norm = val_b.lower().replace(":", "").replace("-", "")
1667
1668            # Direct match
1669            if val_a_norm == val_b_norm:
1670                return True
1671
1672            # Special case: Sonos UUID matching with DLNA _MR suffix
1673            # Sonos uses RINCON_xxx, DLNA uses RINCON_xxx_MR for Media Renderer
1674            if conn_type == IdentifierType.UUID:
1675                if val_b_norm.endswith("_mr") and val_b_norm[:-3] == val_a_norm:
1676                    return True
1677                if val_a_norm.endswith("_mr") and val_a_norm[:-3] == val_b_norm:
1678                    return True
1679
1680        # Last resort: IP-based matching.
1681        # Two players on the same IP are very likely the same physical device.
1682        # This handles two cases:
1683        # 1. MAC randomization: at least one player has no real MAC (LA or missing),
1684        #    so ARP couldn't resolve a usable address.
1685        # 2. Different MACs per protocol: some devices (e.g., Yamaha MusicCast) report
1686        #    different valid globally-unique MACs per protocol (DLNA vs AirPlay differ
1687        #    by 1 in the last octet). IP matching is safe here because two different
1688        #    devices on a LAN cannot share the same IP simultaneously.
1689        #    To avoid false positives between unrelated native players, this path
1690        #    requires at least one player to be a protocol or universal player.
1691        ip_a = identifiers_a.get(IdentifierType.IP_ADDRESS)
1692        ip_b = identifiers_b.get(IdentifierType.IP_ADDRESS)
1693        if ip_a and ip_b and ip_a == ip_b:
1694            mac_a = identifiers_a.get(IdentifierType.MAC_ADDRESS)
1695            mac_b = identifiers_b.get(IdentifierType.MAC_ADDRESS)
1696            a_is_real = (
1697                mac_a is not None
1698                and is_valid_mac_address(mac_a)
1699                and not is_locally_administered_mac(mac_a)
1700            )
1701            b_is_real = (
1702                mac_b is not None
1703                and is_valid_mac_address(mac_b)
1704                and not is_locally_administered_mac(mac_b)
1705            )
1706            # Case 1: at least one player has no real hardware MAC
1707            if not (a_is_real and b_is_real):
1708                return True
1709            # Case 2: both have real MACs but at least one is a protocol/universal player
1710            a_is_protocol = (
1711                player_a.type == PlayerType.PROTOCOL
1712                or player_a.provider.domain == "universal_player"
1713            )
1714            b_is_protocol = (
1715                player_b.type == PlayerType.PROTOCOL
1716                or player_b.provider.domain == "universal_player"
1717            )
1718            if a_is_protocol or b_is_protocol:
1719                return True
1720
1721        return False
1722
1723    def _select_best_output_protocol(self, player: Player) -> tuple[Player, OutputProtocol | None]:
1724        """
1725        Select the best available output protocol for a player.
1726
1727        Selection priority:
1728        1. Output protocol that is currently grouped/synced with other players.
1729        2. User's preferred output protocol (from player settings).
1730        3. Native playback (if player supports PLAY_MEDIA).
1731        4. Best available protocol by priority.
1732
1733        Returns tuple of (target_player, output_protocol).
1734        output_protocol is None when using native playback.
1735        """
1736        self.logger.log(
1737            VERBOSE_LOG_LEVEL,
1738            "Selecting output protocol for %s",
1739            player.state.name,
1740        )
1741
1742        # 1. Check if any output protocol is currently grouped
1743        for linked in player.linked_output_protocols:
1744            if protocol_player := self.get_player(linked.output_protocol_id):
1745                if protocol_player.available_for_playback and self._is_protocol_grouped(
1746                    protocol_player
1747                ):
1748                    self.logger.log(
1749                        VERBOSE_LOG_LEVEL,
1750                        "Selected protocol for %s: %s (grouped)",
1751                        player.state.name,
1752                        protocol_player.state.name,
1753                    )
1754                    return protocol_player, player.get_linked_protocol(linked.output_protocol_id)
1755
1756        # 2. Check for user's preferred output protocol.
1757        # The value is only stored while it differs from the entry's default, which is computed
1758        # per player: "native" when a native output is available, otherwise "auto". Both of those
1759        # are handled identically by the steps below, so an absent value can safely fall through.
1760        preferred = self.mass.config.get_raw_player_config_value(
1761            player.player_id, CONF_PREFERRED_OUTPUT_PROTOCOL
1762        )
1763        if preferred and preferred != "auto":
1764            if preferred == "native":
1765                if PlayerFeature.PLAY_MEDIA in player.supported_features:
1766                    self.logger.log(
1767                        VERBOSE_LOG_LEVEL,
1768                        "Selected protocol for %s: native (user preference)",
1769                        player.state.name,
1770                    )
1771                    return player, None
1772            else:
1773                for linked in player.linked_output_protocols:
1774                    if linked.output_protocol_id == preferred:
1775                        if protocol_player := self.get_player(linked.output_protocol_id):
1776                            if protocol_player.available_for_playback:
1777                                self.logger.log(
1778                                    VERBOSE_LOG_LEVEL,
1779                                    "Selected protocol for %s: %s (user preference)",
1780                                    player.state.name,
1781                                    protocol_player.state.name,
1782                                )
1783                                return protocol_player, player.get_linked_protocol(
1784                                    linked.output_protocol_id
1785                                )
1786                        break
1787
1788        # 3. Use native playback if available
1789        if PlayerFeature.PLAY_MEDIA in player.supported_features:
1790            self.logger.log(
1791                VERBOSE_LOG_LEVEL, "Selected protocol for %s: native", player.state.name
1792            )
1793            return player, None
1794
1795        # 4. Fall back to best protocol by priority
1796        for linked in sorted(player.linked_output_protocols, key=lambda x: x.priority):
1797            if protocol_player := self.get_player(linked.output_protocol_id):
1798                if protocol_player.available_for_playback:
1799                    self.logger.log(
1800                        VERBOSE_LOG_LEVEL,
1801                        "Selected protocol for %s: %s (priority-based)",
1802                        player.state.name,
1803                        protocol_player.state.name,
1804                    )
1805                    return protocol_player, player.get_linked_protocol(linked.output_protocol_id)
1806
1807        raise PlayerCommandFailed(f"Player {player.state.name} has no available output protocols")
1808
1809    def _get_control_target(
1810        self,
1811        player: Player,
1812        required_feature: PlayerFeature,
1813        require_active: bool = False,
1814    ) -> Player | None:
1815        """
1816        Get the best player(protocol) to send control commands to.
1817
1818        Prefers the active output protocol, otherwise uses the first available
1819        protocol player that supports the needed feature.
1820        """
1821        # If we have an active protocol, use that
1822        if (
1823            player.active_output_protocol
1824            and player.active_output_protocol != "native"
1825            and (protocol_player := self.mass.players.get_player(player.active_output_protocol))
1826            and required_feature in protocol_player.supported_features
1827        ):
1828            return protocol_player
1829
1830        # if the player natively supports the required feature, use that
1831        if (
1832            player.active_output_protocol == "native"
1833            and required_feature in player.supported_features
1834        ):
1835            return player
1836
1837        # If require_active is set, and no active protocol found, return None
1838        if require_active:
1839            return None
1840
1841        # if the player natively supports the required feature, use that
1842        if required_feature in player.supported_features:
1843            return player
1844        # Otherwise, use the first available linked protocol
1845        for linked in player.linked_output_protocols:
1846            if (
1847                (protocol_player := self.mass.players.get_player(linked.output_protocol_id))
1848                and protocol_player.available_for_playback
1849                and required_feature in protocol_player.supported_features
1850            ):
1851                return protocol_player
1852
1853        return None
1854
1855    def _is_protocol_grouped(self, protocol_player: Player) -> bool:
1856        """
1857        Check if a protocol player is currently grouped/synced with other players.
1858
1859        Used to prefer protocols that are actively participating in a group,
1860        ensuring consistent playback across grouped players.
1861        """
1862        is_grouped = bool(
1863            protocol_player.state.synced_to
1864            or (
1865                protocol_player.state.group_members and len(protocol_player.state.group_members) > 1
1866            )
1867            or protocol_player.state.active_group
1868        )
1869        if is_grouped:
1870            self.logger.log(
1871                VERBOSE_LOG_LEVEL,
1872                "Protocol player %s is grouped",
1873                protocol_player.state.name,
1874            )
1875        return is_grouped
1876
1877    def _translate_members_to_remove_for_protocols(
1878        self,
1879        parent_player: Player,
1880        player_ids: list[str],
1881        parent_protocol_player: Player | None,
1882        parent_protocol_domain: str | None,
1883    ) -> tuple[list[str], list[str]]:
1884        """
1885        Translate member IDs to remove into protocol and native lists.
1886
1887        :param parent_player: The parent player to remove members from.
1888        :param player_ids: List of visible player IDs to remove.
1889        :param parent_protocol_player: The parent's protocol player if available.
1890        :param parent_protocol_domain: The parent's protocol domain if available.
1891        """
1892        self.logger.debug(
1893            "Translating members to remove for %s: player_ids=%s, parent_protocol_domain=%s",
1894            parent_player.state.name,
1895            player_ids,
1896            parent_protocol_domain,
1897        )
1898        protocol_members: list[str] = []
1899        native_members: list[str] = []
1900
1901        for child_player_id in player_ids:
1902            child_player = self.get_player(child_player_id)
1903            if not child_player:
1904                continue
1905
1906            # Check if this member is in the parent's group via protocol
1907            if parent_protocol_domain and parent_protocol_player:
1908                child_protocol = child_player.get_output_protocol_by_domain(parent_protocol_domain)
1909                if child_protocol and child_protocol.available:
1910                    # For native protocol players, use the child's player_id directly
1911                    child_protocol_id = (
1912                        child_player.player_id
1913                        if child_protocol.is_native
1914                        else child_protocol.output_protocol_id
1915                    )
1916                    if child_protocol_id in parent_protocol_player.group_members:
1917                        self.logger.debug(
1918                            "Translating removal: %s -> protocol %s",
1919                            child_player_id,
1920                            child_protocol_id,
1921                        )
1922                        protocol_members.append(child_protocol_id)
1923                        continue
1924
1925            # Check if child's protocol player is in parent's native group_members
1926            # This handles native protocol players (e.g., native AirPlay player like Apple TV)
1927            # where the parent itself contains protocol player IDs in its group_members
1928            translated = False
1929            for linked in child_player.linked_output_protocols:
1930                if linked.output_protocol_id in parent_player.group_members:
1931                    self.logger.debug(
1932                        "Translating removal (native parent): %s -> protocol %s",
1933                        child_player_id,
1934                        linked.output_protocol_id,
1935                    )
1936                    native_members.append(linked.output_protocol_id)
1937                    translated = True
1938                    break
1939
1940            if not translated:
1941                native_members.append(child_player_id)
1942
1943        return protocol_members, native_members
1944
1945    def _filter_protocol_members(self, member_ids: list[str], protocol_player: Player) -> list[str]:
1946        """Filter member IDs to only include players from the same protocol domain."""
1947        return [
1948            pid
1949            for pid in member_ids
1950            if (p := self.get_player(pid)) and p.provider.domain == protocol_player.provider.domain
1951        ]
1952
1953    def _filter_native_members(self, member_ids: list[str], parent_player: Player) -> list[str]:
1954        """Filter member IDs to only include players compatible with the parent."""
1955        return [
1956            pid
1957            for pid in member_ids
1958            if (p := self.get_player(pid))
1959            and (
1960                p.provider.instance_id == parent_player.provider.instance_id
1961                or pid in parent_player._attr_can_group_with
1962                or p.provider.instance_id in parent_player._attr_can_group_with
1963            )
1964        ]
1965
1966    def _try_child_preferred_protocol(
1967        self,
1968        child_player: Player,
1969        parent_player: Player,
1970    ) -> tuple[str | None, str | None]:
1971        """
1972        Try to use child's preferred output protocol for grouping.
1973
1974        Returns tuple of (child_protocol_id, protocol_domain) or (None, None).
1975        """
1976        child_preferred = self.mass.config.get_raw_player_config_value(
1977            child_player.player_id, CONF_PREFERRED_OUTPUT_PROTOCOL
1978        )
1979        if not child_preferred or child_preferred in {"auto", "native"}:
1980            return None, None
1981
1982        # Find child's preferred protocol, with its current availability
1983        child_protocol = None
1984        for output_protocol in child_player.output_protocols:
1985            if output_protocol.output_protocol_id == child_preferred:
1986                child_protocol = output_protocol
1987                break
1988
1989        if not child_protocol or not child_protocol.available:
1990            return None, None
1991
1992        # Check if parent supports this protocol (including native protocol)
1993        parent_protocol = parent_player.get_output_protocol_by_domain(
1994            child_protocol.protocol_domain
1995        )
1996        if not parent_protocol or not parent_protocol.available:
1997            return None, None
1998
1999        # Check if this protocol supports set_members
2000        protocol_player = parent_player.get_protocol_player(parent_protocol.output_protocol_id)
2001        if (
2002            not protocol_player
2003            or PlayerFeature.SET_MEMBERS not in protocol_player.state.supported_features
2004        ):
2005            return None, None
2006
2007        return child_protocol.output_protocol_id, child_protocol.protocol_domain
2008
2009    def _can_use_native_grouping(
2010        self,
2011        child_player: Player,
2012        parent_player: Player,
2013        parent_supports_native: bool,
2014    ) -> bool:
2015        """Check if child can be grouped with parent using native grouping."""
2016        if not parent_supports_native:
2017            return False
2018        return (
2019            child_player.provider.instance_id == parent_player.provider.instance_id
2020            or child_player.player_id in parent_player._attr_can_group_with
2021            or child_player.provider.instance_id in parent_player._attr_can_group_with
2022        )
2023
2024    def _try_find_common_protocol(
2025        self, child_player: Player, parent_player: Player
2026    ) -> tuple[OutputProtocol | None, OutputProtocol | None]:
2027        """
2028        Find common protocol that supports set_members.
2029
2030        Returns tuple of (parent_protocol, child_protocol) or (None, None).
2031        """
2032        for parent_output_protocol in parent_player.output_protocols:
2033            if not parent_output_protocol.available:
2034                continue
2035            child_protocol = child_player.get_output_protocol_by_domain(
2036                parent_output_protocol.protocol_domain
2037            )
2038            if not child_protocol or not child_protocol.available:
2039                continue
2040            protocol_player = parent_player.get_protocol_player(
2041                parent_output_protocol.output_protocol_id
2042            )
2043            if protocol_player and PlayerFeature.SET_MEMBERS in protocol_player.supported_features:
2044                return parent_output_protocol, child_protocol
2045        return None, None
2046
2047    def _parent_has_live_native_session(self, parent_player: Player) -> bool:
2048        """
2049        Return True when the parent currently holds a live native playback session.
2050
2051        The active output protocol lingers for a few seconds after stop, so a non-idle
2052        playback state is required to distinguish a real session from a just-stopped one.
2053        """
2054        return parent_player.active_output_protocol == "native" and (
2055            parent_player.state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
2056        )
2057
2058    def _order_members_for_native_join(
2059        self,
2060        player_ids: list[str],
2061        parent_player: Player,
2062        parent_supports_native_grouping: bool,
2063    ) -> list[str]:
2064        """
2065        Order members so a live native session can be joined without splitting the group.
2066
2067        When the parent already holds a live native session, children that cannot group
2068        natively are evaluated first: they may force a shared protocol for the whole group,
2069        and processing them before the native-capable children lets those join that same
2070        protocol instead of being stranded in a separate native sub-group. The order is left
2071        untouched when the parent is not playing natively, so fresh-group selection is unchanged.
2072
2073        :param player_ids: The member IDs to be added, in their original order.
2074        :param parent_player: The parent player being joined.
2075        :param parent_supports_native_grouping: Whether the parent can group natively.
2076        """
2077        if not self._parent_has_live_native_session(parent_player):
2078            return player_ids
2079        return sorted(
2080            player_ids,
2081            key=lambda pid: bool(
2082                (child := self.get_player(pid))
2083                and self._can_use_native_grouping(
2084                    child, parent_player, parent_supports_native_grouping
2085                )
2086            ),
2087        )
2088
2089    def _try_join_active_native_session(
2090        self,
2091        child_player: Player,
2092        parent_player: Player,
2093        parent_protocol_domain: str | None,
2094        parent_supports_native_grouping: bool,
2095        native_members: list[str],
2096    ) -> bool:
2097        """
2098        Add the child to native_members if it can join the parent's active native session.
2099
2100        A child's preferred output protocol must only steer protocol selection when the child
2101        initiates its own playback; when it joins a parent that is already playing natively it
2102        should adopt native grouping if compatible, rather than forcing the whole group onto
2103        the child's preferred protocol. Skipped once a protocol has been selected for the group,
2104        so mixed batches stay cohesive on a single protocol.
2105
2106        :param child_player: The player being added to the group.
2107        :param parent_player: The parent player being joined.
2108        :param parent_protocol_domain: The protocol domain already selected for the group, if any.
2109        :param parent_supports_native_grouping: Whether the parent can group natively.
2110        :param native_members: The native members list to append to when the child joins.
2111        """
2112        if not (
2113            self._parent_has_live_native_session(parent_player)
2114            and not parent_protocol_domain
2115            and self._can_use_native_grouping(
2116                child_player, parent_player, parent_supports_native_grouping
2117            )
2118        ):
2119            return False
2120        native_members.append(child_player.player_id)
2121        self.logger.log(
2122            VERBOSE_LOG_LEVEL,
2123            "Joining parent's active native session for %s",
2124            child_player.state.name,
2125        )
2126        return True
2127
2128    def _translate_native_members_to_protocol(
2129        self, parent_player: Player, protocol_domain: str, member_ids: list[str]
2130    ) -> list[str]:
2131        """
2132        Translate natively grouped members onto the protocol domain the parent plays through.
2133
2134        Members that do not have that protocol cannot follow the parent at all and are
2135        dropped with a warning instead.
2136
2137        :param parent_player: The parent player the members are grouped with.
2138        :param protocol_domain: The protocol domain selected for the group.
2139        :param member_ids: The member IDs that were selected for native grouping.
2140        """
2141        translated: list[str] = []
2142        for member_id in member_ids:
2143            member_player = self.get_player(member_id)
2144            if not member_player:
2145                continue
2146            # a native group's members may be listed by their protocol player id
2147            if member_player.protocol_parent_id:
2148                member_player = self.get_player(member_player.protocol_parent_id) or member_player
2149            member_protocol = member_player.get_output_protocol_by_domain(protocol_domain)
2150            if not member_protocol or not member_protocol.available:
2151                self.logger.warning(
2152                    "Cannot group %s with %s: the group plays through the %s protocol, "
2153                    "which %s does not support",
2154                    member_player.state.name,
2155                    parent_player.state.name,
2156                    protocol_domain,
2157                    member_player.state.name,
2158                )
2159                continue
2160            # For native protocol players, use the member's player_id directly
2161            translated.append(
2162                member_player.player_id
2163                if member_protocol.is_native
2164                else member_protocol.output_protocol_id
2165            )
2166            self.logger.log(
2167                VERBOSE_LOG_LEVEL,
2168                "Moving %s from native grouping to the %s protocol",
2169                member_player.state.name,
2170                protocol_domain,
2171            )
2172        return translated
2173
2174    def _move_native_members_to_group_protocol(
2175        self,
2176        parent_player: Player,
2177        parent_protocol_player: Player | None,
2178        parent_protocol_domain: str | None,
2179        protocol_members: list[str],
2180        native_members: list[str],
2181    ) -> None:
2182        """
2183        Move the members selected for native grouping onto the protocol the group ended up on.
2184
2185        Does nothing unless the group ends up on one of the parent's protocols while the
2186        parent's native grouping needs the parent's own stream: only then do those members
2187        have no session left to attach to.
2188
2189        :param parent_player: The parent player being joined.
2190        :param parent_protocol_player: The protocol player selected for the group, if any.
2191        :param parent_protocol_domain: The protocol domain selected for the group, if any.
2192        :param protocol_members: The protocol member list the translated IDs are added to.
2193        :param native_members: The native member IDs, emptied when they are moved over.
2194        """
2195        if not (
2196            native_members
2197            and parent_protocol_domain
2198            and parent_protocol_player
2199            and parent_protocol_player.player_id != parent_player.player_id
2200            and parent_player.native_grouping_requires_own_stream
2201        ):
2202            return
2203        protocol_members.extend(
2204            self._translate_native_members_to_protocol(
2205                parent_player, parent_protocol_domain, native_members
2206            )
2207        )
2208        native_members.clear()
2209
2210    def _migrate_stranded_native_members(
2211        self,
2212        parent_player: Player,
2213        parent_protocol_player: Player,
2214        protocol_members: list[str],
2215    ) -> list[str]:
2216        """
2217        Move the native members that a switch to the given protocol strands onto that protocol.
2218
2219        Returns the member IDs that are still attached to the parent's own stream, so the
2220        caller can release them from it. Empty unless the parent renders that stream itself
2221        while its native grouping attaches the members to exactly that stream: only then are
2222        they left without anything to play.
2223
2224        :param parent_player: The parent player that is about to switch protocol.
2225        :param parent_protocol_player: The protocol player the parent will render through.
2226        :param protocol_members: The protocol member list the translated IDs are added to.
2227        """
2228        if parent_protocol_player.player_id == parent_player.player_id:
2229            return []
2230        if not parent_player.native_grouping_requires_own_stream:
2231            return []
2232        if parent_player.active_output_protocol not in (None, "native"):
2233            return []
2234        if parent_player.state.playback_state not in (PlaybackState.PLAYING, PlaybackState.PAUSED):
2235            return []
2236        stranded = [
2237            member_id
2238            for member_id in parent_player.group_members
2239            if member_id != parent_player.player_id
2240        ]
2241        for protocol_id in self._translate_native_members_to_protocol(
2242            parent_player, parent_protocol_player.provider.domain, stranded
2243        ):
2244            if protocol_id not in protocol_members:
2245                protocol_members.append(protocol_id)
2246        return stranded
2247
2248    async def _stop_native_session(
2249        self,
2250        parent_player: Player,
2251        parent_protocol_player: Player,
2252        stranded_native_members: list[str],
2253    ) -> None:
2254        """
2255        Release the given members from the parent's own stream and stop it.
2256
2257        :param parent_player: The parent player whose native session is handed over.
2258        :param parent_protocol_player: The protocol player taking the output over.
2259        :param stranded_native_members: The members to release, already migrated.
2260        """
2261        self.logger.debug(
2262            "Stopping the native session of %s before switching to %s, migrated members: %s",
2263            parent_player.state.name,
2264            parent_protocol_player.state.name,
2265            stranded_native_members,
2266        )
2267        # The members already joined the protocol group, so the native session only has to
2268        # release them and stop. Releasing them first also clears the native group, which
2269        # keeps a later native playback command from resurrecting it. Both calls take the
2270        # provider's own lock, so they must run one after the other.
2271        await parent_player.set_members(player_ids_to_remove=stranded_native_members)
2272        await parent_player.stop()
2273
2274    def _translate_members_for_protocols(
2275        self,
2276        parent_player: Player,
2277        player_ids: list[str],
2278        parent_protocol_player: Player | None,
2279        parent_protocol_domain: str | None,
2280    ) -> tuple[list[str], list[str], Player | None, str | None]:
2281        """
2282        Translate member IDs to protocol or native IDs.
2283
2284        Selection priority when grouping:
2285        0. If the parent is already playing natively and the child can be grouped
2286           natively, join that native session (a child joining an existing group must
2287           not force the whole group onto its own preferred output protocol)
2288        1. Try child's preferred output protocol (from player settings)
2289        2. Try parent's active output protocol (if any and child supports it)
2290        3. Try native grouping (if parent and child are compatible)
2291        4. Search for common protocol that supports set_members
2292        5. Log warning if no option works
2293
2294        Returns tuple of (protocol_members, native_members, protocol_player, protocol_domain).
2295        """
2296        protocol_members: list[str] = []
2297        native_members: list[str] = []
2298        parent_supports_native_grouping = (
2299            PlayerFeature.SET_MEMBERS in parent_player.supported_features
2300        )
2301        player_ids = self._order_members_for_native_join(
2302            player_ids, parent_player, parent_supports_native_grouping
2303        )
2304
2305        self.logger.log(
2306            VERBOSE_LOG_LEVEL,
2307            "Translating members for %s: parent_supports_native=%s, parent_protocol=%s (%s)",
2308            parent_player.state.name,
2309            parent_supports_native_grouping,
2310            parent_protocol_player.state.name if parent_protocol_player else "none",
2311            parent_protocol_domain or "none",
2312        )
2313
2314        for child_player_id in player_ids:
2315            child_player = self.get_player(child_player_id)
2316            if not child_player:
2317                continue
2318
2319            self.logger.log(
2320                VERBOSE_LOG_LEVEL,
2321                "Processing child %s (type=%s, protocols=%s)",
2322                child_player.state.name,
2323                child_player.state.type,
2324                [p.protocol_domain for p in child_player.output_protocols],
2325            )
2326
2327            # Priority 0: The parent is already playing natively and the child can join
2328            # that native session directly - adopt it before considering the child's own
2329            # preferred output protocol.
2330            if self._try_join_active_native_session(
2331                child_player,
2332                parent_player,
2333                parent_protocol_domain,
2334                parent_supports_native_grouping,
2335                native_members,
2336            ):
2337                continue
2338
2339            # Priority 1: Try child's preferred output protocol
2340            # (only if no active protocol or if it matches the active protocol)
2341            child_protocol_id, protocol_domain = self._try_child_preferred_protocol(
2342                child_player, parent_player
2343            )
2344            if (
2345                child_protocol_id
2346                and protocol_domain
2347                and (not parent_protocol_domain or protocol_domain == parent_protocol_domain)
2348            ):
2349                if not parent_protocol_player or parent_protocol_domain != protocol_domain:
2350                    parent_protocol = parent_player.get_output_protocol_by_domain(protocol_domain)
2351                    if parent_protocol:
2352                        parent_protocol_player = parent_player.get_protocol_player(
2353                            parent_protocol.output_protocol_id
2354                        )
2355                        parent_protocol_domain = protocol_domain
2356                protocol_members.append(child_protocol_id)
2357                self.logger.log(
2358                    VERBOSE_LOG_LEVEL,
2359                    "Using child's preferred protocol %s for %s",
2360                    protocol_domain,
2361                    child_player.state.name,
2362                )
2363                continue
2364
2365            # Priority 2: Try parent's active output protocol (if it supports SET_MEMBERS)
2366            if parent_protocol_domain and parent_protocol_player:
2367                # Verify the active protocol supports SET_MEMBERS
2368                if PlayerFeature.SET_MEMBERS in parent_protocol_player.state.supported_features:
2369                    child_protocol = child_player.get_output_protocol_by_domain(
2370                        parent_protocol_domain
2371                    )
2372                    if child_protocol and child_protocol.available:
2373                        # For native protocol players, use the child's player_id directly
2374                        # (e.g., a native sendspin web player IS the protocol player)
2375                        child_protocol_id = (
2376                            child_player.player_id
2377                            if child_protocol.is_native
2378                            else child_protocol.output_protocol_id
2379                        )
2380                        protocol_members.append(child_protocol_id)
2381                        self.logger.log(
2382                            VERBOSE_LOG_LEVEL,
2383                            "Using parent's active protocol %s for %s",
2384                            parent_protocol_domain,
2385                            child_player.state.name,
2386                        )
2387                        continue
2388                else:
2389                    self.logger.log(
2390                        VERBOSE_LOG_LEVEL,
2391                        "Parent's active protocol %s does not support SET_MEMBERS, "
2392                        "will search for alternative",
2393                        parent_protocol_domain,
2394                    )
2395                    # Clear the parent protocol so Priority 4 can select a new one
2396                    parent_protocol_player = None
2397                    parent_protocol_domain = None
2398
2399            # Priority 3: Try native grouping
2400            if self._can_use_native_grouping(
2401                child_player, parent_player, parent_supports_native_grouping
2402            ):
2403                native_members.append(child_player_id)
2404                self.logger.log(
2405                    VERBOSE_LOG_LEVEL,
2406                    "Using native grouping for %s",
2407                    child_player.state.name,
2408                )
2409                continue
2410
2411            # Priority 4: Search for common protocol that supports set_members
2412            parent_protocol, child_protocol = self._try_find_common_protocol(
2413                child_player, parent_player
2414            )
2415            if parent_protocol and child_protocol:
2416                if (
2417                    not parent_protocol_player
2418                    or parent_protocol_domain != parent_protocol.protocol_domain
2419                ):
2420                    parent_protocol_player = parent_player.get_protocol_player(
2421                        parent_protocol.output_protocol_id
2422                    )
2423                    if parent_protocol_player:
2424                        parent_protocol_domain = parent_protocol_player.provider.domain
2425                # For native protocol players, use the child's player_id directly
2426                child_protocol_id = (
2427                    child_player.player_id
2428                    if child_protocol.is_native
2429                    else child_protocol.output_protocol_id
2430                )
2431                protocol_members.append(child_protocol_id)
2432                self.logger.log(
2433                    VERBOSE_LOG_LEVEL,
2434                    "Selected common protocol %s for grouping %s with %s",
2435                    parent_protocol.protocol_domain,
2436                    child_player.state.name,
2437                    parent_player.state.name,
2438                )
2439                continue
2440
2441            # Priority 5: No option worked - log warning
2442            self.logger.warning(
2443                "Cannot group %s with %s: no compatible grouping method found "
2444                "(tried: child preferred protocol, native grouping, "
2445                "parent active protocol, common protocols)",
2446                child_player.state.name,
2447                parent_player.state.name,
2448            )
2449
2450        # Post-pass: the protocol selected for the group is only known once every child has
2451        # been processed, so the members picked for native grouping are corrected here.
2452        self._move_native_members_to_group_protocol(
2453            parent_player,
2454            parent_protocol_player,
2455            parent_protocol_domain,
2456            protocol_members,
2457            native_members,
2458        )
2459
2460        return protocol_members, native_members, parent_protocol_player, parent_protocol_domain
2461
2462    async def _forward_protocol_set_members(
2463        self,
2464        parent_player: Player,
2465        parent_protocol_player: Player,
2466        protocol_members_to_add: list[str],
2467        protocol_members_to_remove: list[str],
2468    ) -> None:
2469        """
2470        Forward protocol members to protocol player's set_members and manage active output protocol.
2471
2472        :param parent_player: The parent player (native/universal).
2473        :param parent_protocol_player: The protocol player to forward commands to.
2474        :param protocol_members_to_add: Protocol player IDs to add.
2475        :param protocol_members_to_remove: Protocol player IDs to remove.
2476        """
2477        filtered_protocol_add = self._filter_protocol_members(
2478            protocol_members_to_add, parent_protocol_player
2479        )
2480        filtered_protocol_remove = self._filter_protocol_members(
2481            protocol_members_to_remove, parent_protocol_player
2482        )
2483        self.logger.debug(
2484            "Protocol grouping on %s: filtered_add=%s, filtered_remove=%s",
2485            parent_protocol_player.state.name,
2486            filtered_protocol_add,
2487            filtered_protocol_remove,
2488        )
2489
2490        if not filtered_protocol_add and not filtered_protocol_remove:
2491            return
2492
2493        # Safety check: verify protocol player supports SET_MEMBERS
2494        if PlayerFeature.SET_MEMBERS not in parent_protocol_player.state.supported_features:
2495            self.logger.error(
2496                "Protocol player %s does not support SET_MEMBERS, cannot perform grouping. "
2497                "This should have been caught earlier in the flow.",
2498                parent_protocol_player.state.name,
2499            )
2500            return
2501
2502        # Members that ride the parent's own stream are stranded by the protocol switch below,
2503        # so they join the protocol group in this very same call and their native session is
2504        # torn down afterwards.
2505        stranded_native_members = (
2506            self._migrate_stranded_native_members(
2507                parent_player, parent_protocol_player, filtered_protocol_add
2508            )
2509            if filtered_protocol_add
2510            else []
2511        )
2512
2513        self.logger.debug(
2514            "Calling set_members on protocol player %s with add=%s, remove=%s",
2515            parent_protocol_player.state.name,
2516            filtered_protocol_add,
2517            filtered_protocol_remove,
2518        )
2519        await parent_protocol_player.set_members(
2520            player_ids_to_add=filtered_protocol_add or None,
2521            player_ids_to_remove=filtered_protocol_remove or None,
2522        )
2523
2524        # Set active output protocol on added child players
2525        if filtered_protocol_add:
2526            for child_protocol_id in filtered_protocol_add:
2527                if child_protocol := self.get_player(child_protocol_id):
2528                    if child_protocol.protocol_parent_id:
2529                        if child_player := self.get_player(child_protocol.protocol_parent_id):
2530                            if child_player.active_output_protocol != child_protocol_id:
2531                                self.logger.debug(
2532                                    "Setting active output protocol on child %s to %s",
2533                                    child_player.state.name,
2534                                    child_protocol_id,
2535                                )
2536                                child_player.set_active_output_protocol(child_protocol_id)
2537
2538        # If we added members via this protocol, set it as the active output protocol
2539        # and restart playback if currently playing AND we're switching protocols
2540        if filtered_protocol_add:
2541            previous_protocol = parent_player.active_output_protocol
2542            was_playing = parent_player.state.playback_state == PlaybackState.PLAYING
2543            # A paused player still holds its output, so the handover has to run for it
2544            # too - only the resume at the end is reserved for a player that was playing,
2545            # so adding a member does not start playback on its own.
2546            was_rendering = was_playing or parent_player.state.playback_state == (
2547                PlaybackState.PAUSED
2548            )
2549
2550            # Determine if we're switching protocols (which requires restart)
2551            # Native protocol: parent_protocol_player is the same as parent_player
2552            is_native_protocol = parent_protocol_player.player_id == parent_player.player_id
2553            already_using_native = previous_protocol in (None, "native")
2554            already_using_this_protocol = previous_protocol == parent_protocol_player.player_id
2555
2556            # Only restart if we're actually switching to a different protocol
2557            switching_protocols = not (
2558                (is_native_protocol and already_using_native) or already_using_this_protocol
2559            )
2560
2561            self.logger.debug(
2562                "Protocol grouping: is_native=%s, already_native=%s, already_this=%s, "
2563                "switching=%s, was_rendering=%s",
2564                is_native_protocol,
2565                already_using_native,
2566                already_using_this_protocol,
2567                switching_protocols,
2568                was_rendering,
2569            )
2570
2571            # Update active output protocol if not already using native
2572            if not (is_native_protocol and already_using_native):
2573                parent_player.set_active_output_protocol(parent_protocol_player.player_id)
2574
2575            # Hand the output over only if we're switching protocols
2576            if was_rendering and switching_protocols:
2577                self.logger.info(
2578                    "Handing the output of %s over to the %s protocol%s",
2579                    parent_player.state.name,
2580                    parent_protocol_player.provider.domain,
2581                    " and resuming playback" if was_playing else "",
2582                )
2583                if stranded_native_members:
2584                    await self._stop_native_session(
2585                        parent_player, parent_protocol_player, stranded_native_members
2586                    )
2587                # Collect existing members from old protocol before stopping it,
2588                # so we can re-add them to the new protocol afterwards.
2589                old_protocol_members: list[str] = []
2590                if (
2591                    previous_protocol
2592                    and previous_protocol not in (None, "native")
2593                    and (old_protocol_player := self.get_player(previous_protocol))
2594                    and old_protocol_player.player_id != parent_protocol_player.player_id
2595                ):
2596                    # Collect child members (exclude the leader itself)
2597                    old_protocol_members = [
2598                        m
2599                        for m in old_protocol_player.group_members
2600                        if m != old_protocol_player.player_id
2601                    ]
2602                    # Translate protocol IDs back to parent player IDs
2603                    old_parent_members: list[str] = []
2604                    for member_id in old_protocol_members:
2605                        if member_player := self.get_player(member_id):
2606                            parent_id = member_player.protocol_parent_id or member_id
2607                            if parent_id != parent_player.player_id:
2608                                old_parent_members.append(parent_id)
2609                    self.logger.debug(
2610                        "Stopping old protocol player %s before switching to %s, "
2611                        "migrating members: %s",
2612                        old_protocol_player.state.name,
2613                        parent_protocol_player.state.name,
2614                        old_parent_members,
2615                    )
2616                    # Use internal handler to stop the specific protocol player,
2617                    # bypassing group/sync redirect and queue redirect logic.
2618                    await self.mass.players._handle_cmd_stop(old_protocol_player.player_id)
2619                else:
2620                    old_parent_members = []
2621                # Resume playback on the new protocol and re-add migrated members.
2622                if was_playing:
2623                    await self.mass.players.cmd_resume(parent_player.player_id)
2624                if old_parent_members:
2625                    self.logger.debug(
2626                        "Re-adding migrated members %s to %s on new protocol",
2627                        old_parent_members,
2628                        parent_player.state.name,
2629                    )
2630                    # Use internal handler because we are already inside a
2631                    # _handle_set_members call chain that holds the play lock.
2632                    await self.mass.players._handle_set_members(
2633                        parent_player,
2634                        player_ids_to_add=old_parent_members,
2635                    )
2636
2637        self.logger.debug(
2638            "After set_members, protocol player %s state: group_members=%s, synced_to=%s",
2639            parent_protocol_player.state.name,
2640            parent_protocol_player.group_members,
2641            parent_protocol_player.synced_to,
2642        )
2643