2 import { readdir, readFile } from 'fs-extra'
3 import { createServer, Server } from 'net'
4 import { join } from 'path'
5 import { createServer as createServerTLS, Server as ServerTLS } from 'tls'
7 computeResolutionsToTranscode,
10 getVideoStreamBitrate,
11 getVideoStreamDimensionsInfo,
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 { wait } from '@shared/core-utils'
24 import { LiveVideoError, VideoState, 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 { cleanupPermanentLive } from './live-utils'
32 import { MuxingSession } from './shared'
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')
38 // Disable node media server logs
39 nodeMediaServerLogger.setLogType(0)
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
51 const lTags = loggerTagsFactory('live')
55 private static instance: LiveManager
57 private readonly muxingSessions = new Map<string, MuxingSession>()
58 private readonly videoSessions = new Map<number, string>()
60 private rtmpServer: Server
61 private rtmpsServer: ServerTLS
63 private running = false
65 private constructor () {
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) })
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)
79 const session = this.getContext().sessions.get(sessionId)
81 this.handleSession(sessionId, session.inputOriginUrl + streamPath, splittedPath[2])
82 .catch(err => logger.error('Cannot handle sessions.', { err, ...lTags(sessionId) }))
85 events.on('donePublish', sessionId => {
86 logger.info('Live session ended.', { sessionId, ...lTags(sessionId) })
89 registerConfigChangedHandler(() => {
90 if (!this.running && CONFIG.LIVE.ENABLED === true) {
91 this.run().catch(err => logger.error('Cannot run live server.', { err }))
95 if (this.running && CONFIG.LIVE.ENABLED === false) {
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() }))
108 if (CONFIG.LIVE.RTMP.ENABLED) {
109 logger.info('Running RTMP server on port %d', CONFIG.LIVE.RTMP.PORT, lTags())
111 this.rtmpServer = createServer(socket => {
112 const session = new NodeRtmpSession(config, socket)
114 session.inputOriginUrl = 'rtmp://127.0.0.1:' + CONFIG.LIVE.RTMP.PORT
118 this.rtmpServer.on('error', err => {
119 logger.error('Cannot run RTMP server.', { err, ...lTags() })
122 this.rtmpServer.listen(CONFIG.LIVE.RTMP.PORT, CONFIG.LIVE.RTMP.HOSTNAME)
125 if (CONFIG.LIVE.RTMPS.ENABLED) {
126 logger.info('Running RTMPS server on port %d', CONFIG.LIVE.RTMPS.PORT, lTags())
128 const [ key, cert ] = await Promise.all([
129 readFile(CONFIG.LIVE.RTMPS.KEY_FILE),
130 readFile(CONFIG.LIVE.RTMPS.CERT_FILE)
132 const serverOptions = { key, cert }
134 this.rtmpsServer = createServerTLS(serverOptions, socket => {
135 const session = new NodeRtmpSession(config, socket)
137 session.inputOriginUrl = 'rtmps://127.0.0.1:' + CONFIG.LIVE.RTMPS.PORT
141 this.rtmpsServer.on('error', err => {
142 logger.error('Cannot run RTMPS server.', { err, ...lTags() })
145 this.rtmpsServer.listen(CONFIG.LIVE.RTMPS.PORT, CONFIG.LIVE.RTMPS.HOSTNAME)
152 if (this.rtmpServer) {
153 logger.info('Stopping RTMP server.', lTags())
155 this.rtmpServer.close()
156 this.rtmpServer = undefined
159 if (this.rtmpsServer) {
160 logger.info('Stopping RTMPS server.', lTags())
162 this.rtmpsServer.close()
163 this.rtmpsServer = undefined
166 // Sessions is an object
167 this.getContext().sessions.forEach((session: any) => {
168 if (session instanceof NodeRtmpSession) {
175 return !!this.rtmpServer
178 stopSessionOf (videoId: number, error: LiveVideoError | null) {
179 const sessionId = this.videoSessions.get(videoId)
180 if (!sessionId) return
182 this.saveEndingSession(videoId, error)
183 .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) }))
185 this.videoSessions.delete(videoId)
186 this.abortSession(sessionId)
189 private getContext () {
193 private abortSession (sessionId: string) {
194 const session = this.getContext().sessions.get(sessionId)
197 this.getContext().sessions.delete(sessionId)
200 const muxingSession = this.muxingSessions.get(sessionId)
202 // Muxing session will fire and event so we correctly cleanup the session
203 muxingSession.abort()
205 this.muxingSessions.delete(sessionId)
209 private async handleSession (sessionId: string, inputUrl: string, streamKey: string) {
210 const videoLive = await VideoLiveModel.loadByStreamKey(streamKey)
212 logger.warn('Unknown live video with stream key %s.', streamKey, lTags(sessionId))
213 return this.abortSession(sessionId)
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)
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)
227 await cleanupPermanentLive(video, oldStreamingPlaylist)
230 this.videoSessions.set(video.id, sessionId)
232 const now = Date.now()
233 const probe = await ffprobePromise(inputUrl)
235 const [ { resolution, ratio }, fps, bitrate ] = await Promise.all([
236 getVideoStreamDimensionsInfo(inputUrl, probe),
237 getVideoStreamFPS(inputUrl, probe),
238 getVideoStreamBitrate(inputUrl, probe)
242 '%s probing took %d ms (bitrate: %d, fps: %d, resolution: %d)',
243 inputUrl, Date.now() - now, bitrate, fps, resolution, lTags(sessionId, video.uuid)
246 const allResolutions = await Hooks.wrapObject(
247 this.buildAllResolutionsToTranscode(resolution),
248 'filter:transcoding.auto.lower-resolutions-to-transcode.result',
253 'Will mux/transcode live video of original resolution %d.', resolution,
254 { allResolutions, ...lTags(sessionId, video.uuid) }
257 const streamingPlaylist = await this.createLivePlaylist(video, allResolutions)
259 return this.runMuxingSession({
271 private async runMuxingSession (options: {
273 videoLive: MVideoLiveVideo
274 streamingPlaylist: MStreamingPlaylistVideo
279 allResolutions: number[]
281 const { sessionId, videoLive, streamingPlaylist, allResolutions, fps, bitrate, ratio, inputUrl } = options
282 const videoUUID = videoLive.Video.uuid
283 const localLTags = lTags(sessionId, videoUUID)
285 const liveSession = await this.saveStartingSession(videoLive)
287 const user = await UserModel.loadByLiveId(videoLive.id)
288 LiveQuotaStore.Instance.addNewLive(user.id, videoLive.id)
290 const muxingSession = new MuxingSession({
291 context: this.getContext(),
303 muxingSession.on('master-playlist-created', () => this.publishAndFederateLive(videoLive, localLTags))
305 muxingSession.on('bad-socket-health', ({ videoId }) => {
307 'Too much data in client socket stream (ffmpeg is too slow to transcode the video).' +
308 ' Stopping session of video %s.', videoUUID,
312 this.stopSessionOf(videoId, LiveVideoError.BAD_SOCKET_HEALTH)
315 muxingSession.on('duration-exceeded', ({ videoId }) => {
316 logger.info('Stopping session of %s: max duration exceeded.', videoUUID, localLTags)
318 this.stopSessionOf(videoId, LiveVideoError.DURATION_EXCEEDED)
321 muxingSession.on('quota-exceeded', ({ videoId }) => {
322 logger.info('Stopping session of %s: user quota exceeded.', videoUUID, localLTags)
324 this.stopSessionOf(videoId, LiveVideoError.QUOTA_EXCEEDED)
327 muxingSession.on('ffmpeg-error', ({ videoId }) => {
328 this.stopSessionOf(videoId, LiveVideoError.FFMPEG_ERROR)
331 muxingSession.on('ffmpeg-end', ({ videoId }) => {
332 this.onMuxingFFmpegEnd(videoId, sessionId)
335 muxingSession.on('after-cleanup', ({ videoId }) => {
336 this.muxingSessions.delete(sessionId)
338 LiveQuotaStore.Instance.removeLive(user.id, videoLive.id)
340 muxingSession.destroy()
342 return this.onAfterMuxingCleanup({ videoId, liveSession })
343 .catch(err => logger.error('Error in end transmuxing.', { err, ...localLTags }))
346 this.muxingSessions.set(sessionId, muxingSession)
348 muxingSession.runMuxing()
350 logger.error('Cannot run muxing.', { err, ...localLTags })
351 this.abortSession(sessionId)
355 private async publishAndFederateLive (live: MVideoLiveVideo, localLTags: { tags: string[] }) {
356 const videoId = live.videoId
359 const video = await VideoModel.loadFull(videoId)
361 logger.info('Will publish and federate live %s.', video.url, localLTags)
363 video.state = VideoState.PUBLISHED
364 video.publishedAt = new Date()
369 await wait(getLiveSegmentTime(live.latencyMode) * 1000 * VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION)
372 await federateVideoIfNeeded(video, false)
374 logger.error('Cannot federate live video %s.', video.url, { err, ...localLTags })
377 PeerTubeSocket.Instance.sendVideoLiveNewState(video)
379 logger.error('Cannot save/federate live video %d.', videoId, { err, ...localLTags })
383 private onMuxingFFmpegEnd (videoId: number, sessionId: string) {
384 this.videoSessions.delete(videoId)
386 this.saveEndingSession(videoId, null)
387 .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) }))
390 private async onAfterMuxingCleanup (options: {
391 videoId: number | string
392 liveSession?: MVideoLiveSession
393 cleanupNow?: boolean // Default false
395 const { videoId, liveSession: liveSessionArg, cleanupNow = false } = options
398 const fullVideo = await VideoModel.loadFull(videoId)
399 if (!fullVideo) return
401 const live = await VideoLiveModel.loadByVideoId(fullVideo.id)
403 const liveSession = liveSessionArg ?? await VideoLiveSessionModel.findLatestSessionOf(fullVideo.id)
405 // On server restart during a live
406 if (!liveSession.endDate) {
407 liveSession.endDate = new Date()
408 await liveSession.save()
411 JobQueue.Instance.createJob({
412 type: 'video-live-ending',
414 videoId: fullVideo.id,
416 replayDirectory: live.saveReplay
417 ? await this.findReplayDirectory(fullVideo)
420 liveSessionId: liveSession.id,
421 streamingPlaylistId: fullVideo.getHLSPlaylist()?.id,
423 publishedAt: fullVideo.publishedAt.toISOString()
425 }, { delay: cleanupNow ? 0 : VIDEO_LIVE.CLEANUP_DELAY })
427 fullVideo.state = live.permanentLive
428 ? VideoState.WAITING_FOR_LIVE
429 : VideoState.LIVE_ENDED
431 await fullVideo.save()
433 PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo)
435 await federateVideoIfNeeded(fullVideo, false)
437 logger.error('Cannot save/federate new video state of live streaming of video %d.', videoId, { err, ...lTags(videoId + '') })
441 private async handleBrokenLives () {
442 const videoUUIDs = await VideoModel.listPublishedLiveUUIDs()
444 for (const uuid of videoUUIDs) {
445 await this.onAfterMuxingCleanup({ videoId: uuid, cleanupNow: true })
449 private async findReplayDirectory (video: MVideo) {
450 const directory = getLiveReplayBaseDirectory(video)
451 const files = await readdir(directory)
453 if (files.length === 0) return undefined
455 return join(directory, files.sort().reverse()[0])
458 private buildAllResolutionsToTranscode (originResolution: number) {
459 const includeInputResolution = CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
461 const resolutionsEnabled = CONFIG.LIVE.TRANSCODING.ENABLED
462 ? computeResolutionsToTranscode({ inputResolution: originResolution, type: 'live', includeInputResolution })
465 if (resolutionsEnabled.length === 0) {
466 return [ originResolution ]
469 return resolutionsEnabled
472 private async createLivePlaylist (video: MVideo, allResolutions: number[]): Promise<MStreamingPlaylistVideo> {
473 const playlist = await VideoStreamingPlaylistModel.loadOrGenerate(video)
475 playlist.playlistFilename = generateHLSMasterPlaylistFilename(true)
476 playlist.segmentsSha256Filename = generateHlsSha256SegmentsFilename(true)
478 playlist.p2pMediaLoaderPeerVersion = P2P_MEDIA_LOADER_PEER_VERSION
479 playlist.type = VideoStreamingPlaylistType.HLS
481 playlist.assignP2PMediaLoaderInfoHashes(video, allResolutions)
483 return playlist.save()
486 private saveStartingSession (videoLive: MVideoLiveVideo) {
487 const liveSession = new VideoLiveSessionModel({
488 startDate: new Date(),
489 liveVideoId: videoLive.videoId,
490 saveReplay: videoLive.saveReplay,
491 endingProcessed: false
494 return liveSession.save()
497 private async saveEndingSession (videoId: number, error: LiveVideoError | null) {
498 const liveSession = await VideoLiveSessionModel.findCurrentSessionOf(videoId)
499 if (!liveSession) return
501 liveSession.endDate = new Date()
502 liveSession.error = error
504 return liveSession.save()
507 static get Instance () {
508 return this.instance || (this.instance = new this())
512 // ---------------------------------------------------------------------------