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
|
"""Snapcast server."""
import asyncio
import logging
from packaging import version
from snapcast.control.client import Snapclient
from snapcast.control.group import Snapgroup
from snapcast.control.protocol import SERVER_ONDISCONNECT, SnapcastProtocol
from snapcast.control.stream import Snapstream
_LOGGER = logging.getLogger(__name__)
CONTROL_PORT = 1705
SERVER_GETSTATUS = 'Server.GetStatus'
SERVER_GETRPCVERSION = 'Server.GetRPCVersion'
SERVER_DELETECLIENT = 'Server.DeleteClient'
SERVER_ONUPDATE = 'Server.OnUpdate'
CLIENT_GETSTATUS = 'Client.GetStatus'
CLIENT_SETNAME = 'Client.SetName'
CLIENT_SETLATENCY = 'Client.SetLatency'
CLIENT_SETVOLUME = 'Client.SetVolume'
CLIENT_ONCONNECT = 'Client.OnConnect'
CLIENT_ONDISCONNECT = 'Client.OnDisconnect'
CLIENT_ONVOLUMECHANGED = 'Client.OnVolumeChanged'
CLIENT_ONLATENCYCHANGED = 'Client.OnLatencyChanged'
CLIENT_ONNAMECHANGED = 'Client.OnNameChanged'
GROUP_GETSTATUS = 'Group.GetStatus'
GROUP_SETMUTE = 'Group.SetMute'
GROUP_SETSTREAM = 'Group.SetStream'
GROUP_SETCLIENTS = 'Group.SetClients'
GROUP_SETNAME = 'Group.SetName'
GROUP_ONMUTE = 'Group.OnMute'
GROUP_ONSTREAMCHANGED = 'Group.OnStreamChanged'
GROUP_ONNAMECHANGED = 'Group.OnNameChanged'
STREAM_ONPROPERTIES = 'Stream.OnProperties'
STREAM_SETPROPERTY = 'Stream.SetProperty'
STREAM_CONTROL = 'Stream.Control' # not yet implemented
STREAM_SETMETA = 'Stream.SetMeta' # deprecated
STREAM_ONUPDATE = 'Stream.OnUpdate'
STREAM_ONMETA = 'Stream.OnMetadata' # deprecated
STREAM_ADDSTREAM = 'Stream.AddStream'
STREAM_REMOVESTREAM = 'Stream.RemoveStream'
SERVER_RECONNECT_DELAY = 5
_EVENTS = [SERVER_ONUPDATE, CLIENT_ONVOLUMECHANGED, CLIENT_ONLATENCYCHANGED,
CLIENT_ONNAMECHANGED, CLIENT_ONCONNECT, CLIENT_ONDISCONNECT,
GROUP_ONMUTE, GROUP_ONSTREAMCHANGED, GROUP_ONNAMECHANGED, STREAM_ONUPDATE,
STREAM_ONMETA, STREAM_ONPROPERTIES]
_METHODS = [SERVER_GETSTATUS, SERVER_GETRPCVERSION, SERVER_DELETECLIENT,
SERVER_DELETECLIENT, CLIENT_GETSTATUS, CLIENT_SETNAME,
CLIENT_SETLATENCY, CLIENT_SETVOLUME,
GROUP_GETSTATUS, GROUP_SETMUTE, GROUP_SETSTREAM, GROUP_SETCLIENTS,
GROUP_SETNAME, STREAM_SETMETA, STREAM_SETPROPERTY, STREAM_CONTROL,
STREAM_ADDSTREAM, STREAM_REMOVESTREAM]
# server versions in which new methods were added
_VERSIONS = {
GROUP_SETNAME: '0.16.0',
STREAM_SETPROPERTY: '0.26.0',
STREAM_ADDSTREAM: '0.16.0',
STREAM_REMOVESTREAM: '0.16.0',
}
class ServerVersionError(NotImplementedError):
"""Server Version Error, not implemented."""
# pylint: disable=too-many-public-methods
class Snapserver():
"""Represents a snapserver."""
# pylint: disable=too-many-instance-attributes
def __init__(self, loop, host, port=CONTROL_PORT, reconnect=False):
"""Initialize."""
self._loop = loop
self._port = port
self._reconnect = reconnect
self._is_stopped = True
self._clients = {}
self._streams = {}
self._groups = {}
self._host = host
self._version = None
self._protocol = None
self._transport = None
self._callbacks = {
CLIENT_ONCONNECT: self._on_client_connect,
CLIENT_ONDISCONNECT: self._on_client_disconnect,
CLIENT_ONVOLUMECHANGED: self._on_client_volume_changed,
CLIENT_ONNAMECHANGED: self._on_client_name_changed,
CLIENT_ONLATENCYCHANGED: self._on_client_latency_changed,
GROUP_ONMUTE: self._on_group_mute,
GROUP_ONSTREAMCHANGED: self._on_group_stream_changed,
GROUP_ONNAMECHANGED: self._on_group_name_changed,
STREAM_ONMETA: self._on_stream_meta,
STREAM_ONPROPERTIES: self._on_stream_properties,
STREAM_ONUPDATE: self._on_stream_update,
SERVER_ONDISCONNECT: self._on_server_disconnect,
SERVER_ONUPDATE: self._on_server_update
}
self._on_update_callback_func = None
self._on_connect_callback_func = None
self._on_disconnect_callback_func = None
self._new_client_callback_func = None
async def start(self):
"""Initiate server connection."""
self._is_stopped = False
await self._do_connect()
status, error = await self.status()
if (not isinstance(status, dict)) or ('server' not in status):
_LOGGER.warning('connected, but no valid response:\n%s', str(error))
self.stop()
raise OSError
_LOGGER.debug('connected to snapserver on %s:%s', self._host, self._port)
self.synchronize(status)
self._on_server_connect()
def stop(self):
"""Stop server."""
self._is_stopped = True
self._do_disconnect()
_LOGGER.debug('Stopping')
self._clients = {}
self._streams = {}
self._groups = {}
self._version = None
def _do_disconnect(self):
"""Perform the connection to the server."""
if self._transport:
self._transport.close()
async def _do_connect(self):
"""Perform the connection to the server."""
self._transport, self._protocol = await self._loop.create_connection(
lambda: SnapcastProtocol(self._callbacks), self._host, self._port)
def _reconnect_cb(self):
"""Try to reconnect to the server."""
_LOGGER.debug('try reconnect')
async def try_reconnect():
"""Actual coroutine ro try to reconnect or reschedule."""
try:
await self._do_connect()
status, error = await self.status()
if (not isinstance(status, dict)) or ('server' not in status):
_LOGGER.warning('connected, but no valid response:\n%s', str(error))
self.stop()
raise OSError
except OSError:
self._loop.call_later(SERVER_RECONNECT_DELAY,
self._reconnect_cb)
else:
self.synchronize(status)
self._on_server_connect()
asyncio.ensure_future(try_reconnect())
async def _transact(self, method, params=None):
"""Wrap requests."""
result = error = None
if self._protocol is None or self._transport is None or self._transport.is_closing():
error = {"code": None, "message": "Server not connected"}
else:
result, error = await self._protocol.request(method, params)
return (result, error)
@property
def version(self):
"""Version."""
return self._version
async def status(self):
"""System status."""
return await self._transact(SERVER_GETSTATUS)
async def rpc_version(self):
"""RPC version."""
return await self._transact(SERVER_GETRPCVERSION)
async def delete_client(self, identifier):
"""Delete client."""
params = {'id': identifier}
response, error = await self._transact(SERVER_DELETECLIENT, params)
if (isinstance(response, dict) and ("server" in response)):
self.synchronize(response)
return response, error
async def client_name(self, identifier, name):
"""Set client name."""
return await self._request(CLIENT_SETNAME, identifier, 'name', name)
async def client_latency(self, identifier, latency):
"""Set client latency."""
return await self._request(CLIENT_SETLATENCY, identifier, 'latency', latency)
async def client_volume(self, identifier, volume):
"""Set client volume."""
return await self._request(CLIENT_SETVOLUME, identifier, 'volume', volume)
async def client_status(self, identifier):
"""Get client status."""
return await self._request(CLIENT_GETSTATUS, identifier, 'client')
async def group_status(self, identifier):
"""Get group status."""
return await self._request(GROUP_GETSTATUS, identifier, 'group')
async def group_mute(self, identifier, status):
"""Set group mute."""
return await self._request(GROUP_SETMUTE, identifier, 'mute', status)
async def group_stream(self, identifier, stream_id):
"""Set group stream."""
return await self._request(GROUP_SETSTREAM, identifier, 'stream_id', stream_id)
async def group_clients(self, identifier, clients):
"""Set group clients."""
return await self._request(GROUP_SETCLIENTS, identifier, 'clients', clients)
async def group_name(self, identifier, name):
"""Set group name."""
self._version_check(GROUP_SETNAME)
return await self._request(GROUP_SETNAME, identifier, 'name', name)
async def stream_control(self, identifier, control_command, control_params):
"""Set stream control."""
self._version_check(STREAM_SETPROPERTY)
return await self._request(
STREAM_CONTROL, identifier, 'command', control_command, control_params)
async def stream_setmeta(self, identifier, meta): # deprecated
"""Set stream metadata."""
return await self._request(STREAM_SETMETA, identifier, 'meta', meta)
async def stream_setproperty(self, identifier, stream_property, value):
"""Set stream metadata."""
self._version_check(STREAM_SETPROPERTY)
return await self._request(STREAM_SETPROPERTY, identifier, parameters={
'property': stream_property,
'value': value
})
async def stream_add_stream(self, stream_uri):
"""Add a stream."""
params = {"streamUri": stream_uri}
result, error = await self._transact(STREAM_ADDSTREAM, params)
if (isinstance(result, dict) and ("id" in result)):
self.synchronize((await self.status())[0])
return result or error
async def stream_remove_stream(self, identifier):
"""Remove a Stream."""
result = await self._request(STREAM_REMOVESTREAM, identifier)
if (isinstance(result, dict) and ("id" in result)):
self.synchronize((await self.status())[0])
return result
def group(self, group_identifier):
"""Get a group."""
return self._groups[group_identifier]
def stream(self, stream_identifier):
"""Get a stream."""
return self._streams[stream_identifier]
def client(self, client_identifier):
"""Get a client."""
return self._clients[client_identifier]
@property
def groups(self):
"""Get groups."""
return list(self._groups.values())
@property
def clients(self):
"""Get clients."""
return list(self._clients.values())
@property
def streams(self):
"""Get streams."""
return list(self._streams.values())
def synchronize(self, status):
"""Synchronize snapserver."""
self._version = status['server']['server']['snapserver']['version']
new_groups = {}
new_clients = {}
new_streams = {}
for stream in status.get('server').get('streams'):
if stream.get('id') in self._streams:
new_streams[stream.get('id')] = self._streams[stream.get('id')]
new_streams[stream.get('id')].update(stream)
else:
new_streams[stream.get('id')] = Snapstream(stream)
_LOGGER.debug('stream found: %s', new_streams[stream.get('id')])
for group in status.get('server').get('groups'):
if group.get('id') in self._groups:
new_groups[group.get('id')] = self._groups[group.get('id')]
new_groups[group.get('id')].update(group)
else:
new_groups[group.get('id')] = Snapgroup(self, group)
for client in group.get('clients'):
if client.get('id') in self._clients:
new_clients[client.get('id')] = self._clients[client.get('id')]
new_clients[client.get('id')].update(client)
else:
new_clients[client.get('id')] = Snapclient(self, client)
_LOGGER.debug('client found: %s', new_clients[client.get('id')])
_LOGGER.debug('group found: %s', new_groups[group.get('id')])
self._groups = new_groups
self._clients = new_clients
self._streams = new_streams
# pylint: disable=too-many-arguments
async def _request(self, method, identifier, key=None, value=None, parameters=None):
"""Perform request with identifier."""
params = {'id': identifier}
if key is not None and value is not None:
params[key] = value
if isinstance(parameters, dict):
params.update(parameters)
result, error = await self._transact(method, params)
if isinstance(result, dict) and key in result:
return result.get(key)
return result or error
def _on_server_connect(self):
"""Handle server connection."""
_LOGGER.debug('Server connected')
if self._on_connect_callback_func and callable(self._on_connect_callback_func):
self._on_connect_callback_func()
def _on_server_disconnect(self, exception):
"""Handle server disconnection."""
_LOGGER.debug('Server disconnected: %s', str(exception))
if self._on_disconnect_callback_func and callable(self._on_disconnect_callback_func):
self._on_disconnect_callback_func(exception)
self._protocol = None
self._transport = None
if (not self._is_stopped) and self._reconnect:
self._reconnect_cb()
def _on_server_update(self, data):
"""Handle server update."""
self.synchronize(data)
if self._on_update_callback_func and callable(self._on_update_callback_func):
self._on_update_callback_func()
def _on_group_mute(self, data):
"""Handle group mute."""
group = self._groups.get(data.get('id'))
group.update_mute(data)
for client_id in group.clients:
self._clients.get(client_id).callback()
def _on_group_name_changed(self, data):
"""Handle group name changed."""
self._groups.get(data.get('id')).update_name(data)
def _on_group_stream_changed(self, data):
"""Handle group stream change."""
group = self._groups.get(data.get('id'))
group.update_stream(data)
for client_id in group.clients:
self._clients.get(client_id).callback()
def _on_client_connect(self, data):
"""Handle client connect."""
client = None
if data.get('id') in self._clients:
client = self._clients[data.get('id')]
client.update_connected(True)
else:
client = Snapclient(self, data.get('client'))
self._clients[data.get('id')] = client
if self._new_client_callback_func and callable(self._new_client_callback_func):
self._new_client_callback_func(client)
_LOGGER.debug('client %s connected', client.friendly_name)
def _on_client_disconnect(self, data):
"""Handle client disconnect."""
self._clients[data.get('id')].update_connected(False)
_LOGGER.debug('client %s disconnected', self._clients[data.get('id')].friendly_name)
def _on_client_volume_changed(self, data):
"""Handle client volume change."""
self._clients.get(data.get('id')).update_volume(data)
def _on_client_name_changed(self, data):
"""Handle client name changed."""
self._clients.get(data.get('id')).update_name(data)
def _on_client_latency_changed(self, data):
"""Handle client latency changed."""
self._clients.get(data.get('id')).update_latency(data)
def _on_stream_meta(self, data): # deprecated
"""Handle stream metadata update."""
if stream := self._streams.get(data.get('id')):
stream.update_meta(data.get('meta'))
_LOGGER.debug('stream %s metadata updated', stream.friendly_name)
for group in self._groups.values():
if group.stream == data.get('id'):
group.callback()
def _on_stream_properties(self, data):
"""Handle stream properties update."""
if stream := self._streams.get(data.get('id')):
stream.update_properties(data.get('properties'))
_LOGGER.debug('stream %s properties updated', stream.friendly_name)
for group in self._groups.values():
if group.stream == data.get('id'):
group.callback()
for client_id in group.clients:
self._clients.get(client_id).callback()
def _on_stream_update(self, data):
"""Handle stream update."""
if data.get('id') in self._streams:
self._streams[data.get('id')].update(data.get('stream'))
_LOGGER.debug('stream %s updated', self._streams[data.get('id')].friendly_name)
self._streams[data.get("id")].callback()
for group in self._groups.values():
if group.stream == data.get('id'):
group.callback()
for client_id in group.clients:
self._clients.get(client_id).callback()
else:
if data.get('stream', {}).get('uri', {}).get('query', {}).get('codec') == 'null':
_LOGGER.debug('stream %s is input-only, ignore', data.get('id'))
else:
_LOGGER.info('stream %s not found, synchronize', data.get('id'))
async def async_sync():
self.synchronize((await self.status())[0])
asyncio.ensure_future(async_sync())
def set_on_update_callback(self, func):
"""Set on update callback function."""
self._on_update_callback_func = func
def set_on_connect_callback(self, func):
"""Set on connection callback function."""
self._on_connect_callback_func = func
def set_on_disconnect_callback(self, func):
"""Set on disconnection callback function."""
self._on_disconnect_callback_func = func
def set_new_client_callback(self, func):
"""Set new client callback function."""
self._new_client_callback_func = func
def __repr__(self):
"""Return string representation."""
return f'Snapserver {self.version} ({self._host})'
def _version_check(self, api_call):
if version.parse(self.version) < version.parse(_VERSIONS.get(api_call)):
raise ServerVersionError(
f"{api_call} requires server version >= {_VERSIONS[api_call]}."
+ f" Current version is {self.version}"
)
|