-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathustreamtv.py
More file actions
581 lines (488 loc) · 19.3 KB
/
Copy pathustreamtv.py
File metadata and controls
581 lines (488 loc) · 19.3 KB
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
"""
$description Global live-streaming and video on-demand platform owned by IBM.
$url ustream.tv
$url video.ibm.com
$type live, vod
"""
from __future__ import annotations
import re
from collections import deque
from dataclasses import dataclass
from datetime import datetime, timedelta, timezone
from random import randint
from threading import Event, RLock
from typing import TYPE_CHECKING, Any
from urllib.parse import urljoin, urlunparse
from requests import Response
from streamlink.exceptions import PluginError, StreamError
from streamlink.logger import getLogger
from streamlink.plugin import Plugin, pluginargument, pluginmatcher
from streamlink.plugin.api import useragents, validate
from streamlink.plugin.api.websocket import WebsocketClient
from streamlink.stream.ffmpegmux import MuxedStream
from streamlink.stream.segmented import Segment, SegmentedStreamReader, SegmentedStreamWorker, SegmentedStreamWriter
from streamlink.stream.stream import Stream
from streamlink.utils.parse import parse_json
if TYPE_CHECKING:
from collections.abc import Callable, Mapping
log = getLogger(__name__)
@dataclass
class _StreamFormat:
contentType: str
sourceStreamVersion: int
initUrl: str
segmentUrl: str
bitrate: int
@dataclass
class StreamFormatVideo(_StreamFormat):
height: int
@dataclass
class StreamFormatAudio(_StreamFormat):
language: str = ""
@dataclass
class UStreamTVSegment(Segment):
available_at: datetime
hash: str
path: str
# the segment URLs depend on the CDN and the chosen stream format and its segment template string
def url(self, base: str | None, template: str) -> str:
return urljoin(
base or "",
f"{self.path}/{template.replace('%', str(self.num), 1).replace('%', self.hash, 1)}",
)
class UStreamTVWsClient(WebsocketClient):
API_URL = "wss://r{0}-1-{1}-{2}-ws-{3}.ums.services.video.ibm.com/1/ustream"
APP_ID = 3
APP_VERSION = 2
STREAM_OPENED_TIMEOUT = 6
_schema_cmd = validate.Schema({
"cmd": str,
"args": [{str: object}],
})
_schema_stream_formats = validate.Schema({
"streams": [
validate.any(
validate.all(
{
"contentType": "video/mp4",
"sourceStreamVersion": int,
"initUrl": str,
"segmentUrl": str,
"bitrate": int,
"height": int,
},
validate.transform(lambda obj: StreamFormatVideo(**obj)),
),
validate.all(
{
"contentType": "audio/mp4",
"sourceStreamVersion": int,
"initUrl": str,
"segmentUrl": str,
"bitrate": int,
validate.optional("language"): str,
},
validate.transform(lambda obj: StreamFormatAudio(**obj)),
),
object,
),
],
})
_schema_stream_segments = validate.Schema({
"chunkId": int,
"chunkTime": int,
"contentAccess": validate.all(
{
"accessList": [
{
"data": {
"path": str,
},
},
],
},
validate.get(("accessList", 0, "data", "path")),
),
"hashes": {validate.transform(int): str},
})
stream_cdn: str | None = None
stream_formats_video: list[StreamFormatVideo] | None = None
stream_formats_audio: list[StreamFormatAudio] | None = None
stream_initial_id: int | None = None
def __init__(
self,
session,
media_id,
application,
referrer=None,
cluster="live",
password=None,
app_id=APP_ID,
app_version=APP_VERSION,
) -> None:
self.opened = Event()
self.ready = Event()
self.stream_error = None
# a list of deques subscribed by worker threads which independently need to read segments
self.stream_segments_subscribers: list[deque[UStreamTVSegment]] = []
self.stream_segments_initial: deque[UStreamTVSegment] = deque()
self.stream_segments_lock = RLock()
self.media_id = media_id
self.application = application
self.referrer = referrer
self.cluster = cluster
self.password = password
self.app_id = app_id
self.app_version = app_version
super().__init__(session, self._get_url(), origin="https://www.ustream.tv")
def _get_url(self):
return self.API_URL.format(randint(0, 0xFFFFFF), self.media_id, self.application, self.cluster)
def _set_error(self, error: Any):
self.stream_error = error
self.ready.set()
def _set_ready(self):
if not self.ready.is_set() and self.stream_cdn and self.stream_initial_id is not None:
self.ready.set()
if self.opened.wait(self.STREAM_OPENED_TIMEOUT):
log.debug("Stream opened, keeping websocket connection alive")
else:
log.info("Closing websocket connection")
self.ws.close()
def segments_subscribe(self) -> deque[UStreamTVSegment]:
with self.stream_segments_lock:
# copy the initial segments deque (segments arrive early)
new_deque = self.stream_segments_initial.copy()
self.stream_segments_subscribers.append(new_deque)
return new_deque
def _segments_append(self, segment: UStreamTVSegment):
# if there are no subscribers yet, add segment(s) to the initial deque
if not self.stream_segments_subscribers:
self.stream_segments_initial.append(segment)
else:
for subscriber_deque in self.stream_segments_subscribers:
subscriber_deque.append(segment)
def on_open(self, wsapp):
args = {
"type": "viewer",
"appId": self.app_id,
"appVersion": self.app_version,
"rsid": f"{randint(0, 10_000_000_000):x}:{randint(0, 10_000_000_000):x}",
"rpin": f"_rpin.{randint(0, 1_000_000_000_000_000)}",
"referrer": self.referrer,
"clusterHost": "r%rnd%-1-%mediaId%-%mediaType%-%protocolPrefix%-%cluster%.ums.ustream.tv",
"media": self.media_id,
"application": self.application,
}
if self.password:
args["password"] = self.password
self.send_json({
"cmd": "connect",
"args": [args],
})
def on_message(self, wsapp, data: str):
try:
parsed = parse_json(data, schema=self._schema_cmd)
except PluginError:
log.error(f"Could not parse message: {data[:50]}")
return
cmd: str = parsed["cmd"]
args: list[dict] = parsed["args"]
log.trace("Received '%s' command", cmd)
log.trace("%r", args)
handlers = self._MESSAGE_HANDLERS.get(cmd)
if handlers is not None:
for arg in args:
for name, handler in handlers.items():
argdata = arg.get(name)
if argdata is not None:
log.debug(f"Processing '{cmd}' - '{name}'")
handler(self, argdata)
# noinspection PyMethodMayBeStatic
def _handle_warning(self, data: dict):
log.warning(f"{data['code']}: {str(data['message'])[:50]}")
# noinspection PyUnusedLocal
def _handle_reject_nonexistent(self, *args):
self._set_error("This channel does not exist")
# noinspection PyUnusedLocal
def _handle_reject_geo_lock(self, *args):
self._set_error("This content is not available in your area")
def _handle_reject_cluster(self, arg: dict):
self.cluster = arg["name"]
log.info(f"Switching cluster to: {self.cluster}")
self.reconnect(url=self._get_url())
def _handle_reject_referrer_lock(self, arg: dict):
self.referrer = arg["redirectUrl"]
log.info(f"Updating referrer to: {self.referrer}")
self.reconnect(url=self._get_url())
def _handle_module_info_cdn_config(self, data: dict):
self.stream_cdn = urlunparse((
data["protocol"],
data["data"][0]["data"][0]["sites"][0]["host"],
data["data"][0]["data"][0]["sites"][0]["path"],
"",
"",
"",
))
self._set_ready()
def _handle_module_info_stream(self, data: dict):
if data.get("contentAvailable") is False:
return self._set_error("This stream is currently offline")
mp4_segmented = data.get("streamFormats", {}).get("mp4/segmented")
if not mp4_segmented:
return
# parse the stream formats once
if self.stream_initial_id is None:
try:
formats = self._schema_stream_formats.validate(mp4_segmented)
formats = formats["streams"]
except PluginError as err:
return self._set_error(err)
self.stream_formats_video = list(filter(lambda f: type(f) is StreamFormatVideo, formats))
self.stream_formats_audio = list(filter(lambda f: type(f) is StreamFormatAudio, formats))
# parse segment duration and hashes, and queue new segments
try:
segmentdata: dict = self._schema_stream_segments.validate(mp4_segmented)
except PluginError:
log.error("Failed parsing hashes")
return
current_id: int = segmentdata["chunkId"]
duration: int = segmentdata["chunkTime"]
path: str = segmentdata["contentAccess"]
hashes: dict[int, str] = segmentdata["hashes"]
sorted_ids = sorted(hashes.keys())
count = len(sorted_ids)
if count == 0:
return
# initial segment ID (needed by the workers to filter queued segments)
if self.stream_initial_id is None:
self.stream_initial_id = current_id
current_time = datetime.now(timezone.utc)
# lock the stream segments deques for the worker threads
with self.stream_segments_lock:
# interpolate and extrapolate segments from the provided id->hash data
diff = 10 - sorted_ids[0] % 10 # if there's only one id->hash item, extrapolate until the next decimal
for idx, segment_id in enumerate(sorted_ids):
idx_next = idx + 1
if idx_next < count:
# calculate the difference between IDs and use that to interpolate segment IDs
# the last id->hash item will use the previous diff to extrapolate segment IDs
diff = sorted_ids[idx_next] - segment_id
for num in range(segment_id, segment_id + diff):
self._segments_append(
UStreamTVSegment(
uri="",
num=num,
duration=duration,
available_at=current_time + timedelta(seconds=(num - current_id - 1) * duration / 1000),
hash=hashes[segment_id],
path=path,
),
)
self._set_ready()
# ----
_MESSAGE_HANDLERS: Mapping[str, Mapping[str, Callable[[UStreamTVWsClient, Any], None]]] = {
"warning": {
"code": _handle_warning,
},
"reject": {
"cluster": _handle_reject_cluster,
"referrerLock": _handle_reject_referrer_lock,
"nonexistent": _handle_reject_nonexistent,
"geoLock": _handle_reject_geo_lock,
},
"moduleInfo": {
"cdnConfig": _handle_module_info_cdn_config,
"stream": _handle_module_info_stream,
},
}
class UStreamTVStreamWriter(SegmentedStreamWriter[UStreamTVSegment, Response]):
reader: UStreamTVStreamReader
stream: UStreamTVStream
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._has_init = False
def put(self, segment):
if self.closed: # pragma: no cover
return
if segment is None:
self.queue(None, None)
else:
if not self._has_init:
self._has_init = True
self.queue(segment, self.executor.submit(self.fetch, segment, True))
self.queue(segment, self.executor.submit(self.fetch, segment, False))
# noinspection PyMethodOverriding
def fetch(self, segment: UStreamTVSegment, is_init: bool): # type: ignore[override, ty:invalid-method-override]
if self.closed: # pragma: no cover
return
now = datetime.now(timezone.utc)
if segment.available_at > now:
time_to_wait = (segment.available_at - now).total_seconds()
log.debug(f"Waiting for {self.stream.kind} segment: {segment.num} ({time_to_wait:.01f}s)")
if not self.reader.worker.wait(time_to_wait):
return
try:
return self.session.http.get(
segment.url(
self.stream.wsclient.stream_cdn,
self.stream.stream_format.initUrl if is_init else self.stream.stream_format.segmentUrl,
),
timeout=self.timeout,
retries=self.retries,
exception=StreamError,
)
except StreamError as err:
log.error(f"Failed to fetch {self.stream.kind} segment {segment.num}: {err}")
def write(self, segment: UStreamTVSegment, result: Response, *data):
if self.closed: # pragma: no cover
return
try:
for chunk in result.iter_content(8192):
self.reader.buffer.write(chunk)
log.debug(f"Download of {self.stream.kind} segment {segment.num} complete")
except OSError as err:
log.error(f"Failed to read {self.stream.kind} segment {segment.num}: {err}")
class UStreamTVStreamWorker(SegmentedStreamWorker[UStreamTVSegment, Response]):
reader: UStreamTVStreamReader
writer: UStreamTVStreamWriter
stream: UStreamTVStream
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.wsclient = self.stream.wsclient
self.sequence = self.wsclient.stream_initial_id or -1
self.queue = self.wsclient.segments_subscribe()
def iter_segments(self):
duration = 5000
while not self.closed:
try:
with self.wsclient.stream_segments_lock:
segment = self.queue.popleft()
duration = segment.duration
except IndexError:
# wait for new segments to be queued (half the last segment's duration in seconds)
if self.wait(duration / 1000 / 2):
continue
if self.closed:
return
if segment.num < self.sequence:
continue
log.debug(f"Adding {self.stream.kind} segment {segment.num} to queue")
yield segment
self.sequence = segment.num + 1
class UStreamTVStreamReader(SegmentedStreamReader[UStreamTVSegment, Response]):
__worker__ = UStreamTVStreamWorker
__writer__ = UStreamTVStreamWriter
stream: UStreamTVStream
worker: UStreamTVStreamWorker
writer: UStreamTVStreamWriter
def open(self):
self.stream.wsclient.opened.set()
super().open()
def close(self):
super().close()
self.stream.wsclient.close()
class UStreamTVStream(Stream):
__shortname__ = "ustreamtv"
def __init__(
self,
session,
kind: str,
wsclient: UStreamTVWsClient,
stream_format: StreamFormatVideo | StreamFormatAudio,
):
super().__init__(session)
self.kind = kind
self.wsclient = wsclient
self.stream_format = stream_format
def open(self):
reader = UStreamTVStreamReader(self)
reader.open()
return reader
@pluginmatcher(
re.compile(
r"""
https?://(?:(?:www\.)?ustream\.tv|video\.ibm\.com)
(?:
/combined-embed
/(?P<combined_channel_id>\d+)
(?:/video/(?P<combined_video_id>\d+))?
|
(?:(?:/embed/|/channel/(?:id/)?)(?P<channel_id>\d+))?
(?:(?:/embed)?/recorded/(?P<video_id>\d+))?
)
""",
re.VERBOSE,
),
)
@pluginargument(
"password",
sensitive=True,
argument_name="ustream-password",
metavar="PASSWORD",
help="A password to access password protected UStream.tv channels.",
)
class UStreamTV(Plugin):
STREAM_READY_TIMEOUT = 15
def _get_media_app(self):
video_id = self.match.group("video_id") or self.match.group("combined_video_id")
if video_id:
return video_id, "recorded"
channel_id = self.match.group("channel_id") or self.match.group("combined_channel_id")
if not channel_id:
channel_id = self.session.http.get(
self.url,
headers={"User-Agent": useragents.CHROME},
schema=validate.Schema(
validate.parse_html(),
validate.xml_xpath_string(".//meta[@name='ustream:channel_id'][@content][1]/@content"),
),
)
return channel_id, "channel"
def _get_streams(self):
if not MuxedStream.is_usable(self.session):
return
media_id, application = self._get_media_app()
if not media_id:
return
wsclient = UStreamTVWsClient(
self.session,
media_id,
application,
referrer=self.url,
cluster="live",
password=self.get_option("password"),
)
log.debug(
"Connecting to UStream API: "
+ ", ".join([
f"media_id={media_id}",
f"application={application}",
f"referrer={self.url}",
f"cluster={'live'}",
]),
)
wsclient.start()
log.debug(f"Waiting for stream data (for at most {self.STREAM_READY_TIMEOUT} seconds)...")
if (
not wsclient.ready.wait(self.STREAM_READY_TIMEOUT)
or not wsclient.is_alive()
or wsclient.stream_error
): # fmt: skip
log.error(wsclient.stream_error or "Waiting for stream data timed out.")
wsclient.close()
return
if not wsclient.stream_formats_audio:
for video in wsclient.stream_formats_video or []:
yield f"{video.height}p", UStreamTVStream(self.session, "video", wsclient, video)
else:
for video in wsclient.stream_formats_video or []:
for audio in wsclient.stream_formats_audio:
yield (
f"{video.height}p+a{audio.bitrate}k",
MuxedStream(
self.session,
UStreamTVStream(self.session, "video", wsclient, video),
UStreamTVStream(self.session, "audio", wsclient, audio),
),
)
__plugin__ = UStreamTV