1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import * as chai from 'chai'
5 import { omit } from 'lodash'
6 import { join } from 'path'
8 buildAbsoluteFixturePath,
10 createMultipleServers,
12 generateHighBitrateVideo,
13 generateVideoWithFramerate,
16 setAccessTokensToServers,
19 } from '@shared/extra-utils'
20 import { getMaxBitrate, HttpStatusCode, VideoResolution, VideoState } from '@shared/models'
21 import { VIDEO_TRANSCODING_FPS } from '../../../../server/initializers/constants'
28 getVideoFileResolution
29 } from '../../../helpers/ffprobe-utils'
31 const expect = chai.expect
33 function updateConfigForTranscoding (server: PeerTubeServer) {
34 return server.config.updateCustomSubConfig({
38 allowAdditionalExtensions: true,
39 allowAudioFiles: true,
40 hls: { enabled: true },
41 webtorrent: { enabled: true },
57 describe('Test video transcoding', function () {
58 let servers: PeerTubeServer[] = []
61 before(async function () {
65 servers = await createMultipleServers(2)
67 await setAccessTokensToServers(servers)
69 await doubleFollow(servers[0], servers[1])
71 await updateConfigForTranscoding(servers[1])
74 describe('Basic transcoding (or not)', function () {
76 it('Should not transcode video on server 1', async function () {
80 name: 'my super name for server 1',
81 description: 'my super description for server 1',
82 fixture: 'video_short.webm'
84 await servers[0].videos.upload({ attributes })
86 await waitJobs(servers)
88 for (const server of servers) {
89 const { data } = await server.videos.list()
92 const videoDetails = await server.videos.get({ id: video.id })
93 expect(videoDetails.files).to.have.lengthOf(1)
95 const magnetUri = videoDetails.files[0].magnetUri
96 expect(magnetUri).to.match(/\.webm/)
98 const torrent = await webtorrentAdd(magnetUri, true)
99 expect(torrent.files).to.be.an('array')
100 expect(torrent.files.length).to.equal(1)
101 expect(torrent.files[0].path).match(/\.webm$/)
105 it('Should transcode video on server 2', async function () {
106 this.timeout(120_000)
109 name: 'my super name for server 2',
110 description: 'my super description for server 2',
111 fixture: 'video_short.webm'
113 await servers[1].videos.upload({ attributes })
115 await waitJobs(servers)
117 for (const server of servers) {
118 const { data } = await server.videos.list()
120 const video = data.find(v => v.name === attributes.name)
121 const videoDetails = await server.videos.get({ id: video.id })
123 expect(videoDetails.files).to.have.lengthOf(4)
125 const magnetUri = videoDetails.files[0].magnetUri
126 expect(magnetUri).to.match(/\.mp4/)
128 const torrent = await webtorrentAdd(magnetUri, true)
129 expect(torrent.files).to.be.an('array')
130 expect(torrent.files.length).to.equal(1)
131 expect(torrent.files[0].path).match(/\.mp4$/)
135 it('Should wait for transcoding before publishing the video', async function () {
136 this.timeout(160_000)
139 // Upload the video, but wait transcoding
141 name: 'waiting video',
142 fixture: 'video_short1.webm',
143 waitTranscoding: true
145 const { uuid } = await servers[1].videos.upload({ attributes })
148 // Should be in transcode state
149 const body = await servers[1].videos.get({ id: videoId })
150 expect(body.name).to.equal('waiting video')
151 expect(body.state.id).to.equal(VideoState.TO_TRANSCODE)
152 expect(body.state.label).to.equal('To transcode')
153 expect(body.waitTranscoding).to.be.true
156 // Should have my video
157 const { data } = await servers[1].videos.listMyVideos()
158 const videoToFindInMine = data.find(v => v.name === attributes.name)
159 expect(videoToFindInMine).not.to.be.undefined
160 expect(videoToFindInMine.state.id).to.equal(VideoState.TO_TRANSCODE)
161 expect(videoToFindInMine.state.label).to.equal('To transcode')
162 expect(videoToFindInMine.waitTranscoding).to.be.true
166 // Should not list this video
167 const { data } = await servers[1].videos.list()
168 const videoToFindInList = data.find(v => v.name === attributes.name)
169 expect(videoToFindInList).to.be.undefined
172 // Server 1 should not have the video yet
173 await servers[0].videos.get({ id: videoId, expectedStatus: HttpStatusCode.NOT_FOUND_404 })
176 await waitJobs(servers)
178 for (const server of servers) {
179 const { data } = await server.videos.list()
180 const videoToFind = data.find(v => v.name === 'waiting video')
181 expect(videoToFind).not.to.be.undefined
183 const videoDetails = await server.videos.get({ id: videoToFind.id })
185 expect(videoDetails.state.id).to.equal(VideoState.PUBLISHED)
186 expect(videoDetails.state.label).to.equal('Published')
187 expect(videoDetails.waitTranscoding).to.be.true
191 it('Should accept and transcode additional extensions', async function () {
192 this.timeout(300_000)
194 let tempFixturePath: string
197 tempFixturePath = await generateHighBitrateVideo()
199 const bitrate = await getVideoFileBitrate(tempFixturePath)
200 expect(bitrate).to.be.above(getMaxBitrate(VideoResolution.H_1080P, 25, VIDEO_TRANSCODING_FPS))
203 for (const fixture of [ 'video_short.mkv', 'video_short.avi' ]) {
209 await servers[1].videos.upload({ attributes })
211 await waitJobs(servers)
213 for (const server of servers) {
214 const { data } = await server.videos.list()
216 const video = data.find(v => v.name === attributes.name)
217 const videoDetails = await server.videos.get({ id: video.id })
218 expect(videoDetails.files).to.have.lengthOf(4)
220 const magnetUri = videoDetails.files[0].magnetUri
221 expect(magnetUri).to.contain('.mp4')
226 it('Should transcode a 4k video', async function () {
227 this.timeout(200_000)
231 fixture: 'video_short_4k.mp4'
234 const { uuid } = await servers[1].videos.upload({ attributes })
237 await waitJobs(servers)
239 const resolutions = [ 240, 360, 480, 720, 1080, 1440, 2160 ]
241 for (const server of servers) {
242 const videoDetails = await server.videos.get({ id: video4k })
243 expect(videoDetails.files).to.have.lengthOf(resolutions.length)
245 for (const r of resolutions) {
246 expect(videoDetails.files.find(f => f.resolution.id === r)).to.not.be.undefined
247 expect(videoDetails.streamingPlaylists[0].files.find(f => f.resolution.id === r)).to.not.be.undefined
253 describe('Audio transcoding', function () {
255 it('Should transcode high bit rate mp3 to proper bit rate', async function () {
260 fixture: 'video_short_mp3_256k.mp4'
262 await servers[1].videos.upload({ attributes })
264 await waitJobs(servers)
266 for (const server of servers) {
267 const { data } = await server.videos.list()
269 const video = data.find(v => v.name === attributes.name)
270 const videoDetails = await server.videos.get({ id: video.id })
272 expect(videoDetails.files).to.have.lengthOf(4)
274 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-240.mp4'))
275 const probe = await getAudioStream(path)
277 if (probe.audioStream) {
278 expect(probe.audioStream['codec_name']).to.be.equal('aac')
279 expect(probe.audioStream['bit_rate']).to.be.at.most(384 * 8000)
281 this.fail('Could not retrieve the audio stream on ' + probe.absolutePath)
286 it('Should transcode video with no audio and have no audio itself', async function () {
291 fixture: 'video_short_no_audio.mp4'
293 await servers[1].videos.upload({ attributes })
295 await waitJobs(servers)
297 for (const server of servers) {
298 const { data } = await server.videos.list()
300 const video = data.find(v => v.name === attributes.name)
301 const videoDetails = await server.videos.get({ id: video.id })
303 expect(videoDetails.files).to.have.lengthOf(4)
304 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-240.mp4'))
305 const probe = await getAudioStream(path)
306 expect(probe).to.not.have.property('audioStream')
310 it('Should leave the audio untouched, but properly transcode the video', async function () {
314 name: 'untouched_audio',
315 fixture: 'video_short.mp4'
317 await servers[1].videos.upload({ attributes })
319 await waitJobs(servers)
321 for (const server of servers) {
322 const { data } = await server.videos.list()
324 const video = data.find(v => v.name === attributes.name)
325 const videoDetails = await server.videos.get({ id: video.id })
327 expect(videoDetails.files).to.have.lengthOf(4)
329 const fixturePath = buildAbsoluteFixturePath(attributes.fixture)
330 const fixtureVideoProbe = await getAudioStream(fixturePath)
331 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-240.mp4'))
333 const videoProbe = await getAudioStream(path)
335 if (videoProbe.audioStream && fixtureVideoProbe.audioStream) {
336 const toOmit = [ 'max_bit_rate', 'duration', 'duration_ts', 'nb_frames', 'start_time', 'start_pts' ]
337 expect(omit(videoProbe.audioStream, toOmit)).to.be.deep.equal(omit(fixtureVideoProbe.audioStream, toOmit))
339 this.fail('Could not retrieve the audio stream on ' + videoProbe.absolutePath)
345 describe('Audio upload', function () {
347 function runSuite (mode: 'legacy' | 'resumable') {
349 before(async function () {
350 await servers[1].config.updateCustomSubConfig({
353 hls: { enabled: true },
354 webtorrent: { enabled: true },
370 it('Should merge an audio file with the preview file', async function () {
373 const attributes = { name: 'audio_with_preview', previewfile: 'preview.jpg', fixture: 'sample.ogg' }
374 await servers[1].videos.upload({ attributes, mode })
376 await waitJobs(servers)
378 for (const server of servers) {
379 const { data } = await server.videos.list()
381 const video = data.find(v => v.name === 'audio_with_preview')
382 const videoDetails = await server.videos.get({ id: video.id })
384 expect(videoDetails.files).to.have.lengthOf(1)
386 await makeGetRequest({ url: server.url, path: videoDetails.thumbnailPath, expectedStatus: HttpStatusCode.OK_200 })
387 await makeGetRequest({ url: server.url, path: videoDetails.previewPath, expectedStatus: HttpStatusCode.OK_200 })
389 const magnetUri = videoDetails.files[0].magnetUri
390 expect(magnetUri).to.contain('.mp4')
394 it('Should upload an audio file and choose a default background image', async function () {
397 const attributes = { name: 'audio_without_preview', fixture: 'sample.ogg' }
398 await servers[1].videos.upload({ attributes, mode })
400 await waitJobs(servers)
402 for (const server of servers) {
403 const { data } = await server.videos.list()
405 const video = data.find(v => v.name === 'audio_without_preview')
406 const videoDetails = await server.videos.get({ id: video.id })
408 expect(videoDetails.files).to.have.lengthOf(1)
410 await makeGetRequest({ url: server.url, path: videoDetails.thumbnailPath, expectedStatus: HttpStatusCode.OK_200 })
411 await makeGetRequest({ url: server.url, path: videoDetails.previewPath, expectedStatus: HttpStatusCode.OK_200 })
413 const magnetUri = videoDetails.files[0].magnetUri
414 expect(magnetUri).to.contain('.mp4')
418 it('Should upload an audio file and create an audio version only', async function () {
421 await servers[1].config.updateCustomSubConfig({
424 hls: { enabled: true },
425 webtorrent: { enabled: true },
435 const attributes = { name: 'audio_with_preview', previewfile: 'preview.jpg', fixture: 'sample.ogg' }
436 const { id } = await servers[1].videos.upload({ attributes, mode })
438 await waitJobs(servers)
440 for (const server of servers) {
441 const videoDetails = await server.videos.get({ id })
443 for (const files of [ videoDetails.files, videoDetails.streamingPlaylists[0].files ]) {
444 expect(files).to.have.lengthOf(2)
445 expect(files.find(f => f.resolution.id === 0)).to.not.be.undefined
449 await updateConfigForTranscoding(servers[1])
453 describe('Legacy upload', function () {
457 describe('Resumable upload', function () {
458 runSuite('resumable')
462 describe('Framerate', function () {
464 it('Should transcode a 60 FPS video', async function () {
468 name: 'my super 30fps name for server 2',
469 description: 'my super 30fps description for server 2',
470 fixture: '60fps_720p_small.mp4'
472 await servers[1].videos.upload({ attributes })
474 await waitJobs(servers)
476 for (const server of servers) {
477 const { data } = await server.videos.list()
479 const video = data.find(v => v.name === attributes.name)
480 const videoDetails = await server.videos.get({ id: video.id })
482 expect(videoDetails.files).to.have.lengthOf(4)
483 expect(videoDetails.files[0].fps).to.be.above(58).and.below(62)
484 expect(videoDetails.files[1].fps).to.be.below(31)
485 expect(videoDetails.files[2].fps).to.be.below(31)
486 expect(videoDetails.files[3].fps).to.be.below(31)
488 for (const resolution of [ '240', '360', '480' ]) {
489 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-' + resolution + '.mp4'))
490 const fps = await getVideoFileFPS(path)
492 expect(fps).to.be.below(31)
495 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-720.mp4'))
496 const fps = await getVideoFileFPS(path)
498 expect(fps).to.be.above(58).and.below(62)
502 it('Should downscale to the closest divisor standard framerate', async function () {
503 this.timeout(200_000)
505 let tempFixturePath: string
508 tempFixturePath = await generateVideoWithFramerate(59)
510 const fps = await getVideoFileFPS(tempFixturePath)
511 expect(fps).to.be.equal(59)
516 description: '59fps video',
517 fixture: tempFixturePath
520 await servers[1].videos.upload({ attributes })
522 await waitJobs(servers)
524 for (const server of servers) {
525 const { data } = await server.videos.list()
527 const video = data.find(v => v.name === attributes.name)
530 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-240.mp4'))
531 const fps = await getVideoFileFPS(path)
532 expect(fps).to.be.equal(25)
536 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-720.mp4'))
537 const fps = await getVideoFileFPS(path)
538 expect(fps).to.be.equal(59)
544 describe('Bitrate control', function () {
545 it('Should respect maximum bitrate values', async function () {
546 this.timeout(160_000)
548 let tempFixturePath: string
551 tempFixturePath = await generateHighBitrateVideo()
553 const bitrate = await getVideoFileBitrate(tempFixturePath)
554 expect(bitrate).to.be.above(getMaxBitrate(VideoResolution.H_1080P, 25, VIDEO_TRANSCODING_FPS))
558 name: 'high bitrate video',
559 description: 'high bitrate video',
560 fixture: tempFixturePath
563 await servers[1].videos.upload({ attributes })
565 await waitJobs(servers)
567 for (const server of servers) {
568 const { data } = await server.videos.list()
570 const video = data.find(v => v.name === attributes.name)
572 for (const resolution of [ '240', '360', '480', '720', '1080' ]) {
573 const path = servers[1].servers.buildDirectory(join('videos', video.uuid + '-' + resolution + '.mp4'))
575 const bitrate = await getVideoFileBitrate(path)
576 const fps = await getVideoFileFPS(path)
577 const resolution2 = await getVideoFileResolution(path)
579 expect(resolution2.videoFileResolution.toString()).to.equal(resolution)
580 expect(bitrate).to.be.below(getMaxBitrate(resolution2.videoFileResolution, fps, VIDEO_TRANSCODING_FPS))
585 it('Should not transcode to an higher bitrate than the original file', async function () {
586 this.timeout(160_000)
600 webtorrent: { enabled: true },
601 hls: { enabled: true }
604 await servers[1].config.updateCustomSubConfig({ newConfig })
608 fixture: 'low-bitrate.mp4'
611 const { uuid } = await servers[1].videos.upload({ attributes })
613 await waitJobs(servers)
615 const resolutions = [ 240, 360, 480, 720, 1080 ]
616 for (const r of resolutions) {
617 const path = `videos/${uuid}-${r}.mp4`
618 const size = await servers[1].servers.getServerFileSize(path)
619 expect(size, `${path} not below ${60_000}`).to.be.below(60_000)
624 describe('FFprobe', function () {
626 it('Should provide valid ffprobe data', async function () {
627 this.timeout(160_000)
629 const videoUUID = (await servers[1].videos.quickUpload({ name: 'ffprobe data' })).uuid
630 await waitJobs(servers)
633 const path = servers[1].servers.buildDirectory(join('videos', videoUUID + '-240.mp4'))
634 const metadata = await getMetadataFromFile(path)
636 // expected format properties
643 expect(metadata.format).to.have.nested.property(p)
646 // expected stream properties
652 'display_aspect_ratio',
656 expect(metadata.streams[0]).to.have.nested.property(p)
659 expect(metadata).to.not.have.nested.property('format.filename')
662 for (const server of servers) {
663 const videoDetails = await server.videos.get({ id: videoUUID })
665 const videoFiles = videoDetails.files
666 .concat(videoDetails.streamingPlaylists[0].files)
667 expect(videoFiles).to.have.lengthOf(8)
669 for (const file of videoFiles) {
670 expect(file.metadata).to.be.undefined
671 expect(file.metadataUrl).to.exist
672 expect(file.metadataUrl).to.contain(servers[1].url)
673 expect(file.metadataUrl).to.contain(videoUUID)
675 const metadata = await server.videos.getFileMetadata({ url: file.metadataUrl })
676 expect(metadata).to.have.nested.property('format.size')
681 it('Should correctly detect if quick transcode is possible', async function () {
684 expect(await canDoQuickTranscode(buildAbsoluteFixturePath('video_short.mp4'))).to.be.true
685 expect(await canDoQuickTranscode(buildAbsoluteFixturePath('video_short.webm'))).to.be.false
689 describe('Transcoding job queue', function () {
691 it('Should have the appropriate priorities for transcoding jobs', async function () {
692 const body = await servers[1].jobs.getJobsList({
696 jobType: 'video-transcoding'
699 const jobs = body.data
700 const transcodingJobs = jobs.filter(j => j.data.videoUUID === video4k)
702 expect(transcodingJobs).to.have.lengthOf(14)
704 const hlsJobs = transcodingJobs.filter(j => j.data.type === 'new-resolution-to-hls')
705 const webtorrentJobs = transcodingJobs.filter(j => j.data.type === 'new-resolution-to-webtorrent')
706 const optimizeJobs = transcodingJobs.filter(j => j.data.type === 'optimize-to-webtorrent')
708 expect(hlsJobs).to.have.lengthOf(7)
709 expect(webtorrentJobs).to.have.lengthOf(6)
710 expect(optimizeJobs).to.have.lengthOf(1)
712 for (const j of optimizeJobs.concat(hlsJobs.concat(webtorrentJobs))) {
713 expect(j.priority).to.be.greaterThan(100)
714 expect(j.priority).to.be.lessThan(150)
719 after(async function () {
720 await cleanupTests(servers)