]>
Commit | Line | Data |
---|---|---|
1 | import { readdir, readFile } from 'fs-extra' | |
2 | import { createServer, Server } from 'net' | |
3 | import { join } from 'path' | |
4 | import { createServer as createServerTLS, Server as ServerTLS } from 'tls' | |
5 | import { | |
6 | computeResolutionsToTranscode, | |
7 | ffprobePromise, | |
8 | getLiveSegmentTime, | |
9 | getVideoStreamBitrate, | |
10 | getVideoStreamDimensionsInfo, | |
11 | getVideoStreamFPS, | |
12 | hasAudioStream | |
13 | } from '@server/helpers/ffmpeg' | |
14 | import { logger, loggerTagsFactory } from '@server/helpers/logger' | |
15 | import { CONFIG, registerConfigChangedHandler } from '@server/initializers/config' | |
16 | import { P2P_MEDIA_LOADER_PEER_VERSION, VIDEO_LIVE } from '@server/initializers/constants' | |
17 | import { UserModel } from '@server/models/user/user' | |
18 | import { VideoModel } from '@server/models/video/video' | |
19 | import { VideoLiveModel } from '@server/models/video/video-live' | |
20 | import { VideoLiveSessionModel } from '@server/models/video/video-live-session' | |
21 | import { VideoStreamingPlaylistModel } from '@server/models/video/video-streaming-playlist' | |
22 | import { MStreamingPlaylistVideo, MVideo, MVideoLiveSession, MVideoLiveVideo } from '@server/types/models' | |
23 | import { pick, wait } from '@shared/core-utils' | |
24 | import { LiveVideoError, VideoState, VideoStorage, VideoStreamingPlaylistType } from '@shared/models' | |
25 | import { federateVideoIfNeeded } from '../activitypub/videos' | |
26 | import { JobQueue } from '../job-queue' | |
27 | import { generateHLSMasterPlaylistFilename, generateHlsSha256SegmentsFilename, getLiveReplayBaseDirectory } from '../paths' | |
28 | import { PeerTubeSocket } from '../peertube-socket' | |
29 | import { Hooks } from '../plugins/hooks' | |
30 | import { LiveQuotaStore } from './live-quota-store' | |
31 | import { cleanupAndDestroyPermanentLive } from './live-utils' | |
32 | import { MuxingSession } from './shared' | |
33 | ||
34 | const NodeRtmpSession = require('node-media-server/src/node_rtmp_session') | |
35 | const context = require('node-media-server/src/node_core_ctx') | |
36 | const nodeMediaServerLogger = require('node-media-server/src/node_core_logger') | |
37 | ||
38 | // Disable node media server logs | |
39 | nodeMediaServerLogger.setLogType(0) | |
40 | ||
41 | const config = { | |
42 | rtmp: { | |
43 | port: CONFIG.LIVE.RTMP.PORT, | |
44 | chunk_size: VIDEO_LIVE.RTMP.CHUNK_SIZE, | |
45 | gop_cache: VIDEO_LIVE.RTMP.GOP_CACHE, | |
46 | ping: VIDEO_LIVE.RTMP.PING, | |
47 | ping_timeout: VIDEO_LIVE.RTMP.PING_TIMEOUT | |
48 | } | |
49 | } | |
50 | ||
51 | const lTags = loggerTagsFactory('live') | |
52 | ||
53 | class LiveManager { | |
54 | ||
55 | private static instance: LiveManager | |
56 | ||
57 | private readonly muxingSessions = new Map<string, MuxingSession>() | |
58 | private readonly videoSessions = new Map<number, string>() | |
59 | ||
60 | private rtmpServer: Server | |
61 | private rtmpsServer: ServerTLS | |
62 | ||
63 | private running = false | |
64 | ||
65 | private constructor () { | |
66 | } | |
67 | ||
68 | init () { | |
69 | const events = this.getContext().nodeEvent | |
70 | events.on('postPublish', (sessionId: string, streamPath: string) => { | |
71 | logger.debug('RTMP received stream', { id: sessionId, streamPath, ...lTags(sessionId) }) | |
72 | ||
73 | const splittedPath = streamPath.split('/') | |
74 | if (splittedPath.length !== 3 || splittedPath[1] !== VIDEO_LIVE.RTMP.BASE_PATH) { | |
75 | logger.warn('Live path is incorrect.', { streamPath, ...lTags(sessionId) }) | |
76 | return this.abortSession(sessionId) | |
77 | } | |
78 | ||
79 | const session = this.getContext().sessions.get(sessionId) | |
80 | ||
81 | this.handleSession(sessionId, session.inputOriginUrl + streamPath, splittedPath[2]) | |
82 | .catch(err => logger.error('Cannot handle sessions.', { err, ...lTags(sessionId) })) | |
83 | }) | |
84 | ||
85 | events.on('donePublish', sessionId => { | |
86 | logger.info('Live session ended.', { sessionId, ...lTags(sessionId) }) | |
87 | }) | |
88 | ||
89 | registerConfigChangedHandler(() => { | |
90 | if (!this.running && CONFIG.LIVE.ENABLED === true) { | |
91 | this.run().catch(err => logger.error('Cannot run live server.', { err })) | |
92 | return | |
93 | } | |
94 | ||
95 | if (this.running && CONFIG.LIVE.ENABLED === false) { | |
96 | this.stop() | |
97 | } | |
98 | }) | |
99 | ||
100 | // Cleanup broken lives, that were terminated by a server restart for example | |
101 | this.handleBrokenLives() | |
102 | .catch(err => logger.error('Cannot handle broken lives.', { err, ...lTags() })) | |
103 | } | |
104 | ||
105 | async run () { | |
106 | this.running = true | |
107 | ||
108 | if (CONFIG.LIVE.RTMP.ENABLED) { | |
109 | logger.info('Running RTMP server on port %d', CONFIG.LIVE.RTMP.PORT, lTags()) | |
110 | ||
111 | this.rtmpServer = createServer(socket => { | |
112 | const session = new NodeRtmpSession(config, socket) | |
113 | ||
114 | session.inputOriginUrl = 'rtmp://127.0.0.1:' + CONFIG.LIVE.RTMP.PORT | |
115 | session.run() | |
116 | }) | |
117 | ||
118 | this.rtmpServer.on('error', err => { | |
119 | logger.error('Cannot run RTMP server.', { err, ...lTags() }) | |
120 | }) | |
121 | ||
122 | this.rtmpServer.listen(CONFIG.LIVE.RTMP.PORT, CONFIG.LIVE.RTMP.HOSTNAME) | |
123 | } | |
124 | ||
125 | if (CONFIG.LIVE.RTMPS.ENABLED) { | |
126 | logger.info('Running RTMPS server on port %d', CONFIG.LIVE.RTMPS.PORT, lTags()) | |
127 | ||
128 | const [ key, cert ] = await Promise.all([ | |
129 | readFile(CONFIG.LIVE.RTMPS.KEY_FILE), | |
130 | readFile(CONFIG.LIVE.RTMPS.CERT_FILE) | |
131 | ]) | |
132 | const serverOptions = { key, cert } | |
133 | ||
134 | this.rtmpsServer = createServerTLS(serverOptions, socket => { | |
135 | const session = new NodeRtmpSession(config, socket) | |
136 | ||
137 | session.inputOriginUrl = 'rtmps://127.0.0.1:' + CONFIG.LIVE.RTMPS.PORT | |
138 | session.run() | |
139 | }) | |
140 | ||
141 | this.rtmpsServer.on('error', err => { | |
142 | logger.error('Cannot run RTMPS server.', { err, ...lTags() }) | |
143 | }) | |
144 | ||
145 | this.rtmpsServer.listen(CONFIG.LIVE.RTMPS.PORT, CONFIG.LIVE.RTMPS.HOSTNAME) | |
146 | } | |
147 | } | |
148 | ||
149 | stop () { | |
150 | this.running = false | |
151 | ||
152 | if (this.rtmpServer) { | |
153 | logger.info('Stopping RTMP server.', lTags()) | |
154 | ||
155 | this.rtmpServer.close() | |
156 | this.rtmpServer = undefined | |
157 | } | |
158 | ||
159 | if (this.rtmpsServer) { | |
160 | logger.info('Stopping RTMPS server.', lTags()) | |
161 | ||
162 | this.rtmpsServer.close() | |
163 | this.rtmpsServer = undefined | |
164 | } | |
165 | ||
166 | // Sessions is an object | |
167 | this.getContext().sessions.forEach((session: any) => { | |
168 | if (session instanceof NodeRtmpSession) { | |
169 | session.stop() | |
170 | } | |
171 | }) | |
172 | } | |
173 | ||
174 | isRunning () { | |
175 | return !!this.rtmpServer | |
176 | } | |
177 | ||
178 | stopSessionOf (videoId: number, error: LiveVideoError | null) { | |
179 | const sessionId = this.videoSessions.get(videoId) | |
180 | if (!sessionId) return | |
181 | ||
182 | this.saveEndingSession(videoId, error) | |
183 | .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) })) | |
184 | ||
185 | this.videoSessions.delete(videoId) | |
186 | this.abortSession(sessionId) | |
187 | } | |
188 | ||
189 | private getContext () { | |
190 | return context | |
191 | } | |
192 | ||
193 | private abortSession (sessionId: string) { | |
194 | const session = this.getContext().sessions.get(sessionId) | |
195 | if (session) { | |
196 | session.stop() | |
197 | this.getContext().sessions.delete(sessionId) | |
198 | } | |
199 | ||
200 | const muxingSession = this.muxingSessions.get(sessionId) | |
201 | if (muxingSession) { | |
202 | // Muxing session will fire and event so we correctly cleanup the session | |
203 | muxingSession.abort() | |
204 | ||
205 | this.muxingSessions.delete(sessionId) | |
206 | } | |
207 | } | |
208 | ||
209 | private async handleSession (sessionId: string, inputUrl: string, streamKey: string) { | |
210 | const videoLive = await VideoLiveModel.loadByStreamKey(streamKey) | |
211 | if (!videoLive) { | |
212 | logger.warn('Unknown live video with stream key %s.', streamKey, lTags(sessionId)) | |
213 | return this.abortSession(sessionId) | |
214 | } | |
215 | ||
216 | const video = videoLive.Video | |
217 | if (video.isBlacklisted()) { | |
218 | logger.warn('Video is blacklisted. Refusing stream %s.', streamKey, lTags(sessionId, video.uuid)) | |
219 | return this.abortSession(sessionId) | |
220 | } | |
221 | ||
222 | // Cleanup old potential live (could happen with a permanent live) | |
223 | const oldStreamingPlaylist = await VideoStreamingPlaylistModel.loadHLSPlaylistByVideo(video.id) | |
224 | if (oldStreamingPlaylist) { | |
225 | if (!videoLive.permanentLive) throw new Error('Found previous session in a non permanent live: ' + video.uuid) | |
226 | ||
227 | await cleanupAndDestroyPermanentLive(video, oldStreamingPlaylist) | |
228 | } | |
229 | ||
230 | this.videoSessions.set(video.id, sessionId) | |
231 | ||
232 | const now = Date.now() | |
233 | const probe = await ffprobePromise(inputUrl) | |
234 | ||
235 | const [ { resolution, ratio }, fps, bitrate, hasAudio ] = await Promise.all([ | |
236 | getVideoStreamDimensionsInfo(inputUrl, probe), | |
237 | getVideoStreamFPS(inputUrl, probe), | |
238 | getVideoStreamBitrate(inputUrl, probe), | |
239 | hasAudioStream(inputUrl, probe) | |
240 | ]) | |
241 | ||
242 | logger.info( | |
243 | '%s probing took %d ms (bitrate: %d, fps: %d, resolution: %d)', | |
244 | inputUrl, Date.now() - now, bitrate, fps, resolution, lTags(sessionId, video.uuid) | |
245 | ) | |
246 | ||
247 | const allResolutions = await Hooks.wrapObject( | |
248 | this.buildAllResolutionsToTranscode(resolution, hasAudio), | |
249 | 'filter:transcoding.auto.resolutions-to-transcode.result', | |
250 | { video } | |
251 | ) | |
252 | ||
253 | logger.info( | |
254 | 'Will mux/transcode live video of original resolution %d.', resolution, | |
255 | { allResolutions, ...lTags(sessionId, video.uuid) } | |
256 | ) | |
257 | ||
258 | const streamingPlaylist = await this.createLivePlaylist(video, allResolutions) | |
259 | ||
260 | return this.runMuxingSession({ | |
261 | sessionId, | |
262 | videoLive, | |
263 | ||
264 | streamingPlaylist, | |
265 | inputUrl, | |
266 | fps, | |
267 | bitrate, | |
268 | ratio, | |
269 | allResolutions, | |
270 | hasAudio | |
271 | }) | |
272 | } | |
273 | ||
274 | private async runMuxingSession (options: { | |
275 | sessionId: string | |
276 | videoLive: MVideoLiveVideo | |
277 | ||
278 | streamingPlaylist: MStreamingPlaylistVideo | |
279 | inputUrl: string | |
280 | fps: number | |
281 | bitrate: number | |
282 | ratio: number | |
283 | allResolutions: number[] | |
284 | hasAudio: boolean | |
285 | }) { | |
286 | const { sessionId, videoLive } = options | |
287 | const videoUUID = videoLive.Video.uuid | |
288 | const localLTags = lTags(sessionId, videoUUID) | |
289 | ||
290 | const liveSession = await this.saveStartingSession(videoLive) | |
291 | ||
292 | const user = await UserModel.loadByLiveId(videoLive.id) | |
293 | LiveQuotaStore.Instance.addNewLive(user.id, videoLive.id) | |
294 | ||
295 | const muxingSession = new MuxingSession({ | |
296 | context: this.getContext(), | |
297 | sessionId, | |
298 | videoLive, | |
299 | user, | |
300 | ||
301 | ...pick(options, [ 'streamingPlaylist', 'inputUrl', 'bitrate', 'ratio', 'fps', 'allResolutions', 'hasAudio' ]) | |
302 | }) | |
303 | ||
304 | muxingSession.on('live-ready', () => this.publishAndFederateLive(videoLive, localLTags)) | |
305 | ||
306 | muxingSession.on('bad-socket-health', ({ videoId }) => { | |
307 | logger.error( | |
308 | 'Too much data in client socket stream (ffmpeg is too slow to transcode the video).' + | |
309 | ' Stopping session of video %s.', videoUUID, | |
310 | localLTags | |
311 | ) | |
312 | ||
313 | this.stopSessionOf(videoId, LiveVideoError.BAD_SOCKET_HEALTH) | |
314 | }) | |
315 | ||
316 | muxingSession.on('duration-exceeded', ({ videoId }) => { | |
317 | logger.info('Stopping session of %s: max duration exceeded.', videoUUID, localLTags) | |
318 | ||
319 | this.stopSessionOf(videoId, LiveVideoError.DURATION_EXCEEDED) | |
320 | }) | |
321 | ||
322 | muxingSession.on('quota-exceeded', ({ videoId }) => { | |
323 | logger.info('Stopping session of %s: user quota exceeded.', videoUUID, localLTags) | |
324 | ||
325 | this.stopSessionOf(videoId, LiveVideoError.QUOTA_EXCEEDED) | |
326 | }) | |
327 | ||
328 | muxingSession.on('ffmpeg-error', ({ videoId }) => { | |
329 | this.stopSessionOf(videoId, LiveVideoError.FFMPEG_ERROR) | |
330 | }) | |
331 | ||
332 | muxingSession.on('ffmpeg-end', ({ videoId }) => { | |
333 | this.onMuxingFFmpegEnd(videoId, sessionId) | |
334 | }) | |
335 | ||
336 | muxingSession.on('after-cleanup', ({ videoId }) => { | |
337 | this.muxingSessions.delete(sessionId) | |
338 | ||
339 | LiveQuotaStore.Instance.removeLive(user.id, videoLive.id) | |
340 | ||
341 | muxingSession.destroy() | |
342 | ||
343 | return this.onAfterMuxingCleanup({ videoId, liveSession }) | |
344 | .catch(err => logger.error('Error in end transmuxing.', { err, ...localLTags })) | |
345 | }) | |
346 | ||
347 | this.muxingSessions.set(sessionId, muxingSession) | |
348 | ||
349 | muxingSession.runMuxing() | |
350 | .catch(err => { | |
351 | logger.error('Cannot run muxing.', { err, ...localLTags }) | |
352 | this.abortSession(sessionId) | |
353 | }) | |
354 | } | |
355 | ||
356 | private async publishAndFederateLive (live: MVideoLiveVideo, localLTags: { tags: string[] }) { | |
357 | const videoId = live.videoId | |
358 | ||
359 | try { | |
360 | const video = await VideoModel.loadFull(videoId) | |
361 | ||
362 | logger.info('Will publish and federate live %s.', video.url, localLTags) | |
363 | ||
364 | video.state = VideoState.PUBLISHED | |
365 | video.publishedAt = new Date() | |
366 | await video.save() | |
367 | ||
368 | live.Video = video | |
369 | ||
370 | await wait(getLiveSegmentTime(live.latencyMode) * 1000 * VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION) | |
371 | ||
372 | try { | |
373 | await federateVideoIfNeeded(video, false) | |
374 | } catch (err) { | |
375 | logger.error('Cannot federate live video %s.', video.url, { err, ...localLTags }) | |
376 | } | |
377 | ||
378 | PeerTubeSocket.Instance.sendVideoLiveNewState(video) | |
379 | } catch (err) { | |
380 | logger.error('Cannot save/federate live video %d.', videoId, { err, ...localLTags }) | |
381 | } | |
382 | } | |
383 | ||
384 | private onMuxingFFmpegEnd (videoId: number, sessionId: string) { | |
385 | this.videoSessions.delete(videoId) | |
386 | ||
387 | this.saveEndingSession(videoId, null) | |
388 | .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) })) | |
389 | } | |
390 | ||
391 | private async onAfterMuxingCleanup (options: { | |
392 | videoId: number | string | |
393 | liveSession?: MVideoLiveSession | |
394 | cleanupNow?: boolean // Default false | |
395 | }) { | |
396 | const { videoId, liveSession: liveSessionArg, cleanupNow = false } = options | |
397 | ||
398 | try { | |
399 | const fullVideo = await VideoModel.loadFull(videoId) | |
400 | if (!fullVideo) return | |
401 | ||
402 | const live = await VideoLiveModel.loadByVideoId(fullVideo.id) | |
403 | ||
404 | const liveSession = liveSessionArg ?? await VideoLiveSessionModel.findLatestSessionOf(fullVideo.id) | |
405 | ||
406 | // On server restart during a live | |
407 | if (!liveSession.endDate) { | |
408 | liveSession.endDate = new Date() | |
409 | await liveSession.save() | |
410 | } | |
411 | ||
412 | JobQueue.Instance.createJobAsync({ | |
413 | type: 'video-live-ending', | |
414 | payload: { | |
415 | videoId: fullVideo.id, | |
416 | ||
417 | replayDirectory: live.saveReplay | |
418 | ? await this.findReplayDirectory(fullVideo) | |
419 | : undefined, | |
420 | ||
421 | liveSessionId: liveSession.id, | |
422 | streamingPlaylistId: fullVideo.getHLSPlaylist()?.id, | |
423 | ||
424 | publishedAt: fullVideo.publishedAt.toISOString() | |
425 | }, | |
426 | ||
427 | delay: cleanupNow | |
428 | ? 0 | |
429 | : VIDEO_LIVE.CLEANUP_DELAY | |
430 | }) | |
431 | ||
432 | fullVideo.state = live.permanentLive | |
433 | ? VideoState.WAITING_FOR_LIVE | |
434 | : VideoState.LIVE_ENDED | |
435 | ||
436 | await fullVideo.save() | |
437 | ||
438 | PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo) | |
439 | ||
440 | await federateVideoIfNeeded(fullVideo, false) | |
441 | } catch (err) { | |
442 | logger.error('Cannot save/federate new video state of live streaming of video %d.', videoId, { err, ...lTags(videoId + '') }) | |
443 | } | |
444 | } | |
445 | ||
446 | private async handleBrokenLives () { | |
447 | const videoUUIDs = await VideoModel.listPublishedLiveUUIDs() | |
448 | ||
449 | for (const uuid of videoUUIDs) { | |
450 | await this.onAfterMuxingCleanup({ videoId: uuid, cleanupNow: true }) | |
451 | } | |
452 | } | |
453 | ||
454 | private async findReplayDirectory (video: MVideo) { | |
455 | const directory = getLiveReplayBaseDirectory(video) | |
456 | const files = await readdir(directory) | |
457 | ||
458 | if (files.length === 0) return undefined | |
459 | ||
460 | return join(directory, files.sort().reverse()[0]) | |
461 | } | |
462 | ||
463 | private buildAllResolutionsToTranscode (originResolution: number, hasAudio: boolean) { | |
464 | const includeInput = CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION | |
465 | ||
466 | const resolutionsEnabled = CONFIG.LIVE.TRANSCODING.ENABLED | |
467 | ? computeResolutionsToTranscode({ input: originResolution, type: 'live', includeInput, strictLower: false, hasAudio }) | |
468 | : [] | |
469 | ||
470 | if (resolutionsEnabled.length === 0) { | |
471 | return [ originResolution ] | |
472 | } | |
473 | ||
474 | return resolutionsEnabled | |
475 | } | |
476 | ||
477 | private async createLivePlaylist (video: MVideo, allResolutions: number[]): Promise<MStreamingPlaylistVideo> { | |
478 | const playlist = await VideoStreamingPlaylistModel.loadOrGenerate(video) | |
479 | ||
480 | playlist.playlistFilename = generateHLSMasterPlaylistFilename(true) | |
481 | playlist.segmentsSha256Filename = generateHlsSha256SegmentsFilename(true) | |
482 | ||
483 | playlist.p2pMediaLoaderPeerVersion = P2P_MEDIA_LOADER_PEER_VERSION | |
484 | playlist.type = VideoStreamingPlaylistType.HLS | |
485 | ||
486 | playlist.assignP2PMediaLoaderInfoHashes(video, allResolutions) | |
487 | ||
488 | playlist.storage = CONFIG.OBJECT_STORAGE.ENABLED | |
489 | ? VideoStorage.OBJECT_STORAGE | |
490 | : VideoStorage.FILE_SYSTEM | |
491 | ||
492 | return playlist.save() | |
493 | } | |
494 | ||
495 | private saveStartingSession (videoLive: MVideoLiveVideo) { | |
496 | const liveSession = new VideoLiveSessionModel({ | |
497 | startDate: new Date(), | |
498 | liveVideoId: videoLive.videoId, | |
499 | saveReplay: videoLive.saveReplay, | |
500 | endingProcessed: false | |
501 | }) | |
502 | ||
503 | return liveSession.save() | |
504 | } | |
505 | ||
506 | private async saveEndingSession (videoId: number, error: LiveVideoError | null) { | |
507 | const liveSession = await VideoLiveSessionModel.findCurrentSessionOf(videoId) | |
508 | if (!liveSession) return | |
509 | ||
510 | liveSession.endDate = new Date() | |
511 | liveSession.error = error | |
512 | ||
513 | return liveSession.save() | |
514 | } | |
515 | ||
516 | static get Instance () { | |
517 | return this.instance || (this.instance = new this()) | |
518 | } | |
519 | } | |
520 | ||
521 | // --------------------------------------------------------------------------- | |
522 | ||
523 | export { | |
524 | LiveManager | |
525 | } |