-
-
Notifications
You must be signed in to change notification settings - Fork 29.9k
/
media_player.py
979 lines (827 loc) · 32 KB
/
media_player.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
"""Support for interfacing with the XBMC/Kodi JSON-RPC API."""
from __future__ import annotations
from collections.abc import Awaitable, Callable, Coroutine
from datetime import timedelta
from functools import wraps
import logging
import re
from typing import Any, Concatenate
from jsonrpc_base.jsonrpc import ProtocolError, TransportError
from pykodi import CannotConnectError
import voluptuous as vol
from homeassistant.components import media_source
from homeassistant.components.media_player import (
PLATFORM_SCHEMA as MEDIA_PLAYER_PLATFORM_SCHEMA,
BrowseError,
BrowseMedia,
MediaPlayerEntity,
MediaPlayerEntityFeature,
MediaPlayerState,
MediaType,
async_process_play_media_url,
)
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
from homeassistant.const import (
ATTR_ENTITY_ID,
CONF_DEVICE_ID,
CONF_HOST,
CONF_NAME,
CONF_PASSWORD,
CONF_PORT,
CONF_PROXY_SSL,
CONF_SSL,
CONF_TIMEOUT,
CONF_TYPE,
CONF_USERNAME,
EVENT_HOMEASSISTANT_STARTED,
)
from homeassistant.core import CoreState, HomeAssistant, callback
from homeassistant.helpers import (
config_validation as cv,
device_registry as dr,
entity_platform,
)
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.event import async_track_time_interval
from homeassistant.helpers.network import is_internal_request
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType, VolDictType
import homeassistant.util.dt as dt_util
from .browse_media import (
build_item_response,
get_media_info,
library_payload,
media_source_content_filter,
)
from .const import (
CONF_WS_PORT,
DATA_CONNECTION,
DATA_KODI,
DEFAULT_PORT,
DEFAULT_SSL,
DEFAULT_TIMEOUT,
DEFAULT_WS_PORT,
DOMAIN,
EVENT_TURN_OFF,
EVENT_TURN_ON,
)
_LOGGER = logging.getLogger(__name__)
EVENT_KODI_CALL_METHOD_RESULT = "kodi_call_method_result"
CONF_TCP_PORT = "tcp_port"
CONF_TURN_ON_ACTION = "turn_on_action"
CONF_TURN_OFF_ACTION = "turn_off_action"
CONF_ENABLE_WEBSOCKET = "enable_websocket"
DEPRECATED_TURN_OFF_ACTIONS = {
None: None,
"quit": "Application.Quit",
"hibernate": "System.Hibernate",
"suspend": "System.Suspend",
"reboot": "System.Reboot",
"shutdown": "System.Shutdown",
}
WEBSOCKET_WATCHDOG_INTERVAL = timedelta(seconds=10)
# https://github.com/xbmc/xbmc/blob/master/xbmc/media/MediaType.h
MEDIA_TYPES = {
"music": MediaType.MUSIC,
"artist": MediaType.MUSIC,
"album": MediaType.MUSIC,
"song": MediaType.MUSIC,
"video": MediaType.VIDEO,
"set": MediaType.PLAYLIST,
"musicvideo": MediaType.VIDEO,
"movie": MediaType.MOVIE,
"tvshow": MediaType.TVSHOW,
"season": MediaType.TVSHOW,
"episode": MediaType.TVSHOW,
# Type 'channel' is used for radio or tv streams from pvr
"channel": MediaType.CHANNEL,
# Type 'audio' is used for audio media, that Kodi couldn't scroblle
"audio": MediaType.MUSIC,
}
MAP_KODI_MEDIA_TYPES: dict[MediaType | str, str] = {
MediaType.MOVIE: "movieid",
MediaType.EPISODE: "episodeid",
MediaType.SEASON: "seasonid",
MediaType.TVSHOW: "tvshowid",
}
PLATFORM_SCHEMA = MEDIA_PLAYER_PLATFORM_SCHEMA.extend(
{
vol.Required(CONF_HOST): cv.string,
vol.Optional(CONF_NAME): cv.string,
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
vol.Optional(CONF_TCP_PORT, default=DEFAULT_WS_PORT): cv.port,
vol.Optional(CONF_PROXY_SSL, default=DEFAULT_SSL): cv.boolean,
vol.Optional(CONF_TURN_ON_ACTION): cv.SCRIPT_SCHEMA,
vol.Optional(CONF_TURN_OFF_ACTION): vol.Any(
cv.SCRIPT_SCHEMA, vol.In(DEPRECATED_TURN_OFF_ACTIONS)
),
vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
vol.Inclusive(CONF_USERNAME, "auth"): cv.string,
vol.Inclusive(CONF_PASSWORD, "auth"): cv.string,
vol.Optional(CONF_ENABLE_WEBSOCKET, default=True): cv.boolean,
}
)
SERVICE_ADD_MEDIA = "add_to_playlist"
SERVICE_CALL_METHOD = "call_method"
ATTR_MEDIA_TYPE = "media_type"
ATTR_MEDIA_NAME = "media_name"
ATTR_MEDIA_ARTIST_NAME = "artist_name"
ATTR_MEDIA_ID = "media_id"
ATTR_METHOD = "method"
KODI_ADD_MEDIA_SCHEMA: VolDictType = {
vol.Required(ATTR_MEDIA_TYPE): cv.string,
vol.Optional(ATTR_MEDIA_ID): cv.string,
vol.Optional(ATTR_MEDIA_NAME): cv.string,
vol.Optional(ATTR_MEDIA_ARTIST_NAME): cv.string,
}
KODI_CALL_METHOD_SCHEMA = cv.make_entity_service_schema(
{vol.Required(ATTR_METHOD): cv.string}, extra=vol.ALLOW_EXTRA
)
def find_matching_config_entries_for_host(hass, host):
"""Search existing config entries for one matching the host."""
for entry in hass.config_entries.async_entries(DOMAIN):
if entry.data[CONF_HOST] == host:
return entry
return None
async def async_setup_platform(
hass: HomeAssistant,
config: ConfigType,
async_add_entities: AddEntitiesCallback,
discovery_info: DiscoveryInfoType | None = None,
) -> None:
"""Set up the Kodi platform."""
if discovery_info:
# Now handled by zeroconf in the config flow
return
host = config[CONF_HOST]
if find_matching_config_entries_for_host(hass, host):
return
websocket = config.get(CONF_ENABLE_WEBSOCKET)
ws_port = config.get(CONF_TCP_PORT) if websocket else None
entry_data = {
CONF_NAME: config.get(CONF_NAME, host),
CONF_HOST: host,
CONF_PORT: config.get(CONF_PORT),
CONF_WS_PORT: ws_port,
CONF_USERNAME: config.get(CONF_USERNAME),
CONF_PASSWORD: config.get(CONF_PASSWORD),
CONF_SSL: config.get(CONF_PROXY_SSL),
CONF_TIMEOUT: config.get(CONF_TIMEOUT),
}
hass.async_create_task(
hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_IMPORT}, data=entry_data
)
)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Kodi media player platform."""
platform = entity_platform.async_get_current_platform()
platform.async_register_entity_service(
SERVICE_ADD_MEDIA, KODI_ADD_MEDIA_SCHEMA, "async_add_media_to_playlist"
)
platform.async_register_entity_service(
SERVICE_CALL_METHOD, KODI_CALL_METHOD_SCHEMA, "async_call_method"
)
data = hass.data[DOMAIN][config_entry.entry_id]
connection = data[DATA_CONNECTION]
kodi = data[DATA_KODI]
name = config_entry.data[CONF_NAME]
if (uid := config_entry.unique_id) is None:
uid = config_entry.entry_id
entity = KodiEntity(connection, kodi, name, uid)
async_add_entities([entity])
def cmd[_KodiEntityT: KodiEntity, **_P](
func: Callable[Concatenate[_KodiEntityT, _P], Awaitable[Any]],
) -> Callable[Concatenate[_KodiEntityT, _P], Coroutine[Any, Any, None]]:
"""Catch command exceptions."""
@wraps(func)
async def wrapper(obj: _KodiEntityT, *args: _P.args, **kwargs: _P.kwargs) -> None:
"""Wrap all command methods."""
try:
await func(obj, *args, **kwargs)
except (TransportError, ProtocolError) as exc:
# If Kodi is off, we expect calls to fail.
if obj.state == MediaPlayerState.OFF:
log_function = _LOGGER.debug
else:
log_function = _LOGGER.error
log_function(
"Error calling %s on entity %s: %r",
func.__name__,
obj.entity_id,
exc,
)
return wrapper
class KodiEntity(MediaPlayerEntity):
"""Representation of a XBMC/Kodi device."""
_attr_has_entity_name = True
_attr_name = None
_attr_translation_key = "media_player"
_attr_supported_features = (
MediaPlayerEntityFeature.BROWSE_MEDIA
| MediaPlayerEntityFeature.NEXT_TRACK
| MediaPlayerEntityFeature.PAUSE
| MediaPlayerEntityFeature.PLAY
| MediaPlayerEntityFeature.PLAY_MEDIA
| MediaPlayerEntityFeature.PREVIOUS_TRACK
| MediaPlayerEntityFeature.SEEK
| MediaPlayerEntityFeature.SHUFFLE_SET
| MediaPlayerEntityFeature.STOP
| MediaPlayerEntityFeature.TURN_OFF
| MediaPlayerEntityFeature.TURN_ON
| MediaPlayerEntityFeature.VOLUME_MUTE
| MediaPlayerEntityFeature.VOLUME_SET
| MediaPlayerEntityFeature.VOLUME_STEP
)
def __init__(self, connection, kodi, name, uid):
"""Initialize the Kodi entity."""
self._connection = connection
self._kodi = kodi
self._attr_unique_id = uid
self._device_id = None
self._players = None
self._properties = {}
self._item = {}
self._app_properties = {}
self._media_position_updated_at = None
self._media_position = None
self._connect_error = False
self._attr_device_info = DeviceInfo(
identifiers={(DOMAIN, uid)},
manufacturer="Kodi",
name=name,
)
def _reset_state(self, players=None):
self._players = players
self._properties = {}
self._item = {}
self._app_properties = {}
self._media_position_updated_at = None
self._media_position = None
@property
def _kodi_is_off(self):
return self._players is None
@property
def _no_active_players(self):
return not self._players
@callback
def async_on_speed_event(self, sender, data):
"""Handle player changes between playing and paused."""
self._properties["speed"] = data["player"]["speed"]
if not hasattr(data["item"], "id"):
# If no item id is given, perform a full update
force_refresh = True
else:
# If a new item is playing, force a complete refresh
force_refresh = data["item"]["id"] != self._item.get("id")
self.async_schedule_update_ha_state(force_refresh)
@callback
def async_on_stop(self, sender, data):
"""Handle the stop of the player playback."""
# Prevent stop notifications which are sent after quit notification
if self._kodi_is_off:
return
self._reset_state([])
self.async_write_ha_state()
@callback
def async_on_volume_changed(self, sender, data):
"""Handle the volume changes."""
self._app_properties["volume"] = data["volume"]
self._app_properties["muted"] = data["muted"]
self.async_write_ha_state()
@callback
def async_on_key_press(self, sender, data):
"""Handle a incoming key press notification."""
self.hass.bus.async_fire(
f"{DOMAIN}_keypress",
{
CONF_TYPE: "keypress",
CONF_DEVICE_ID: self._device_id,
ATTR_ENTITY_ID: self.entity_id,
"sender": sender,
"data": data,
},
)
async def async_on_quit(self, sender, data):
"""Reset the player state on quit action."""
await self._clear_connection()
async def _clear_connection(self, close=True):
self._reset_state()
self.async_write_ha_state()
if close:
await self._connection.close()
@property
def state(self) -> MediaPlayerState:
"""Return the state of the device."""
if self._kodi_is_off:
return MediaPlayerState.OFF
if self._no_active_players:
return MediaPlayerState.IDLE
if self._properties["speed"] == 0:
return MediaPlayerState.PAUSED
return MediaPlayerState.PLAYING
async def async_added_to_hass(self) -> None:
"""Connect the websocket if needed."""
if not self._connection.can_subscribe:
return
if self._connection.connected:
await self._on_ws_connected()
async def start_watchdog(event=None):
"""Start websocket watchdog."""
await self._async_connect_websocket_if_disconnected()
self.async_on_remove(
async_track_time_interval(
self.hass,
self._async_connect_websocket_if_disconnected,
WEBSOCKET_WATCHDOG_INTERVAL,
)
)
# If Home Assistant is already in a running state, start the watchdog
# immediately, else trigger it after Home Assistant has finished starting.
if self.hass.state is CoreState.running:
await start_watchdog()
else:
self.hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STARTED, start_watchdog)
async def _on_ws_connected(self):
"""Call after ws is connected."""
self._connect_error = False
self._register_ws_callbacks()
version = (await self._kodi.get_application_properties(["version"]))["version"]
sw_version = f"{version['major']}.{version['minor']}"
dev_reg = dr.async_get(self.hass)
device = dev_reg.async_get_device(identifiers={(DOMAIN, self.unique_id)})
dev_reg.async_update_device(device.id, sw_version=sw_version)
self._device_id = device.id
self.async_schedule_update_ha_state(True)
async def _async_ws_connect(self):
"""Connect to Kodi via websocket protocol."""
try:
await self._connection.connect()
await self._on_ws_connected()
except (TransportError, CannotConnectError):
if not self._connect_error:
self._connect_error = True
_LOGGER.warning("Unable to connect to Kodi via websocket")
await self._clear_connection(False)
else:
self._connect_error = False
async def _ping(self):
try:
await self._kodi.ping()
except (TransportError, CannotConnectError):
if not self._connect_error:
self._connect_error = True
_LOGGER.warning("Unable to ping Kodi via websocket")
await self._clear_connection()
else:
self._connect_error = False
async def _async_connect_websocket_if_disconnected(self, *_):
"""Reconnect the websocket if it fails."""
if not self._connection.connected:
await self._async_ws_connect()
else:
await self._ping()
@callback
def _register_ws_callbacks(self):
self._connection.server.Player.OnPause = self.async_on_speed_event
self._connection.server.Player.OnPlay = self.async_on_speed_event
self._connection.server.Player.OnAVStart = self.async_on_speed_event
self._connection.server.Player.OnAVChange = self.async_on_speed_event
self._connection.server.Player.OnResume = self.async_on_speed_event
self._connection.server.Player.OnSpeedChanged = self.async_on_speed_event
self._connection.server.Player.OnSeek = self.async_on_speed_event
self._connection.server.Player.OnStop = self.async_on_stop
self._connection.server.Application.OnVolumeChanged = (
self.async_on_volume_changed
)
self._connection.server.Other.OnKeyPress = self.async_on_key_press
self._connection.server.System.OnQuit = self.async_on_quit
self._connection.server.System.OnRestart = self.async_on_quit
self._connection.server.System.OnSleep = self.async_on_quit
@cmd
async def async_update(self) -> None:
"""Retrieve latest state."""
if not self._connection.connected:
self._reset_state()
return
try:
self._players = await self._kodi.get_players()
except (TransportError, ProtocolError):
if not self._connection.can_subscribe:
self._reset_state()
return
raise
if self._kodi_is_off:
self._reset_state()
return
if self._players:
self._app_properties = await self._kodi.get_application_properties(
["volume", "muted"]
)
self._properties = await self._kodi.get_player_properties(
self._players[0], ["time", "totaltime", "speed", "live"]
)
position = self._properties["time"]
if self._media_position != position:
self._media_position_updated_at = dt_util.utcnow()
self._media_position = position
self._item = await self._kodi.get_playing_item_properties(
self._players[0],
[
"title",
"file",
"uniqueid",
"thumbnail",
"artist",
"albumartist",
"showtitle",
"album",
"season",
"episode",
"streamdetails",
],
)
else:
self._reset_state([])
@property
def should_poll(self) -> bool:
"""Return True if entity has to be polled for state."""
return not self._connection.can_subscribe
@property
def volume_level(self) -> float | None:
"""Volume level of the media player (0..1)."""
if "volume" in self._app_properties:
return int(self._app_properties["volume"]) / 100.0
return None
@property
def is_volume_muted(self):
"""Boolean if volume is currently muted."""
return self._app_properties.get("muted")
@property
def media_content_id(self):
"""Content ID of current playing media."""
return self._item.get("uniqueid", None)
@property
def media_content_type(self):
"""Content type of current playing media.
If the media type cannot be detected, the player type is used.
"""
item_type = MEDIA_TYPES.get(self._item.get("type"))
if (item_type is None or item_type == "channel") and self._players:
return MEDIA_TYPES.get(self._players[0]["type"])
return item_type
@property
def media_duration(self):
"""Duration of current playing media in seconds."""
if self._properties.get("live"):
return None
if (total_time := self._properties.get("totaltime")) is None:
return None
return (
total_time["hours"] * 3600
+ total_time["minutes"] * 60
+ total_time["seconds"]
)
@property
def media_position(self):
"""Position of current playing media in seconds."""
if (time := self._properties.get("time")) is None:
return None
return time["hours"] * 3600 + time["minutes"] * 60 + time["seconds"]
@property
def media_position_updated_at(self):
"""Last valid time of media position."""
return self._media_position_updated_at
@property
def media_image_url(self):
"""Image url of current playing media."""
if (thumbnail := self._item.get("thumbnail")) is None:
return None
return self._kodi.thumbnail_url(thumbnail)
@property
def media_title(self):
"""Title of current playing media."""
# find a string we can use as a title
item = self._item
return item.get("title") or item.get("label") or item.get("file")
@property
def media_series_title(self):
"""Title of series of current playing media, TV show only."""
return self._item.get("showtitle")
@property
def media_season(self):
"""Season of current playing media, TV show only."""
return self._item.get("season")
@property
def media_episode(self):
"""Episode of current playing media, TV show only."""
return self._item.get("episode")
@property
def media_album_name(self):
"""Album name of current playing media, music track only."""
return self._item.get("album")
@property
def media_artist(self):
"""Artist of current playing media, music track only."""
if artists := self._item.get("artist"):
return artists[0]
return None
@property
def media_album_artist(self):
"""Album artist of current playing media, music track only."""
if artists := self._item.get("albumartist"):
return artists[0]
return None
@property
def extra_state_attributes(self) -> dict[str, str | None]:
"""Return the state attributes."""
state_attr: dict[str, str | None] = {}
if self.state == MediaPlayerState.OFF:
return state_attr
state_attr["dynamic_range"] = "sdr"
if (video_details := self._item.get("streamdetails", {}).get("video")) and (
hdr_type := video_details[0].get("hdrtype")
):
state_attr["dynamic_range"] = hdr_type
return state_attr
async def async_turn_on(self) -> None:
"""Turn the media player on."""
_LOGGER.debug("Firing event to turn on device")
self.hass.bus.async_fire(EVENT_TURN_ON, {ATTR_ENTITY_ID: self.entity_id})
async def async_turn_off(self) -> None:
"""Turn the media player off."""
_LOGGER.debug("Firing event to turn off device")
self.hass.bus.async_fire(EVENT_TURN_OFF, {ATTR_ENTITY_ID: self.entity_id})
@cmd
async def async_volume_up(self) -> None:
"""Volume up the media player."""
await self._kodi.volume_up()
@cmd
async def async_volume_down(self) -> None:
"""Volume down the media player."""
await self._kodi.volume_down()
@cmd
async def async_set_volume_level(self, volume: float) -> None:
"""Set volume level, range 0..1."""
await self._kodi.set_volume_level(int(volume * 100))
@cmd
async def async_mute_volume(self, mute: bool) -> None:
"""Mute (true) or unmute (false) media player."""
await self._kodi.mute(mute)
@cmd
async def async_media_play_pause(self) -> None:
"""Pause media on media player."""
await self._kodi.play_pause()
@cmd
async def async_media_play(self) -> None:
"""Play media."""
await self._kodi.play()
@cmd
async def async_media_pause(self) -> None:
"""Pause the media player."""
await self._kodi.pause()
@cmd
async def async_media_stop(self) -> None:
"""Stop the media player."""
await self._kodi.stop()
@cmd
async def async_media_next_track(self) -> None:
"""Send next track command."""
await self._kodi.next_track()
@cmd
async def async_media_previous_track(self) -> None:
"""Send next track command."""
await self._kodi.previous_track()
@cmd
async def async_media_seek(self, position: float) -> None:
"""Send seek command."""
await self._kodi.media_seek(position)
@cmd
async def async_play_media(
self, media_type: MediaType | str, media_id: str, **kwargs: Any
) -> None:
"""Send the play_media command to the media player."""
if media_source.is_media_source_id(media_id):
media_type = MediaType.URL
play_item = await media_source.async_resolve_media(
self.hass, media_id, self.entity_id
)
media_id = play_item.url
media_type_lower = media_type.lower()
if media_type_lower == MediaType.CHANNEL:
await self._kodi.play_channel(int(media_id))
elif media_type_lower == MediaType.PLAYLIST:
await self._kodi.play_playlist(int(media_id))
elif media_type_lower == "file":
await self._kodi.play_file(media_id)
elif media_type_lower == "directory":
await self._kodi.play_directory(media_id)
elif media_type_lower in [
MediaType.ARTIST,
MediaType.ALBUM,
MediaType.TRACK,
]:
await self.async_clear_playlist()
await self.async_add_to_playlist(media_type_lower, media_id)
await self._kodi.play_playlist(0)
elif media_type_lower in [
MediaType.MOVIE,
MediaType.EPISODE,
MediaType.SEASON,
MediaType.TVSHOW,
]:
await self._kodi.play_item(
{MAP_KODI_MEDIA_TYPES[media_type_lower]: int(media_id)}
)
else:
media_id = async_process_play_media_url(self.hass, media_id)
await self._kodi.play_file(media_id)
@cmd
async def async_set_shuffle(self, shuffle: bool) -> None:
"""Set shuffle mode, for the first player."""
if self._no_active_players:
raise RuntimeError("Error: No active player.")
await self._kodi.set_shuffle(shuffle)
async def async_call_method(self, method, **kwargs):
"""Run Kodi JSONRPC API method with params."""
_LOGGER.debug("Run API method %s, kwargs=%s", method, kwargs)
result_ok = False
try:
result = await self._kodi.call_method(method, **kwargs)
result_ok = True
except ProtocolError as exc:
result = exc.args[2]["error"]
_LOGGER.error(
"Run API method %s.%s(%s) error: %s",
self.entity_id,
method,
kwargs,
result,
)
except TransportError:
result = None
_LOGGER.warning(
"TransportError trying to run API method %s.%s(%s)",
self.entity_id,
method,
kwargs,
)
if isinstance(result, dict):
event_data = {
"entity_id": self.entity_id,
"result": result,
"result_ok": result_ok,
"input": {"method": method, "params": kwargs},
}
_LOGGER.debug("EVENT kodi_call_method_result: %s", event_data)
self.hass.bus.async_fire(
EVENT_KODI_CALL_METHOD_RESULT, event_data=event_data
)
return result
async def async_clear_playlist(self) -> None:
"""Clear default playlist (i.e. playlistid=0)."""
await self._kodi.clear_playlist()
async def async_add_to_playlist(self, media_type, media_id):
"""Add media item to default playlist (i.e. playlistid=0)."""
if media_type == MediaType.ARTIST:
await self._kodi.add_artist_to_playlist(int(media_id))
elif media_type == MediaType.ALBUM:
await self._kodi.add_album_to_playlist(int(media_id))
elif media_type == MediaType.TRACK:
await self._kodi.add_song_to_playlist(int(media_id))
async def async_add_media_to_playlist(
self, media_type, media_id=None, media_name="ALL", artist_name=""
):
"""Add a media to default playlist.
First the media type must be selected, then
the media can be specified in terms of id or
name and optionally artist name.
All the albums of an artist can be added with
media_name="ALL"
"""
if media_type == "SONG":
if media_id is None:
media_id = await self._async_find_song(media_name, artist_name)
if media_id:
await self._kodi.add_song_to_playlist(int(media_id))
elif media_type == "ALBUM":
if media_id is None:
if media_name == "ALL":
await self._async_add_all_albums(artist_name)
return
media_id = await self._async_find_album(media_name, artist_name)
if media_id:
await self._kodi.add_album_to_playlist(int(media_id))
else:
raise RuntimeError("Unrecognized media type.")
if media_id is None:
_LOGGER.warning("No media detected for Playlist.Add")
async def _async_add_all_albums(self, artist_name):
"""Add all albums of an artist to default playlist (i.e. playlistid=0).
The artist is specified in terms of name.
"""
artist_id = await self._async_find_artist(artist_name)
albums = await self._kodi.get_albums(artist_id)
for alb in albums["albums"]:
await self._kodi.add_album_to_playlist(int(alb["albumid"]))
async def _async_find_artist(self, artist_name):
"""Find artist by name."""
artists = await self._kodi.get_artists()
try:
out = self._find(artist_name, [a["artist"] for a in artists["artists"]])
return artists["artists"][out[0][0]]["artistid"]
except KeyError:
_LOGGER.warning("No artists were found: %s", artist_name)
return None
async def _async_find_song(self, song_name, artist_name=""):
"""Find song by name and optionally artist name."""
artist_id = None
if artist_name != "":
artist_id = await self._async_find_artist(artist_name)
songs = await self._kodi.get_songs(artist_id)
if songs["limits"]["total"] == 0:
return None
out = self._find(song_name, [a["label"] for a in songs["songs"]])
return songs["songs"][out[0][0]]["songid"]
async def _async_find_album(self, album_name, artist_name=""):
"""Find album by name and optionally artist name."""
artist_id = None
if artist_name != "":
artist_id = await self._async_find_artist(artist_name)
albums = await self._kodi.get_albums(artist_id)
try:
out = self._find(album_name, [a["label"] for a in albums["albums"]])
return albums["albums"][out[0][0]]["albumid"]
except KeyError:
_LOGGER.warning(
"No albums were found with artist: %s, album: %s",
artist_name,
album_name,
)
return None
@staticmethod
def _find(key_word, words):
key_word = key_word.split(" ")
patt = [re.compile(f"(^| ){k}( |$)", re.IGNORECASE) for k in key_word]
out = [[i, 0] for i in range(len(words))]
for i in range(len(words)):
mtc = [p.search(words[i]) for p in patt]
rate = [m is not None for m in mtc].count(True)
out[i][1] = rate
return sorted(out, key=lambda out: out[1], reverse=True)
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."""
is_internal = is_internal_request(self.hass)
async def _get_thumbnail_url(
media_content_type,
media_content_id,
media_image_id=None,
thumbnail_url=None,
):
if is_internal:
return self._kodi.thumbnail_url(thumbnail_url)
return self.get_browse_image_url(
media_content_type,
media_content_id,
media_image_id,
)
if media_content_type in [None, "library"]:
return await library_payload(self.hass)
if media_content_id and media_source.is_media_source_id(media_content_id):
return await media_source.async_browse_media(
self.hass, media_content_id, content_filter=media_source_content_filter
)
payload = {
"search_type": media_content_type,
"search_id": media_content_id,
}
response = await build_item_response(self._kodi, payload, _get_thumbnail_url)
if response is None:
raise BrowseError(
f"Media not found: {media_content_type} / {media_content_id}"
)
return response
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]:
"""Get media image from kodi server."""
try:
image_url, _, _ = await get_media_info(
self._kodi, media_content_id, media_content_type
)
except (ProtocolError, TransportError):
return (None, None)
if image_url:
return await self._async_fetch_image(image_url)
return (None, None)