1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import { expect } from 'chai'
5 import { join } from 'path'
6 import { getAudioStream, getVideoFileFPS, getVideoStreamFromFile } from '@server/helpers/ffprobe-utils'
7 import { ServerConfig, VideoDetails, VideoPrivacy } from '@shared/models'
15 sendRTMPStreamInVideo,
16 setAccessTokensToServers,
17 setDefaultVideoChannel,
19 updateCustomSubConfig,
22 waitUntilLivePublished
23 } from '../../../shared/extra-utils'
24 import { cleanupTests, flushAndRunServer, ServerInfo } from '../../../shared/extra-utils/server/servers'
26 async function createLiveWrapper (server: ServerInfo) {
27 const liveAttributes = {
29 channelId: server.videoChannel.id,
30 privacy: VideoPrivacy.PUBLIC
33 const res = await createLive(server.url, server.accessToken, liveAttributes)
34 return res.body.video.uuid
37 function updateConf (server: ServerInfo, vodProfile: string, liveProfile: string) {
38 return updateCustomSubConfig(server.url, server.accessToken, {
70 describe('Test transcoding plugins', function () {
71 let server: ServerInfo
73 before(async function () {
76 server = await flushAndRunServer(1)
77 await setAccessTokensToServers([ server ])
78 await setDefaultVideoChannel([ server ])
80 await updateConf(server, 'default', 'default')
83 describe('When using a plugin adding profiles to existing encoders', function () {
85 async function checkVideoFPS (uuid: string, type: 'above' | 'below', fps: number) {
86 const res = await getVideo(server.url, uuid)
87 const video = res.body as VideoDetails
88 const files = video.files.concat(...video.streamingPlaylists.map(p => p.files))
90 for (const file of files) {
91 if (type === 'above') {
92 expect(file.fps).to.be.above(fps)
94 expect(file.fps).to.be.below(fps)
99 async function checkLiveFPS (uuid: string, type: 'above' | 'below', fps: number) {
100 const playlistUrl = `${server.url}/static/streaming-playlists/hls/${uuid}/0.m3u8`
101 const videoFPS = await getVideoFileFPS(playlistUrl)
103 if (type === 'above') {
104 expect(videoFPS).to.be.above(fps)
106 expect(videoFPS).to.be.below(fps)
110 before(async function () {
111 await installPlugin({
113 accessToken: server.accessToken,
114 path: getPluginTestPath('-transcoding-one')
118 it('Should have the appropriate available profiles', async function () {
119 const res = await getConfig(server.url)
120 const config = res.body as ServerConfig
122 expect(config.transcoding.availableProfiles).to.have.members([ 'default', 'low-vod' ])
123 expect(config.live.transcoding.availableProfiles).to.have.members([ 'default', 'low-live' ])
126 it('Should not use the plugin profile if not chosen by the admin', async function () {
129 const videoUUID = (await uploadVideoAndGetId({ server, videoName: 'video' })).uuid
130 await waitJobs([ server ])
132 await checkVideoFPS(videoUUID, 'above', 20)
135 it('Should use the vod profile', async function () {
138 await updateConf(server, 'low-vod', 'default')
140 const videoUUID = (await uploadVideoAndGetId({ server, videoName: 'video' })).uuid
141 await waitJobs([ server ])
143 await checkVideoFPS(videoUUID, 'below', 12)
146 it('Should not use the plugin profile if not chosen by the admin', async function () {
149 const liveVideoId = await createLiveWrapper(server)
151 await sendRTMPStreamInVideo(server.url, server.accessToken, liveVideoId, 'video_short2.webm')
152 await waitUntilLivePublished(server.url, server.accessToken, liveVideoId)
153 await waitJobs([ server ])
155 await checkLiveFPS(liveVideoId, 'above', 20)
158 it('Should use the live profile', async function () {
161 await updateConf(server, 'low-vod', 'low-live')
163 const liveVideoId = await createLiveWrapper(server)
165 await sendRTMPStreamInVideo(server.url, server.accessToken, liveVideoId, 'video_short2.webm')
166 await waitUntilLivePublished(server.url, server.accessToken, liveVideoId)
167 await waitJobs([ server ])
169 await checkLiveFPS(liveVideoId, 'below', 12)
172 it('Should default to the default profile if the specified profile does not exist', async function () {
175 await uninstallPlugin({ url: server.url, accessToken: server.accessToken, npmName: 'peertube-plugin-test-transcoding-one' })
177 const res = await getConfig(server.url)
178 const config = res.body as ServerConfig
180 expect(config.transcoding.availableProfiles).to.deep.equal([ 'default' ])
181 expect(config.live.transcoding.availableProfiles).to.deep.equal([ 'default' ])
183 const videoUUID = (await uploadVideoAndGetId({ server, videoName: 'video' })).uuid
184 await waitJobs([ server ])
186 await checkVideoFPS(videoUUID, 'above', 20)
191 describe('When using a plugin adding new encoders', function () {
193 before(async function () {
194 await installPlugin({
196 accessToken: server.accessToken,
197 path: getPluginTestPath('-transcoding-two')
200 await updateConf(server, 'test-vod-profile', 'test-live-profile')
203 it('Should use the new vod encoders', async function () {
206 const videoUUID = (await uploadVideoAndGetId({ server, videoName: 'video', fixture: 'video_short_240p.mp4' })).uuid
207 await waitJobs([ server ])
209 const path = buildServerDirectory(server, join('videos', videoUUID + '-240.mp4'))
210 const audioProbe = await getAudioStream(path)
211 expect(audioProbe.audioStream.codec_name).to.equal('opus')
213 const videoProbe = await getVideoStreamFromFile(path)
214 expect(videoProbe.codec_name).to.equal('vp9')
217 it('Should use the new live encoders', async function () {
220 const liveVideoId = await createLiveWrapper(server)
222 await sendRTMPStreamInVideo(server.url, server.accessToken, liveVideoId, 'video_short2.webm')
223 await waitUntilLivePublished(server.url, server.accessToken, liveVideoId)
224 await waitJobs([ server ])
226 const playlistUrl = `${server.url}/static/streaming-playlists/hls/${liveVideoId}/0.m3u8`
227 const audioProbe = await getAudioStream(playlistUrl)
228 expect(audioProbe.audioStream.codec_name).to.equal('opus')
230 const videoProbe = await getVideoStreamFromFile(playlistUrl)
231 expect(videoProbe.codec_name).to.equal('h264')
235 after(async function () {
236 await cleanupTests([ server ])