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
|
"""Client library for RTSPtoWebserver."""
from __future__ import annotations
import base64
import enum
import hashlib
import logging
from typing import Any, Dict, List, Mapping, Optional, cast
from urllib.parse import urljoin
import aiohttp
from .diagnostics import WEB_DIAGNOSTICS as DIAGNOSTICS
from .exceptions import ClientError, ResponseError
from .interface import WebRTCClientInterface
_LOGGER = logging.getLogger(__name__)
STREAMS_PATH = "/streams"
ADD_STREAM_PATH = "/stream/{stream_id}/add"
EDIT_STREAM_PATH = "/stream/{stream_id}/edit"
RELOAD_STREAM_PATH = "/stream/{stream_id}/reload"
STREAM_INFO_PATH = "/stream/{stream_id}/info"
DELETE_STREAM_PATH = "/stream/{stream_id}/delete"
ADD_CHANNEL_PATH = "/stream/{stream_id}/channel/{channel_id}/add"
EDIT_CHANNEL_PATH = "/stream/{stream_id}/channel/{channel_id}/edit"
RELOAD_CHANNEL_PATH = "/stream/{stream_id}/channel/{channel_id}/reload"
CHANNEL_INFO_PATH = "/stream/{stream_id}/channel/{channel_id}/info"
CODEC_INFO_PATH = "/stream/{stream_id}/channel/{channel_id}/codec"
DELETE_CHANNEL_PATH = "/stream/{stream_id}/channel/{channel_id}/delete"
WEBRTC_PATH = "/stream/{stream_id}/channel/{channel_id}/webrtc"
DATA_STATUS = "status"
DATA_PAYLOAD = "payload"
class StatusCode(enum.Enum):
FAILURE = "0"
SUCCESS = "1"
class WebClient(WebRTCClientInterface):
"""Client for RTSPtoWeb server."""
def __init__(
self, websession: aiohttp.ClientSession, server_url: Optional[str] = None
) -> None:
"""Initialize Client."""
self._session = websession
self._base_url = server_url
async def list_streams(self) -> dict[str, Any]:
"""List streams registered with the server."""
resp = await self._request("get", STREAMS_PATH, label="list_streams")
return await self._get_dict(resp)
async def add_stream(self, stream_id: str, data: dict[str, Any]) -> None:
"""Add a stream."""
resp = await self._request(
"post",
ADD_STREAM_PATH.format(stream_id=stream_id),
json=data,
label="add_stream",
)
await self._get_payload(resp)
async def update_stream(self, stream_id: str, data: dict[str, Any]) -> None:
"""Update a stream."""
resp = await self._request(
"post",
EDIT_STREAM_PATH.format(stream_id=stream_id),
json=data,
label="update_stream",
)
await self._get_payload(resp)
async def reload_stream(self, stream_id: str) -> None:
"""Reload a stream."""
resp = await self._request(
"get",
RELOAD_STREAM_PATH.format(stream_id=stream_id),
label="reload_stream",
)
await self._get_payload(resp)
async def get_stream_info(self, stream_id: str) -> dict[str, Any]:
"""Get information about a stream."""
resp = await self._request(
"get", STREAM_INFO_PATH.format(stream_id=stream_id), label="get_stream_info"
)
return await self._get_dict(resp)
async def delete_stream(self, stream_id: str) -> None:
"""Delete a stream."""
resp = await self._request(
"get",
DELETE_STREAM_PATH.format(stream_id=stream_id),
label="delete_stream",
)
await self._get_payload(resp)
async def add_channel(
self, stream_id: str, channel_id: str, data: dict[str, Any]
) -> None:
"""Add a channel"""
resp = await self._request(
"post",
ADD_CHANNEL_PATH.format(stream_id=stream_id, channel_id=channel_id),
json=data,
label="add_channel",
)
await self._get_payload(resp)
async def update_channel(
self, stream_id: str, channel_id: str, data: dict[str, Any]
) -> None:
"""Update a channel."""
resp = await self._request(
"post",
EDIT_CHANNEL_PATH.format(stream_id=stream_id, channel_id=channel_id),
json=data,
label="update_channel",
)
await self._get_payload(resp)
async def reload_channel(self, stream_id: str, channel_id: str) -> None:
"""Reload a channel."""
resp = await self._request(
"get",
RELOAD_CHANNEL_PATH.format(stream_id=stream_id, channel_id=channel_id),
label="reload_channel",
)
await self._get_payload(resp)
async def get_channel_info(self, stream_id: str, channel_id: str) -> dict[str, Any]:
"""Get information about a channel."""
resp = await self._request(
"get",
CHANNEL_INFO_PATH.format(stream_id=stream_id, channel_id=channel_id),
label="get_channel_info",
)
return await self._get_dict(resp)
async def get_codec_info(self, stream_id: str, channel_id: str) -> dict[str, Any]:
"""Get information about a codecs."""
resp = await self._request(
"get",
CODEC_INFO_PATH.format(stream_id=stream_id, channel_id=channel_id),
label="get_codec_info",
)
return await self._get_dict(resp)
async def delete_channel(self, stream_id: str, channel_id: str) -> None:
"""Delete a channel."""
resp = await self._request(
"get",
DELETE_CHANNEL_PATH.format(stream_id=stream_id, channel_id=channel_id),
label="delete_channel",
)
await self._get_payload(resp)
async def webrtc(self, stream_id: str, channel_id: str, offer_sdp: str) -> str:
"""Send the WebRTC offer to the RTSPtoWeb server."""
sdp64 = base64.b64encode(offer_sdp.encode("utf-8")).decode("utf-8")
data = {
"data": sdp64,
}
resp = await self._request(
"post",
WEBRTC_PATH.format(stream_id=stream_id, channel_id=channel_id),
data=data,
label="webrtc",
)
text = await resp.text()
answer = base64.b64decode(text).decode("utf-8")
return answer
async def offer(self, offer_sdp: str, rtsp_url: str) -> str:
"""Send the WebRTC offer to the RTSPtoWeb server."""
# Generate a fake stream id to use until API is updated to pass a
# client generated id
digest = hashlib.md5(rtsp_url.encode("utf-8")).digest()
stream_id = base64.b32encode(digest).decode("utf-8")
return await self.offer_stream_id(stream_id, offer_sdp, rtsp_url)
async def offer_stream_id(
self,
stream_id: str,
offer_sdp: str,
rtsp_url: str,
channel_data: dict[str, Any] | None = None,
) -> str:
"""Send the WebRTC offer to the RTSPtoWeb server."""
# Generate a fake stream id to use until API is updated to pass a
# client generated id
streams = await self.list_streams()
if channel_data is None:
channel_data = {}
stream_payload = {
"name": stream_id,
"channels": {
"0": {
"name": "ch1",
"url": rtsp_url,
**channel_data,
},
},
}
if stream_id in streams:
if streams[stream_id].get("channels", {}).get("0", {}).get("url") == rtsp_url:
_LOGGER.debug("Not updating stream url since already set")
else:
await self.update_stream(stream_id, stream_payload)
else:
await self.add_stream(stream_id, stream_payload)
return await self.webrtc(stream_id, "0", offer_sdp)
async def heartbeat(self) -> None:
"""Send a request to the server to determine if it is alive."""
# ignore result
await self._request("get", STREAMS_PATH, label="heartbeat")
async def _request(
self,
method: str,
path: str,
**kwargs: Optional[Mapping[str, Any]] | str,
) -> aiohttp.ClientResponse:
label = kwargs["label"]
kwargs.pop("label")
url = self._request_url(path)
_LOGGER.debug("request[%s] %s", method, url)
DIAGNOSTICS.increment(f"{label}.request")
try:
resp = await self._session.request(method, url, **kwargs)
except aiohttp.ClientError as err:
DIAGNOSTICS.increment(f"{label}.client_error")
raise ClientError(f"RTSPtoWeb server communication failure: {err}") from err
error_detail = await WebClient._error_detail(resp)
try:
resp.raise_for_status()
except aiohttp.ClientResponseError as err:
DIAGNOSTICS.increment(f"{label}.response_error")
error_detail.insert(0, "RTSPtoWeb server failure")
error_detail.append(err.message)
raise ResponseError(": ".join(error_detail)) from err
DIAGNOSTICS.increment(f"{label}.success")
_LOGGER.debug("response %s", resp)
return resp
async def _get_payload(self, resp: aiohttp.ClientResponse) -> Any:
"""Return payload from the response."""
try:
result = await resp.json()
except aiohttp.ClientResponseError as err:
DIAGNOSTICS.increment("decode_failure")
raise ResponseError("RTSPtoWeb server response decode error: ", str(err))
if DATA_STATUS not in result:
raise ResponseError(f"RTSPtoWeb server missing status: {result}")
if str(result[DATA_STATUS]) != StatusCode.SUCCESS.value:
raise ResponseError(f"RTSPtoWeb server failure: {result}")
if DATA_PAYLOAD not in result:
raise ResponseError(f"RTSPtoWeb server missing payload: {result}")
return result[DATA_PAYLOAD]
async def _get_dict(self, resp: aiohttp.ClientResponse) -> dict[str, Any]:
"""Return payload from the response."""
payload = await self._get_payload(resp)
if not isinstance(payload, dict):
DIAGNOSTICS.increment("malformed_payload")
raise ResponseError(
f"RTSPtoWeb server returned malformed payload: {payload}"
)
return cast(Dict[str, Any], payload)
def _request_url(self, path: str) -> str:
"""Return a request url for the specific path."""
if not self._base_url:
return path
return urljoin(self._base_url, path)
@staticmethod
async def _error_detail(resp: aiohttp.ClientResponse) -> List[str]:
"""Returns an error message string from the API response."""
if resp.status < 400:
return []
try:
result = await resp.json()
if DATA_PAYLOAD in result:
return [result[DATA_PAYLOAD]]
except aiohttp.ClientError:
return []
return []
|
