PeerTube/server/tests/plugins/plugin-transcoding.ts

281 lines
8.9 KiB
TypeScript
Raw Normal View History

/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import 'mocha'
import { expect } from 'chai'
2022-02-11 10:51:33 +01:00
import { getAudioStream, getVideoStreamFPS, getVideoStream } from '@server/helpers/ffmpeg'
import { VideoPrivacy } from '@shared/models'
import {
2021-07-07 10:33:49 +02:00
cleanupTests,
2021-07-16 09:47:51 +02:00
createSingleServer,
PeerTubeServer,
2021-07-16 14:27:30 +02:00
PluginsCommand,
setAccessTokensToServers,
setDefaultVideoChannel,
testFfmpegStreamError,
2021-07-08 10:18:40 +02:00
waitJobs
} from '@shared/server-commands'
2021-07-16 09:47:51 +02:00
async function createLiveWrapper (server: PeerTubeServer) {
const liveAttributes = {
name: 'live video',
2021-07-16 09:04:35 +02:00
channelId: server.store.channel.id,
privacy: VideoPrivacy.PUBLIC
}
2021-07-16 09:04:35 +02:00
const { uuid } = await server.live.create({ fields: liveAttributes })
2021-07-08 10:18:40 +02:00
return uuid
}
2021-07-16 09:47:51 +02:00
function updateConf (server: PeerTubeServer, vodProfile: string, liveProfile: string) {
2021-07-16 09:04:35 +02:00
return server.config.updateCustomSubConfig({
2021-07-07 11:51:09 +02:00
newConfig: {
transcoding: {
enabled: true,
2021-07-07 11:51:09 +02:00
profile: vodProfile,
hls: {
enabled: true
},
webtorrent: {
enabled: true
},
resolutions: {
'240p': true,
'360p': false,
'480p': false,
'720p': true
}
2021-07-07 11:51:09 +02:00
},
live: {
transcoding: {
profile: liveProfile,
enabled: true,
resolutions: {
'240p': true,
'360p': false,
'480p': false,
'720p': true
}
}
}
}
})
}
describe('Test transcoding plugins', function () {
2021-07-16 09:47:51 +02:00
let server: PeerTubeServer
before(async function () {
this.timeout(60000)
2021-07-16 09:47:51 +02:00
server = await createSingleServer(1)
await setAccessTokensToServers([ server ])
await setDefaultVideoChannel([ server ])
await updateConf(server, 'default', 'default')
})
describe('When using a plugin adding profiles to existing encoders', function () {
async function checkVideoFPS (uuid: string, type: 'above' | 'below', fps: number) {
2021-07-16 09:04:35 +02:00
const video = await server.videos.get({ id: uuid })
const files = video.files.concat(...video.streamingPlaylists.map(p => p.files))
for (const file of files) {
if (type === 'above') {
expect(file.fps).to.be.above(fps)
} else {
expect(file.fps).to.be.below(fps)
}
}
}
async function checkLiveFPS (uuid: string, type: 'above' | 'below', fps: number) {
const playlistUrl = `${server.url}/static/streaming-playlists/hls/${uuid}/0.m3u8`
2022-02-11 10:51:33 +01:00
const videoFPS = await getVideoStreamFPS(playlistUrl)
if (type === 'above') {
expect(videoFPS).to.be.above(fps)
} else {
expect(videoFPS).to.be.below(fps)
}
}
before(async function () {
2021-07-16 09:04:35 +02:00
await server.plugins.install({ path: PluginsCommand.getPluginTestPath('-transcoding-one') })
})
it('Should have the appropriate available profiles', async function () {
2021-07-16 09:04:35 +02:00
const config = await server.config.getConfig()
expect(config.transcoding.availableProfiles).to.have.members([ 'default', 'low-vod', 'input-options-vod', 'bad-scale-vod' ])
2021-07-22 08:46:55 +02:00
expect(config.live.transcoding.availableProfiles).to.have.members([ 'default', 'high-live', 'input-options-live', 'bad-scale-live' ])
})
2021-07-22 08:46:55 +02:00
describe('VOD', function () {
2021-07-22 08:46:55 +02:00
it('Should not use the plugin profile if not chosen by the admin', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
const videoUUID = (await server.videos.quickUpload({ name: 'video' })).uuid
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkVideoFPS(videoUUID, 'above', 20)
})
2021-07-22 08:46:55 +02:00
it('Should use the vod profile', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await updateConf(server, 'low-vod', 'default')
2021-07-22 08:46:55 +02:00
const videoUUID = (await server.videos.quickUpload({ name: 'video' })).uuid
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkVideoFPS(videoUUID, 'below', 12)
})
2021-07-22 08:46:55 +02:00
it('Should apply input options in vod profile', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await updateConf(server, 'input-options-vod', 'default')
2021-07-22 08:46:55 +02:00
const videoUUID = (await server.videos.quickUpload({ name: 'video' })).uuid
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkVideoFPS(videoUUID, 'below', 6)
})
2021-07-22 08:46:55 +02:00
it('Should apply the scale filter in vod profile', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await updateConf(server, 'bad-scale-vod', 'default')
2021-07-22 08:46:55 +02:00
const videoUUID = (await server.videos.quickUpload({ name: 'video' })).uuid
await waitJobs([ server ])
// Transcoding failed
const video = await server.videos.get({ id: videoUUID })
expect(video.files).to.have.lengthOf(1)
expect(video.streamingPlaylists).to.have.lengthOf(0)
})
})
2021-07-22 08:46:55 +02:00
describe('Live', function () {
2021-07-22 08:46:55 +02:00
it('Should not use the plugin profile if not chosen by the admin', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
const liveVideoId = await createLiveWrapper(server)
2021-07-22 08:46:55 +02:00
await server.live.sendRTMPStreamInVideo({ videoId: liveVideoId, fixtureName: 'video_very_short_240p.mp4' })
await server.live.waitUntilPublished({ videoId: liveVideoId })
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkLiveFPS(liveVideoId, 'above', 20)
})
2021-07-22 08:46:55 +02:00
it('Should use the live profile', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await updateConf(server, 'low-vod', 'high-live')
2021-07-22 08:46:55 +02:00
const liveVideoId = await createLiveWrapper(server)
2021-07-22 08:46:55 +02:00
await server.live.sendRTMPStreamInVideo({ videoId: liveVideoId, fixtureName: 'video_very_short_240p.mp4' })
await server.live.waitUntilPublished({ videoId: liveVideoId })
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkLiveFPS(liveVideoId, 'above', 45)
})
2021-07-22 08:46:55 +02:00
it('Should apply the input options on live profile', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await updateConf(server, 'low-vod', 'input-options-live')
2021-07-22 08:46:55 +02:00
const liveVideoId = await createLiveWrapper(server)
2021-07-22 08:46:55 +02:00
await server.live.sendRTMPStreamInVideo({ videoId: liveVideoId, fixtureName: 'video_very_short_240p.mp4' })
await server.live.waitUntilPublished({ videoId: liveVideoId })
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkLiveFPS(liveVideoId, 'above', 45)
})
2021-07-22 08:46:55 +02:00
it('Should apply the scale filter name on live profile', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await updateConf(server, 'low-vod', 'bad-scale-live')
2021-07-22 08:46:55 +02:00
const liveVideoId = await createLiveWrapper(server)
2021-07-22 08:46:55 +02:00
const command = await server.live.sendRTMPStreamInVideo({ videoId: liveVideoId, fixtureName: 'video_very_short_240p.mp4' })
await testFfmpegStreamError(command, true)
})
2021-07-22 08:46:55 +02:00
it('Should default to the default profile if the specified profile does not exist', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
await server.plugins.uninstall({ npmName: 'peertube-plugin-test-transcoding-one' })
2021-07-22 08:46:55 +02:00
const config = await server.config.getConfig()
2021-07-22 08:46:55 +02:00
expect(config.transcoding.availableProfiles).to.deep.equal([ 'default' ])
expect(config.live.transcoding.availableProfiles).to.deep.equal([ 'default' ])
const videoUUID = (await server.videos.quickUpload({ name: 'video', fixture: 'video_very_short_240p.mp4' })).uuid
await waitJobs([ server ])
2021-07-22 08:46:55 +02:00
await checkVideoFPS(videoUUID, 'above', 20)
})
})
})
describe('When using a plugin adding new encoders', function () {
before(async function () {
2021-07-16 09:04:35 +02:00
await server.plugins.install({ path: PluginsCommand.getPluginTestPath('-transcoding-two') })
await updateConf(server, 'test-vod-profile', 'test-live-profile')
})
it('Should use the new vod encoders', async function () {
this.timeout(240000)
2021-07-22 08:46:55 +02:00
const videoUUID = (await server.videos.quickUpload({ name: 'video', fixture: 'video_very_short_240p.mp4' })).uuid
await waitJobs([ server ])
2021-07-23 11:20:00 +02:00
const video = await server.videos.get({ id: videoUUID })
const path = server.servers.buildWebTorrentFilePath(video.files[0].fileUrl)
const audioProbe = await getAudioStream(path)
expect(audioProbe.audioStream.codec_name).to.equal('opus')
2022-02-11 10:51:33 +01:00
const videoProbe = await getVideoStream(path)
expect(videoProbe.codec_name).to.equal('vp9')
})
it('Should use the new live encoders', async function () {
this.timeout(240000)
const liveVideoId = await createLiveWrapper(server)
2021-07-16 09:04:35 +02:00
await server.live.sendRTMPStreamInVideo({ videoId: liveVideoId, fixtureName: 'video_short2.webm' })
await server.live.waitUntilPublished({ videoId: liveVideoId })
await waitJobs([ server ])
const playlistUrl = `${server.url}/static/streaming-playlists/hls/${liveVideoId}/0.m3u8`
const audioProbe = await getAudioStream(playlistUrl)
expect(audioProbe.audioStream.codec_name).to.equal('opus')
2022-02-11 10:51:33 +01:00
const videoProbe = await getVideoStream(playlistUrl)
expect(videoProbe.codec_name).to.equal('h264')
})
})
after(async function () {
await cleanupTests([ server ])
})
})