media_player.py

Go to the documentation of this file.

"""Support forked_daapd media player."""
 
from __future__ import annotations
 
import asyncio
from collections import defaultdict
import logging
from typing import Any
 
from pyforked_daapd import ForkedDaapdAPI
from pylibrespot_java import LibrespotJavaAPI
 
from homeassistant.components import media_source
from homeassistant.components.media_player import (
    ATTR_MEDIA_ANNOUNCE,
    ATTR_MEDIA_ENQUEUE,
    BrowseMedia,
    MediaPlayerEnqueue,
    MediaPlayerEntity,
    MediaPlayerEntityFeature,
    MediaPlayerState,
    MediaType,
    async_process_play_media_url,
)
from homeassistant.components.spotify import (
    async_browse_media as spotify_async_browse_media,
    is_spotify_media_type,
    resolve_spotify_media_type,
    spotify_uri_from_media_browser_url,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import PlatformNotReady
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.dispatcher import (
    async_dispatcher_connect,
    async_dispatcher_send,
)
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util.dt import utcnow
 
from .browse_media import (
    convert_to_owntone_uri,
    get_owntone_content,
    is_owntone_media_content_id,
    library,
)
from .const import (
    CALLBACK_TIMEOUT,
    CAN_PLAY_TYPE,
    CONF_LIBRESPOT_JAVA_PORT,
    CONF_MAX_PLAYLISTS,
    CONF_TTS_PAUSE_TIME,
    CONF_TTS_VOLUME,
    DEFAULT_TTS_PAUSE_TIME,
    DEFAULT_TTS_VOLUME,
    DEFAULT_UNMUTE_VOLUME,
    DOMAIN,
    FD_NAME,
    HASS_DATA_REMOVE_LISTENERS_KEY,
    HASS_DATA_UPDATER_KEY,
    KNOWN_PIPES,
    PIPE_FUNCTION_MAP,
    SIGNAL_ADD_ZONES,
    SIGNAL_CONFIG_OPTIONS_UPDATE,
    SIGNAL_UPDATE_DATABASE,
    SIGNAL_UPDATE_MASTER,
    SIGNAL_UPDATE_OUTPUTS,
    SIGNAL_UPDATE_PLAYER,
    SIGNAL_UPDATE_QUEUE,
    SOURCE_NAME_CLEAR,
    SOURCE_NAME_DEFAULT,
    STARTUP_DATA,
    SUPPORTED_FEATURES,
    SUPPORTED_FEATURES_ZONE,
    TTS_TIMEOUT,
)
 
_LOGGER = logging.getLogger(__name__)
 
WS_NOTIFY_EVENT_TYPES = ["player", "outputs", "volume", "options", "queue", "database"]
WEBSOCKET_RECONNECT_TIME = 30  # seconds
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up forked-daapd from a config entry."""
    host = config_entry.data[CONF_HOST]
    port = config_entry.data[CONF_PORT]
    password = config_entry.data[CONF_PASSWORD]
    forked_daapd_api = ForkedDaapdAPI(
        async_get_clientsession(hass), host, port, password
    )
    forked_daapd_master = ForkedDaapdMaster(
        clientsession=async_get_clientsession(hass),
        api=forked_daapd_api,
        ip_address=host,
        api_port=port,
        api_password=password,
        config_entry=config_entry,
    )
 
    @callback
    def async_add_zones(api, outputs):
        async_add_entities(
            ForkedDaapdZone(api, output, config_entry.entry_id) for output in outputs
        )
 
    remove_add_zones_listener = async_dispatcher_connect(
        hass, SIGNAL_ADD_ZONES.format(config_entry.entry_id), async_add_zones
    )
    remove_entry_listener = config_entry.add_update_listener(update_listener)
 
    if not hass.data.get(DOMAIN):
        hass.data[DOMAIN] = {config_entry.entry_id: {}}
    hass.data[DOMAIN][config_entry.entry_id] = {
        HASS_DATA_REMOVE_LISTENERS_KEY: [
            remove_add_zones_listener,
            remove_entry_listener,
        ]
    }
    async_add_entities([forked_daapd_master], False)
    forked_daapd_updater = ForkedDaapdUpdater(
        hass, forked_daapd_api, config_entry.entry_id
    )
    hass.data[DOMAIN][config_entry.entry_id][HASS_DATA_UPDATER_KEY] = (
        forked_daapd_updater
    )
    await forked_daapd_updater.async_init()
 
 
async def update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
    """Handle options update."""
    async_dispatcher_send(
        hass, SIGNAL_CONFIG_OPTIONS_UPDATE.format(entry.entry_id), entry.options
    )
 
 
class ForkedDaapdZone(MediaPlayerEntity):
    """Representation of a forked-daapd output."""
 
    _attr_should_poll = False
 
    def __init__(self, api, output, entry_id):
        """Initialize the ForkedDaapd Zone."""
        self._api_api = api
        self._output_output = output
        self._output_id_output_id = output["id"]
        self._last_volume_last_volume = DEFAULT_UNMUTE_VOLUME  # used for mute/unmute
        self._available_available = True
        self._entry_id_entry_id = entry_id
 
    async def async_added_to_hass(self) -> None:
        """Use lifecycle hooks."""
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_UPDATE_OUTPUTS.format(self._entry_id_entry_id),
                self._async_update_output_callback_async_update_output_callback,
            )
        )
 
    @callback
    def _async_update_output_callback(self, outputs, _event=None):
        new_output = next(
            (output for output in outputs if output["id"] == self._output_id_output_id), None
        )
        self._available_available = bool(new_output)
        if self._available_available:
            self._output_output = new_output
        self.async_write_ha_stateasync_write_ha_state()
 
    @property
    def unique_id(self):
        """Return unique ID."""
        return f"{self._entry_id}-{self._output_id}"
 
    async def async_toggle(self) -> None:
        """Toggle the power on the zone."""
        if self.statestatestatestatestatestate == MediaPlayerState.OFF:
            await self.async_turn_onasync_turn_onasync_turn_on()
        else:
            await self.async_turn_offasync_turn_offasync_turn_off()
 
    @property
    def available(self) -> bool:
        """Return whether the zone is available."""
        return self._available_available
 
    async def async_turn_on(self) -> None:
        """Enable the output."""
        await self._api_api.change_output(self._output_id_output_id, selected=True)
 
    async def async_turn_off(self) -> None:
        """Disable the output."""
        await self._api_api.change_output(self._output_id_output_id, selected=False)
 
    @property
    def name(self) -> str:
        """Return the name of the zone."""
        return f"{FD_NAME} output ({self._output['name']})"
 
    @property
    def state(self) -> MediaPlayerState:
        """State of the zone."""
        if self._output_output["selected"]:
            return MediaPlayerState.ON
        return MediaPlayerState.OFF
 
    @property
    def volume_level(self):
        """Volume level of the media player (0..1)."""
        return self._output_output["volume"] / 100
 
    @property
    def is_volume_muted(self) -> bool:
        """Boolean if volume is currently muted."""
        return self._output_output["volume"] == 0
 
    async def async_mute_volume(self, mute: bool) -> None:
        """Mute the volume."""
        if mute:
            if self.volume_levelvolume_levelvolume_levelvolume_level == 0:
                return
            self._last_volume_last_volume = self.volume_levelvolume_levelvolume_levelvolume_level  # store volume level to restore later
            target_volume = 0
        else:
            target_volume = self._last_volume_last_volume  # restore volume level
        await self.async_set_volume_levelasync_set_volume_levelasync_set_volume_level(volume=target_volume)
 
    async def async_set_volume_level(self, volume: float) -> None:
        """Set volume - input range [0,1]."""
        await self._api_api.set_volume(volume=volume * 100, output_id=self._output_id_output_id)
 
    @property
    def supported_features(self) -> MediaPlayerEntityFeature:
        """Flag media player features that are supported."""
        return SUPPORTED_FEATURES_ZONE
 
 
class ForkedDaapdMaster(MediaPlayerEntity):
    """Representation of the main forked-daapd device."""
 
    _attr_should_poll = False
 
    def __init__(
        self, clientsession, api, ip_address, api_port, api_password, config_entry
    ):
        """Initialize the ForkedDaapd Master Device."""
        # Leave the api public so the browse media helpers can use it
        self.apiapi = api
        self._player_player = STARTUP_DATA[
            "player"
        ]  # _player, _outputs, and _queue are loaded straight from api
        self._outputs_outputs = STARTUP_DATA["outputs"]
        self._queue_queue = STARTUP_DATA["queue"]
        self._track_info_track_info = defaultdict(
            str
        )  # _track info is found by matching _player data with _queue data
        self._last_outputs_last_outputs = []  # used for device on/off
        self._last_volume_last_volume = DEFAULT_UNMUTE_VOLUME
        self._player_last_updated_player_last_updated = None
        self._pipe_control_api_pipe_control_api = {}
        self._ip_address_ip_address = (
            ip_address  # need to save this because pipe control is on same ip
        )
        self._tts_pause_time_tts_pause_time = DEFAULT_TTS_PAUSE_TIME
        self._tts_volume_tts_volume = DEFAULT_TTS_VOLUME
        self._tts_requested_tts_requested = False
        self._tts_queued_tts_queued = False
        self._tts_playing_event_tts_playing_event = asyncio.Event()
        self._on_remove_on_remove_on_remove = None
        self._available_available = False
        self._clientsession_clientsession = clientsession
        self._config_entry_config_entry = config_entry
        self.update_optionsupdate_options(config_entry.options)
        self._paused_event_paused_event = asyncio.Event()
        self._pause_requested_pause_requested = False
        self._sources_uris_sources_uris = {}
        self._source_source = SOURCE_NAME_DEFAULT
        self._max_playlists_max_playlists = None
 
    async def async_added_to_hass(self) -> None:
        """Use lifecycle hooks."""
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_UPDATE_PLAYER.format(self._config_entry_config_entry.entry_id),
                self._update_player_update_player,
            )
        )
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_UPDATE_QUEUE.format(self._config_entry_config_entry.entry_id),
                self._update_queue_update_queue,
            )
        )
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_UPDATE_OUTPUTS.format(self._config_entry_config_entry.entry_id),
                self._update_outputs_update_outputs,
            )
        )
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_UPDATE_MASTER.format(self._config_entry_config_entry.entry_id),
                self._update_callback_update_callback,
            )
        )
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_CONFIG_OPTIONS_UPDATE.format(self._config_entry_config_entry.entry_id),
                self.update_optionsupdate_options,
            )
        )
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                SIGNAL_UPDATE_DATABASE.format(self._config_entry_config_entry.entry_id),
                self._update_database_update_database,
            )
        )
 
    @callback
    def _update_callback(self, available):
        """Call update method."""
        self._available_available = available
        self.async_write_ha_stateasync_write_ha_state()
 
    @callback
    def update_options(self, options):
        """Update forked-daapd server options."""
        if CONF_LIBRESPOT_JAVA_PORT in options:
            self._pipe_control_api_pipe_control_api["librespot-java"] = LibrespotJavaAPI(
                self._clientsession_clientsession, self._ip_address_ip_address, options[CONF_LIBRESPOT_JAVA_PORT]
            )
        if CONF_TTS_PAUSE_TIME in options:
            self._tts_pause_time_tts_pause_time = options[CONF_TTS_PAUSE_TIME]
        if CONF_TTS_VOLUME in options:
            self._tts_volume_tts_volume = options[CONF_TTS_VOLUME]
        if CONF_MAX_PLAYLISTS in options:
            # sources not updated until next _update_database call
            self._max_playlists_max_playlists = options[CONF_MAX_PLAYLISTS]
 
    @callback
    def _update_player(self, player, event):
        self._player_player = player
        self._player_last_updated_player_last_updated = utcnow()
        self._update_track_info_update_track_info()
        if self._tts_queued_tts_queued:
            self._tts_playing_event_tts_playing_event.set()
            self._tts_queued_tts_queued = False
        if self._pause_requested_pause_requested:
            self._paused_event_paused_event.set()
            self._pause_requested_pause_requested = False
        event.set()
 
    @callback
    def _update_queue(self, queue, event):
        self._queue_queue = queue
        if self._tts_requested_tts_requested:
            # Assume the change was due to the request
            self._tts_requested_tts_requested = False
            self._tts_queued_tts_queued = True
 
        if (
            self._queue_queue["count"] >= 1
            and self._queue_queue["items"][0]["data_kind"] == "pipe"
            and self._queue_queue["items"][0]["title"] in KNOWN_PIPES
        ):  # if we're playing a pipe, set the source automatically so we can forward controls
            self._source_source = f"{self._queue['items'][0]['title']} (pipe)"
        self._update_track_info_update_track_info()
        event.set()
 
    @callback
    def _update_outputs(self, outputs, event=None):
        if event:  # Calling without event is meant for zone, so ignore
            self._outputs_outputs = outputs
            event.set()
 
    @callback
    def _update_database(self, pipes, playlists, event):
        self._sources_uris_sources_uris = {SOURCE_NAME_CLEAR: None, SOURCE_NAME_DEFAULT: None}
        if pipes:
            self._sources_uris_sources_uris.update(
                {
                    f"{pipe['title']} (pipe)": pipe["uri"]
                    for pipe in pipes
                    if pipe["title"] in KNOWN_PIPES
                }
            )
        if playlists:
            self._sources_uris_sources_uris.update(
                {
                    f"{playlist['name']} (playlist)": playlist["uri"]
                    for playlist in playlists[: self._max_playlists_max_playlists]
                }
            )
        event.set()
 
    def _update_track_info(self):  # run during every player or queue update
        try:
            self._track_info_track_info = next(
                track
                for track in self._queue_queue["items"]
                if track["id"] == self._player_player["item_id"]
            )
        except (StopIteration, TypeError, KeyError):
            _LOGGER.debug("Could not get track info")
            self._track_info_track_info = defaultdict(str)
 
    @property
    def unique_id(self):
        """Return unique ID."""
        return self._config_entry_config_entry.entry_id
 
    @property
    def available(self) -> bool:
        """Return whether the master is available."""
        return self._available_available
 
    async def async_turn_on(self) -> None:
        """Restore the last on outputs state."""
        # restore state
        await self.apiapi.set_volume(volume=self._last_volume_last_volume * 100)
        if self._last_outputs_last_outputs:
            futures: list[asyncio.Task[int]] = [
                asyncio.create_task(
                    self.apiapi.change_output(
                        output["id"],
                        selected=output["selected"],
                        volume=output["volume"],
                    )
                )
                for output in self._last_outputs_last_outputs
            ]
            await asyncio.wait(futures)
        else:  # enable all outputs
            await self.apiapi.set_enabled_outputs(
                [output["id"] for output in self._outputs_outputs]
            )
 
    async def async_turn_off(self) -> None:
        """Pause player and store outputs state."""
        await self.async_media_pauseasync_media_pauseasync_media_pause()
        self._last_outputs_last_outputs = self._outputs_outputs
        if any(output["selected"] for output in self._outputs_outputs):
            await self.apiapi.set_enabled_outputs([])
 
    async def async_toggle(self) -> None:
        """Toggle the power on the device.
 
        Default media player component method counts idle as off.
        We consider idle to be on but just not playing.
        """
        if self.statestatestatestatestatestate == MediaPlayerState.OFF:
            await self.async_turn_onasync_turn_onasync_turn_on()
        else:
            await self.async_turn_offasync_turn_offasync_turn_off()
 
    @property
    def name(self) -> str:
        """Return the name of the device."""
        return f"{FD_NAME} server"
 
    @property
    def state(self) -> MediaPlayerState | None:
        """State of the player."""
        if self._player_player["state"] == "play":
            return MediaPlayerState.PLAYING
        if self._player_player["state"] == "pause":
            return MediaPlayerState.PAUSED
        if not any(output["selected"] for output in self._outputs_outputs):
            return MediaPlayerState.OFF
        if self._player_player["state"] == "stop":  # this should catch all remaining cases
            return MediaPlayerState.IDLE
        return None
 
    @property
    def volume_level(self):
        """Volume level of the media player (0..1)."""
        return self._player_player["volume"] / 100
 
    @property
    def is_volume_muted(self):
        """Boolean if volume is currently muted."""
        return self._player_player["volume"] == 0
 
    @property
    def media_content_id(self):
        """Content ID of current playing media."""
        return self._player_player["item_id"]
 
    @property
    def media_content_type(self):
        """Content type of current playing media."""
        return self._track_info_track_info["media_kind"]
 
    @property
    def media_duration(self):
        """Duration of current playing media in seconds."""
        return self._player_player["item_length_ms"] / 1000
 
    @property
    def media_position(self):
        """Position of current playing media in seconds."""
        return self._player_player["item_progress_ms"] / 1000
 
    @property
    def media_position_updated_at(self):
        """When was the position of the current playing media valid."""
        return self._player_last_updated_player_last_updated
 
    @property
    def media_title(self):
        """Title of current playing media."""
        # Use album field when data_kind is url
        # https://github.com/ejurgensen/forked-daapd/issues/351
        if self._track_info_track_info["data_kind"] == "url":
            return self._track_info_track_info["album"]
        return self._track_info_track_info["title"]
 
    @property
    def media_artist(self):
        """Artist of current playing media, music track only."""
        return self._track_info_track_info["artist"]
 
    @property
    def media_album_name(self):
        """Album name of current playing media, music track only."""
        # Use title field when data_kind is url
        # https://github.com/ejurgensen/forked-daapd/issues/351
        if self._track_info_track_info["data_kind"] == "url":
            return self._track_info_track_info["title"]
        return self._track_info_track_info["album"]
 
    @property
    def media_album_artist(self):
        """Album artist of current playing media, music track only."""
        return self._track_info_track_info["album_artist"]
 
    @property
    def media_track(self):
        """Track number of current playing media, music track only."""
        return self._track_info_track_info["track_number"]
 
    @property
    def shuffle(self):
        """Boolean if shuffle is enabled."""
        return self._player_player["shuffle"]
 
    @property
    def supported_features(self) -> MediaPlayerEntityFeature:
        """Flag media player features that are supported."""
        return SUPPORTED_FEATURES
 
    @property
    def source(self):
        """Name of the current input source."""
        return self._source_source
 
    @property
    def source_list(self):
        """List of available input sources."""
        return [*self._sources_uris_sources_uris]
 
    async def async_mute_volume(self, mute: bool) -> None:
        """Mute the volume."""
        if mute:
            if self.volume_levelvolume_levelvolume_levelvolume_level == 0:
                return
            self._last_volume_last_volume = self.volume_levelvolume_levelvolume_levelvolume_level  # store volume level to restore later
            target_volume = 0
        else:
            target_volume = self._last_volume_last_volume  # restore volume level
        await self.apiapi.set_volume(volume=target_volume * 100)
 
    async def async_set_volume_level(self, volume: float) -> None:
        """Set volume - input range [0,1]."""
        await self.apiapi.set_volume(volume=volume * 100)
 
    async def async_media_play(self) -> None:
        """Start playback."""
        if self._use_pipe_control_use_pipe_control():
            await self._pipe_call_pipe_call(self._use_pipe_control_use_pipe_control(), "async_media_play")
        else:
            await self.apiapi.start_playback()
 
    async def async_media_pause(self) -> None:
        """Pause playback."""
        if self._use_pipe_control_use_pipe_control():
            await self._pipe_call_pipe_call(self._use_pipe_control_use_pipe_control(), "async_media_pause")
        else:
            await self.apiapi.pause_playback()
 
    async def async_media_stop(self) -> None:
        """Stop playback."""
        if self._use_pipe_control_use_pipe_control():
            await self._pipe_call_pipe_call(self._use_pipe_control_use_pipe_control(), "async_media_stop")
        else:
            await self.apiapi.stop_playback()
 
    async def async_media_previous_track(self) -> None:
        """Skip to previous track."""
        if self._use_pipe_control_use_pipe_control():
            await self._pipe_call_pipe_call(
                self._use_pipe_control_use_pipe_control(), "async_media_previous_track"
            )
        else:
            await self.apiapi.previous_track()
 
    async def async_media_next_track(self) -> None:
        """Skip to next track."""
        if self._use_pipe_control_use_pipe_control():
            await self._pipe_call_pipe_call(self._use_pipe_control_use_pipe_control(), "async_media_next_track")
        else:
            await self.apiapi.next_track()
 
    async def async_media_seek(self, position: float) -> None:
        """Seek to position."""
        await self.apiapi.seek(position_ms=position * 1000)
 
    async def async_clear_playlist(self) -> None:
        """Clear playlist."""
        await self.apiapi.clear_queue()
 
    async def async_set_shuffle(self, shuffle: bool) -> None:
        """Enable/disable shuffle mode."""
        await self.apiapi.shuffle(shuffle)
 
    @property
    def media_image_url(self):
        """Image url of current playing media."""
        if url := self._track_info_track_info.get("artwork_url"):
            url = self.apiapi.full_url(url)
        return url
 
    async def _save_and_set_tts_volumes(self):
        if self.volume_levelvolume_levelvolume_levelvolume_level:  # save master volume
            self._last_volume_last_volume = self.volume_levelvolume_levelvolume_levelvolume_level
        self._last_outputs_last_outputs = self._outputs_outputs
        if self._outputs_outputs:
            await self.apiapi.set_volume(volume=self._tts_volume_tts_volume * 100)
            futures = [
                asyncio.create_task(
                    self.apiapi.change_output(
                        output["id"], selected=True, volume=self._tts_volume_tts_volume * 100
                    )
                )
                for output in self._outputs_outputs
            ]
            await asyncio.wait(futures)
 
    async def _pause_and_wait_for_callback(self):
        """Send pause and wait for the pause callback to be received."""
        self._pause_requested_pause_requested = True
        await self.async_media_pauseasync_media_pauseasync_media_pause()
        try:
            async with asyncio.timeout(CALLBACK_TIMEOUT):
                await self._paused_event_paused_event.wait()  # wait for paused
        except TimeoutError:
            self._pause_requested_pause_requested = False
        self._paused_event_paused_event.clear()
 
    async def async_play_media(
        self, media_type: MediaType | str, media_id: str, **kwargs: Any
    ) -> None:
        """Play a URI."""
 
        # Preprocess media_ids
        if media_source.is_media_source_id(media_id):
            media_type = MediaType.MUSIC
            play_item = await media_source.async_resolve_media(
                self.hasshass, media_id, self.entity_identity_id
            )
            media_id = play_item.url
        elif is_owntone_media_content_id(media_id):
            media_id = convert_to_owntone_uri(media_id)
        elif is_spotify_media_type(media_type):
            media_type = resolve_spotify_media_type(media_type)
            media_id = spotify_uri_from_media_browser_url(media_id)
 
        if media_type not in CAN_PLAY_TYPE:
            _LOGGER.warning("Media type '%s' not supported", media_type)
            return
 
        if media_type == MediaType.MUSIC:
            media_id = async_process_play_media_url(self.hasshass, media_id)
        elif media_type not in CAN_PLAY_TYPE:
            _LOGGER.warning("Media type '%s' not supported", media_type)
            return
 
        if kwargs.get(ATTR_MEDIA_ANNOUNCE):
            await self._async_announce_async_announce(media_id)
            return
 
        # if kwargs[ATTR_MEDIA_ENQUEUE] is None, we assume MediaPlayerEnqueue.REPLACE
        # if kwargs[ATTR_MEDIA_ENQUEUE] is True, we assume MediaPlayerEnqueue.ADD
        # kwargs[ATTR_MEDIA_ENQUEUE] is assumed to never be False
        # See https://github.com/home-assistant/architecture/issues/765
        enqueue: bool | MediaPlayerEnqueue = kwargs.get(
            ATTR_MEDIA_ENQUEUE, MediaPlayerEnqueue.REPLACE
        )
        if enqueue in {True, MediaPlayerEnqueue.ADD, MediaPlayerEnqueue.REPLACE}:
            await self.apiapi.add_to_queue(
                uris=media_id,
                playback="start",
                clear=enqueue == MediaPlayerEnqueue.REPLACE,
            )
            return
 
        current_position = next(
            (
                item["position"]
                for item in self._queue_queue["items"]
                if item["id"] == self._player_player["item_id"]
            ),
            0,
        )
        if enqueue == MediaPlayerEnqueue.NEXT:
            await self.apiapi.add_to_queue(
                uris=media_id,
                playback="start",
                position=current_position + 1,
            )
            return
        # enqueue == MediaPlayerEnqueue.PLAY
        await self.apiapi.add_to_queue(
            uris=media_id,
            playback="start",
            position=current_position,
            playback_from_position=current_position,
        )
 
    async def _async_announce(self, media_id: str) -> None:
        """Play a URI."""
        saved_state = self.statestatestatestatestatestate  # save play state
        saved_mute = self.is_volume_mutedis_volume_mutedis_volume_muted
        sleep_future = asyncio.create_task(
            asyncio.sleep(self._tts_pause_time_tts_pause_time)
        )  # start timing now, but not exact because of fd buffer + tts latency
        await self._pause_and_wait_for_callback_pause_and_wait_for_callback()
        await self._save_and_set_tts_volumes_save_and_set_tts_volumes()
        # save position
        saved_song_position = self._player_player["item_progress_ms"]
        saved_queue = self._queue_queue if self._queue_queue["count"] > 0 else None  # stash queue
        if saved_queue:
            saved_queue_position = next(
                i
                for i, item in enumerate(saved_queue["items"])
                if item["id"] == self._player_player["item_id"]
            )
        self._tts_requested_tts_requested = True
        await sleep_future
        await self.apiapi.add_to_queue(uris=media_id, playback="start", clear=True)
        try:
            async with asyncio.timeout(TTS_TIMEOUT):
                await self._tts_playing_event_tts_playing_event.wait()
            # we have started TTS, now wait for completion
        except TimeoutError:
            self._tts_requested_tts_requested = False
            _LOGGER.warning("TTS request timed out")
        await asyncio.sleep(
            self._queue_queue["items"][0]["length_ms"]
            / 1000  # player may not have updated yet so grab length from queue
            + self._tts_pause_time_tts_pause_time
        )
        self._tts_playing_event_tts_playing_event.clear()
        # TTS done, return to normal
        await self.async_turn_onasync_turn_onasync_turn_on()  # restore outputs and volumes
        if saved_mute:  # mute if we were muted
            await self.async_mute_volumeasync_mute_volumeasync_mute_volume(True)
        if self._use_pipe_control_use_pipe_control():  # resume pipe
            await self.apiapi.add_to_queue(
                uris=self._sources_uris_sources_uris[self._source_source], clear=True
            )
            if saved_state == MediaPlayerState.PLAYING:
                await self.async_media_playasync_media_playasync_media_play()
            return
        if not saved_queue:
            return
        # Restore stashed queue
        await self.apiapi.add_to_queue(
            uris=",".join(item["uri"] for item in saved_queue["items"]),
            playback="start",
            playback_from_position=saved_queue_position,
            clear=True,
        )
        await self.apiapi.seek(position_ms=saved_song_position)
        if saved_state == MediaPlayerState.PAUSED:
            await self.async_media_pauseasync_media_pauseasync_media_pause()
            return
        if saved_state != MediaPlayerState.PLAYING:
            await self.async_media_stopasync_media_stopasync_media_stop()
 
    async def async_select_source(self, source: str) -> None:
        """Change source.
 
        Source name reflects whether in default mode or pipe mode.
        Selecting playlists/clear sets the playlists/clears but ends up in default mode.
        """
        if source == self._source_source:
            return
 
        if self._use_pipe_control_use_pipe_control():  # if pipe was playing, we need to stop it first
            await self._pause_and_wait_for_callback_pause_and_wait_for_callback()
        self._source_source = source
        if not self._use_pipe_control_use_pipe_control():  # playlist or clear ends up at default
            self._source_source = SOURCE_NAME_DEFAULT
        if self._sources_uris_sources_uris.get(source):  # load uris for pipes or playlists
            await self.apiapi.add_to_queue(uris=self._sources_uris_sources_uris[source], clear=True)
        elif source == SOURCE_NAME_CLEAR:  # clear playlist
            await self.apiapi.clear_queue()
        self.async_write_ha_stateasync_write_ha_state()
 
    def _use_pipe_control(self):
        """Return which pipe control from KNOWN_PIPES to use."""
        if self._source_source[-7:] == " (pipe)":
            return self._source_source[:-7]
        return ""
 
    async def _pipe_call(self, pipe_name, base_function_name) -> None:
        if pipe := self._pipe_control_api_pipe_control_api.get(pipe_name):
            await getattr(
                pipe,
                PIPE_FUNCTION_MAP[pipe_name][base_function_name],
            )()
            return
        _LOGGER.warning("No pipe control available for %s", pipe_name)
 
    async def async_browse_media(
        self,
        media_content_type: MediaType | str | None = None,
        media_content_id: str | None = None,
    ) -> BrowseMedia:
        """Implement the websocket media browsing helper."""
        if media_content_id is None or media_source.is_media_source_id(
            media_content_id
        ):
            ms_result = await media_source.async_browse_media(
                self.hasshass,
                media_content_id,
                content_filter=lambda bm: bm.media_content_type in CAN_PLAY_TYPE,
            )
            if media_content_type is not None:
                return ms_result
            other_sources: list[BrowseMedia] = (
                list(ms_result.children) if ms_result.children else []
            )
        if "spotify" in self.hasshass.config.components and (
            media_content_type is None or is_spotify_media_type(media_content_type)
        ):
            spotify_result = await spotify_async_browse_media(
                self.hasshass, media_content_type, media_content_id
            )
            if media_content_type is not None:
                return spotify_result
            if spotify_result.children:
                other_sources += spotify_result.children
 
        if media_content_id is None or media_content_type is None:
            # This is the base level, so we combine our library with the other sources
            return library(other_sources)
 
        # media_content_type should only be None if media_content_id is None
        return await get_owntone_content(self, media_content_id)
 
    async def async_get_browse_image(
        self,
        media_content_type: MediaType | str,
        media_content_id: str,
        media_image_id: str | None = None,
    ) -> tuple[bytes | None, str | None]:
        """Fetch image for media browser."""
 
        if media_content_type not in {
            MediaType.TRACK,
            MediaType.ALBUM,
            MediaType.ARTIST,
        }:
            return None, None
        owntone_uri = convert_to_owntone_uri(media_content_id)
        item_id_str = owntone_uri.rsplit(":", maxsplit=1)[-1]
        if media_content_type == MediaType.TRACK:
            result = await self.apiapi.get_track(int(item_id_str))
        elif media_content_type == MediaType.ALBUM:
            if result := await self.apiapi.get_albums():
                result = next(
                    (item for item in result if item["id"] == item_id_str), None
                )
        elif result := await self.apiapi.get_artists():
            result = next((item for item in result if item["id"] == item_id_str), None)
        if url := result.get("artwork_url"):
            return await self._async_fetch_image_async_fetch_image(self.apiapi.full_url(url))
        return None, None
 
 
class ForkedDaapdUpdater:
    """Manage updates for the forked-daapd device."""
 
    def __init__(self, hass, api, entry_id):
        """Initialize."""
        self.hasshass = hass
        self._api_api = api
        self.websocket_handlerwebsocket_handler = None
        self._all_output_ids_all_output_ids = set()
        self._entry_id_entry_id = entry_id
 
    async def async_init(self):
        """Perform async portion of class initialization."""
        if not (server_config := await self._api_api.get_request("config")):
            raise PlatformNotReady
        if websocket_port := server_config.get("websocket_port"):
            self.websocket_handlerwebsocket_handler = asyncio.create_task(
                self._api_api.start_websocket_handler(
                    websocket_port,
                    WS_NOTIFY_EVENT_TYPES,
                    self._update_update,
                    WEBSOCKET_RECONNECT_TIME,
                    self._disconnected_callback_disconnected_callback,
                )
            )
        else:
            _LOGGER.error("Invalid websocket port")
 
    async def _disconnected_callback(self):
        """Send update signals when the websocket gets disconnected."""
        async_dispatcher_send(
            self.hasshass, SIGNAL_UPDATE_MASTER.format(self._entry_id_entry_id), False
        )
        async_dispatcher_send(
            self.hasshass, SIGNAL_UPDATE_OUTPUTS.format(self._entry_id_entry_id), []
        )
 
    async def _update(self, update_types):
        """Private update method."""
        update_types = set(update_types)
        update_events = {}
        _LOGGER.debug("Updating %s", update_types)
        if (
            "queue" in update_types
        ):  # update queue, queue before player for async_play_media
            if queue := await self._api_api.get_request("queue"):
                update_events["queue"] = asyncio.Event()
                async_dispatcher_send(
                    self.hasshass,
                    SIGNAL_UPDATE_QUEUE.format(self._entry_id_entry_id),
                    queue,
                    update_events["queue"],
                )
        # order of below don't matter
        if not {"outputs", "volume"}.isdisjoint(update_types):  # update outputs
            if outputs := await self._api_api.get_request("outputs"):
                outputs = outputs["outputs"]
                update_events["outputs"] = (
                    asyncio.Event()
                )  # only for master, zones should ignore
                async_dispatcher_send(
                    self.hasshass,
                    SIGNAL_UPDATE_OUTPUTS.format(self._entry_id_entry_id),
                    outputs,
                    update_events["outputs"],
                )
                self._add_zones_add_zones(outputs)
        if not {"database"}.isdisjoint(update_types):
            pipes, playlists = await asyncio.gather(
                self._api_api.get_pipes(), self._api_api.get_playlists()
            )
            update_events["database"] = asyncio.Event()
            async_dispatcher_send(
                self.hasshass,
                SIGNAL_UPDATE_DATABASE.format(self._entry_id_entry_id),
                pipes,
                playlists,
                update_events["database"],
            )
        if not {"update", "config"}.isdisjoint(update_types):  # not supported
            _LOGGER.debug("update/config notifications neither requested nor supported")
        if not {"player", "options", "volume"}.isdisjoint(
            update_types
        ):  # update player
            if player := await self._api_api.get_request("player"):
                update_events["player"] = asyncio.Event()
                if update_events.get("queue"):
                    await update_events[
                        "queue"
                    ].wait()  # make sure queue done before player for async_play_media
                async_dispatcher_send(
                    self.hasshass,
                    SIGNAL_UPDATE_PLAYER.format(self._entry_id_entry_id),
                    player,
                    update_events["player"],
                )
        if update_events:
            await asyncio.wait(
                [asyncio.create_task(event.wait()) for event in update_events.values()]
            )  # make sure callbacks done before update
            async_dispatcher_send(
                self.hasshass, SIGNAL_UPDATE_MASTER.format(self._entry_id_entry_id), True
            )
 
    def _add_zones(self, outputs):
        outputs_to_add = []
        for output in outputs:
            if output["id"] not in self._all_output_ids_all_output_ids:
                self._all_output_ids_all_output_ids.add(output["id"])
                outputs_to_add.append(output)
        if outputs_to_add:
            async_dispatcher_send(
                self.hasshass,
                SIGNAL_ADD_ZONES.format(self._entry_id_entry_id),
                self._api_api,
                outputs_to_add,
            )