PeerTube/shared/extra-utils/videos/live.ts

232 lines
6.7 KiB
TypeScript
Raw Normal View History

2020-11-04 14:16:57 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import { expect } from 'chai'
2020-10-30 15:09:00 +01:00
import * as ffmpeg from 'fluent-ffmpeg'
2020-11-04 14:16:57 +01:00
import { pathExists, readdir } from 'fs-extra'
2020-11-03 15:33:30 +01:00
import { omit } from 'lodash'
2020-11-04 14:16:57 +01:00
import { join } from 'path'
2020-11-03 15:33:30 +01:00
import { LiveVideo, LiveVideoCreate, LiveVideoUpdate, VideoDetails, VideoState } from '@shared/models'
2020-12-09 14:42:42 +01:00
import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
2020-11-04 14:16:57 +01:00
import { buildAbsoluteFixturePath, buildServerDirectory, wait } from '../miscs/miscs'
2020-10-30 15:09:00 +01:00
import { makeGetRequest, makePutBodyRequest, makeUploadRequest } from '../requests/requests'
2020-12-09 14:42:42 +01:00
import { ServerInfo, waitUntilLog } from '../server/servers'
2020-11-02 15:43:44 +01:00
import { getVideoWithToken } from './videos'
2020-10-30 15:09:00 +01:00
function getLive (url: string, token: string, videoId: number | string, statusCodeExpected = HttpStatusCode.OK_200) {
2020-10-30 15:09:00 +01:00
const path = '/api/v1/videos/live'
return makeGetRequest({
url,
token,
path: path + '/' + videoId,
statusCodeExpected
})
}
function updateLive (
url: string,
token: string,
videoId: number | string,
fields: LiveVideoUpdate,
statusCodeExpected = HttpStatusCode.NO_CONTENT_204
) {
2020-10-30 15:09:00 +01:00
const path = '/api/v1/videos/live'
return makePutBodyRequest({
url,
token,
path: path + '/' + videoId,
fields,
statusCodeExpected
})
}
function createLive (url: string, token: string, fields: LiveVideoCreate, statusCodeExpected = HttpStatusCode.OK_200) {
2020-10-30 15:09:00 +01:00
const path = '/api/v1/videos/live'
2020-11-02 15:43:44 +01:00
const attaches: any = {}
if (fields.thumbnailfile) attaches.thumbnailfile = fields.thumbnailfile
if (fields.previewfile) attaches.previewfile = fields.previewfile
const updatedFields = omit(fields, 'thumbnailfile', 'previewfile')
2020-10-30 15:09:00 +01:00
return makeUploadRequest({
url,
path,
token,
attaches,
2020-11-02 15:43:44 +01:00
fields: updatedFields,
2020-10-30 15:09:00 +01:00
statusCodeExpected
})
}
2020-11-24 15:22:56 +01:00
async function sendRTMPStreamInVideo (url: string, token: string, videoId: number | string, fixtureName?: string) {
2020-11-03 15:33:30 +01:00
const res = await getLive(url, token, videoId)
const videoLive = res.body as LiveVideo
2020-11-24 15:22:56 +01:00
return sendRTMPStream(videoLive.rtmpUrl, videoLive.streamKey, fixtureName)
2020-11-03 15:33:30 +01:00
}
2020-11-24 15:22:56 +01:00
function sendRTMPStream (rtmpBaseUrl: string, streamKey: string, fixtureName = 'video_short.mp4') {
const fixture = buildAbsoluteFixturePath(fixtureName)
2020-10-30 15:09:00 +01:00
const command = ffmpeg(fixture)
command.inputOption('-stream_loop -1')
command.inputOption('-re')
2020-11-04 14:16:57 +01:00
command.outputOption('-c:v libx264')
command.outputOption('-g 50')
command.outputOption('-keyint_min 2')
2020-11-26 11:29:50 +01:00
command.outputOption('-r 60')
2020-10-30 15:09:00 +01:00
command.outputOption('-f flv')
const rtmpUrl = rtmpBaseUrl + '/' + streamKey
command.output(rtmpUrl)
command.on('error', err => {
if (err?.message?.includes('Exiting normally')) return
2020-11-04 14:16:57 +01:00
if (process.env.DEBUG) console.error(err)
2020-10-30 15:09:00 +01:00
})
if (process.env.DEBUG) {
command.on('stderr', data => console.log(data))
}
command.run()
return command
}
2020-11-03 15:33:30 +01:00
function waitFfmpegUntilError (command: ffmpeg.FfmpegCommand, successAfterMS = 10000) {
2021-02-03 09:33:05 +01:00
return new Promise<void>((res, rej) => {
2020-11-03 15:33:30 +01:00
command.on('error', err => {
return rej(err)
})
setTimeout(() => {
res()
}, successAfterMS)
})
}
2020-11-04 14:16:57 +01:00
async function runAndTestFfmpegStreamError (url: string, token: string, videoId: number | string, shouldHaveError: boolean) {
2020-11-03 15:33:30 +01:00
const command = await sendRTMPStreamInVideo(url, token, videoId)
2020-11-04 14:16:57 +01:00
return testFfmpegStreamError(command, shouldHaveError)
}
async function testFfmpegStreamError (command: ffmpeg.FfmpegCommand, shouldHaveError: boolean) {
2020-11-03 15:33:30 +01:00
let error: Error
try {
2020-12-11 10:36:05 +01:00
await waitFfmpegUntilError(command, 25000)
2020-11-03 15:33:30 +01:00
} catch (err) {
error = err
}
await stopFfmpeg(command)
if (shouldHaveError && !error) throw new Error('Ffmpeg did not have an error')
if (!shouldHaveError && error) throw error
}
2020-10-30 15:09:00 +01:00
async function stopFfmpeg (command: ffmpeg.FfmpegCommand) {
command.kill('SIGINT')
await wait(500)
}
2020-11-24 16:29:39 +01:00
function waitUntilLivePublished (url: string, token: string, videoId: number | string) {
2020-12-09 14:42:42 +01:00
return waitUntilLiveState(url, token, videoId, VideoState.PUBLISHED)
2020-11-24 16:29:39 +01:00
}
2020-12-11 10:36:05 +01:00
function waitUntilLiveWaiting (url: string, token: string, videoId: number | string) {
return waitUntilLiveState(url, token, videoId, VideoState.WAITING_FOR_LIVE)
}
2020-11-26 15:16:30 +01:00
function waitUntilLiveEnded (url: string, token: string, videoId: number | string) {
2020-12-09 14:42:42 +01:00
return waitUntilLiveState(url, token, videoId, VideoState.LIVE_ENDED)
}
function waitUntilLiveSegmentGeneration (server: ServerInfo, videoUUID: string, resolutionNum: number, segmentNum: number) {
const segmentName = `${resolutionNum}-00000${segmentNum}.ts`
return waitUntilLog(server, `${videoUUID}/${segmentName}`, 2, false)
2020-11-26 15:16:30 +01:00
}
2020-12-09 14:42:42 +01:00
async function waitUntilLiveState (url: string, token: string, videoId: number | string, state: VideoState) {
2020-10-30 15:09:00 +01:00
let video: VideoDetails
do {
const res = await getVideoWithToken(url, token, videoId)
video = res.body
await wait(500)
2020-12-09 14:42:42 +01:00
} while (video.state.id !== state)
2020-10-30 15:09:00 +01:00
}
2021-02-19 14:30:00 +01:00
async function waitUntilLiveSaved (url: string, token: string, videoId: number | string) {
let video: VideoDetails
do {
const res = await getVideoWithToken(url, token, videoId)
video = res.body
await wait(500)
} while (video.isLive === true && video.state.id !== VideoState.PUBLISHED)
}
2020-11-04 14:16:57 +01:00
async function checkLiveCleanup (server: ServerInfo, videoUUID: string, resolutions: number[] = []) {
2020-11-24 15:22:56 +01:00
const basePath = buildServerDirectory(server, 'streaming-playlists')
2020-11-04 14:16:57 +01:00
const hlsPath = join(basePath, 'hls', videoUUID)
if (resolutions.length === 0) {
const result = await pathExists(hlsPath)
expect(result).to.be.false
return
}
const files = await readdir(hlsPath)
// fragmented file and playlist per resolution + master playlist + segments sha256 json file
expect(files).to.have.lengthOf(resolutions.length * 2 + 2)
for (const resolution of resolutions) {
expect(files).to.contain(`${videoUUID}-${resolution}-fragmented.mp4`)
expect(files).to.contain(`${resolution}.m3u8`)
}
expect(files).to.contain('master.m3u8')
expect(files).to.contain('segments-sha256.json')
}
2020-12-03 14:10:54 +01:00
async function getPlaylistsCount (server: ServerInfo, videoUUID: string) {
const basePath = buildServerDirectory(server, 'streaming-playlists')
const hlsPath = join(basePath, 'hls', videoUUID)
const files = await readdir(hlsPath)
return files.filter(f => f.endsWith('.m3u8')).length
}
2020-10-30 15:09:00 +01:00
// ---------------------------------------------------------------------------
export {
getLive,
2020-12-03 14:10:54 +01:00
getPlaylistsCount,
2021-02-19 14:30:00 +01:00
waitUntilLiveSaved,
2020-11-24 16:29:39 +01:00
waitUntilLivePublished,
2020-10-30 15:09:00 +01:00
updateLive,
createLive,
2020-11-04 14:16:57 +01:00
runAndTestFfmpegStreamError,
checkLiveCleanup,
2020-12-09 14:42:42 +01:00
waitUntilLiveSegmentGeneration,
2020-10-30 15:09:00 +01:00
stopFfmpeg,
2020-12-11 10:36:05 +01:00
waitUntilLiveWaiting,
2020-11-03 15:33:30 +01:00
sendRTMPStreamInVideo,
2020-11-26 15:16:30 +01:00
waitUntilLiveEnded,
2020-11-03 15:33:30 +01:00
waitFfmpegUntilError,
2020-11-04 14:16:57 +01:00
sendRTMPStream,
testFfmpegStreamError
2020-10-30 15:09:00 +01:00
}