]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/tests/api/videos/video-transcoder.ts
Support transcoding options/encoders by plugins
[github/Chocobozzz/PeerTube.git] / server / tests / api / videos / video-transcoder.ts
index e3fd0ec22642fb9fe5839ae14f5a25faaa8604b7..5ad02df2fc786c95c6d9eca312313eedf8402ebe 100644 (file)
@@ -1,48 +1,54 @@
 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
 
-import * as chai from 'chai'
 import 'mocha'
+import * as chai from 'chai'
+import { FfprobeData } from 'fluent-ffmpeg'
 import { omit } from 'lodash'
-import { getMaxBitrate, VideoDetails, VideoResolution, VideoState } from '../../../../shared/models/videos'
-import {
-  audio,
-  canDoQuickTranscode,
-  getVideoFileBitrate,
-  getVideoFileFPS,
-  getVideoFileResolution,
-  getMetadataFromFile
-} from '../../../helpers/ffmpeg-utils'
+import { join } from 'path'
+import { Job } from '@shared/models'
+import { VIDEO_TRANSCODING_FPS } from '../../../../server/initializers/constants'
+import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
 import {
   buildAbsoluteFixturePath,
+  buildServerDirectory,
   cleanupTests,
   doubleFollow,
   flushAndRunMultipleServers,
   generateHighBitrateVideo,
   generateVideoWithFramerate,
+  getJobsListPaginationAndSort,
   getMyVideos,
+  getServerFileSize,
   getVideo,
   getVideoFileMetadataUrl,
   getVideosList,
   makeGetRequest,
-  root,
   ServerInfo,
   setAccessTokensToServers,
-  uploadVideo, uploadVideoAndGetId,
+  updateCustomSubConfig,
+  uploadVideo,
+  uploadVideoAndGetId,
   waitJobs,
   webtorrentAdd
 } from '../../../../shared/extra-utils'
-import { join } from 'path'
-import { VIDEO_TRANSCODING_FPS } from '../../../../server/initializers/constants'
-import { FfprobeData } from 'fluent-ffmpeg'
-import { VideoFileMetadata } from '@shared/models/videos/video-file-metadata'
+import { getMaxBitrate, VideoDetails, VideoResolution, VideoState } from '../../../../shared/models/videos'
+import {
+  canDoQuickTranscode,
+  getAudioStream,
+  getMetadataFromFile,
+  getVideoFileBitrate,
+  getVideoFileFPS,
+  getVideoFileResolution
+} from '../../../helpers/ffprobe-utils'
 
 const expect = chai.expect
 
 describe('Test video transcoding', function () {
   let servers: ServerInfo[] = []
+  let video4k: string
 
   before(async function () {
-    this.timeout(30000)
+    this.timeout(30_000)
 
     // Run servers
     servers = await flushAndRunMultipleServers(2)
@@ -53,7 +59,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should not transcode video on server 1', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributes = {
       name: 'my super name for server 1',
@@ -83,7 +89,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should transcode video on server 2', async function () {
-    this.timeout(60000)
+    this.timeout(120_000)
 
     const videoAttributes = {
       name: 'my super name for server 2',
@@ -114,7 +120,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should transcode high bit rate mp3 to proper bit rate', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributes = {
       name: 'mp3_256k',
@@ -133,8 +139,8 @@ describe('Test video transcoding', function () {
 
       expect(videoDetails.files).to.have.lengthOf(4)
 
-      const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-240.mp4')
-      const probe = await audio.get(path)
+      const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-240.mp4'))
+      const probe = await getAudioStream(path)
 
       if (probe.audioStream) {
         expect(probe.audioStream['codec_name']).to.be.equal('aac')
@@ -146,7 +152,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should transcode video with no audio and have no audio itself', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributes = {
       name: 'no_audio',
@@ -164,14 +170,14 @@ describe('Test video transcoding', function () {
       const videoDetails: VideoDetails = res2.body
 
       expect(videoDetails.files).to.have.lengthOf(4)
-      const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-240.mp4')
-      const probe = await audio.get(path)
+      const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-240.mp4'))
+      const probe = await getAudioStream(path)
       expect(probe).to.not.have.property('audioStream')
     }
   })
 
   it('Should leave the audio untouched, but properly transcode the video', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributes = {
       name: 'untouched_audio',
@@ -189,10 +195,13 @@ describe('Test video transcoding', function () {
       const videoDetails: VideoDetails = res2.body
 
       expect(videoDetails.files).to.have.lengthOf(4)
+
       const fixturePath = buildAbsoluteFixturePath(videoAttributes.fixture)
-      const fixtureVideoProbe = await audio.get(fixturePath)
-      const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-240.mp4')
-      const videoProbe = await audio.get(path)
+      const fixtureVideoProbe = await getAudioStream(fixturePath)
+      const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-240.mp4'))
+
+      const videoProbe = await getAudioStream(path)
+
       if (videoProbe.audioStream && fixtureVideoProbe.audioStream) {
         const toOmit = [ 'max_bit_rate', 'duration', 'duration_ts', 'nb_frames', 'start_time', 'start_pts' ]
         expect(omit(videoProbe.audioStream, toOmit)).to.be.deep.equal(omit(fixtureVideoProbe.audioStream, toOmit))
@@ -203,7 +212,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should transcode a 60 FPS video', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributes = {
       name: 'my super 30fps name for server 2',
@@ -228,13 +237,13 @@ describe('Test video transcoding', function () {
       expect(videoDetails.files[3].fps).to.be.below(31)
 
       for (const resolution of [ '240', '360', '480' ]) {
-        const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-' + resolution + '.mp4')
+        const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-' + resolution + '.mp4'))
         const fps = await getVideoFileFPS(path)
 
         expect(fps).to.be.below(31)
       }
 
-      const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-720.mp4')
+      const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-720.mp4'))
       const fps = await getVideoFileFPS(path)
 
       expect(fps).to.be.above(58).and.below(62)
@@ -242,7 +251,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should wait for transcoding before publishing the video', async function () {
-    this.timeout(160000)
+    this.timeout(160_000)
 
     {
       // Upload the video, but wait transcoding
@@ -275,7 +284,7 @@ describe('Test video transcoding', function () {
       expect(videoToFindInList).to.be.undefined
 
       // Server 1 should not have the video yet
-      await getVideo(servers[0].url, videoId, 404)
+      await getVideo(servers[0].url, videoId, HttpStatusCode.NOT_FOUND_404)
     }
 
     await waitJobs(servers)
@@ -295,7 +304,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should respect maximum bitrate values', async function () {
-    this.timeout(160000)
+    this.timeout(160_000)
 
     let tempFixturePath: string
 
@@ -322,7 +331,8 @@ describe('Test video transcoding', function () {
       const video = res.body.data.find(v => v.name === videoAttributes.name)
 
       for (const resolution of [ '240', '360', '480', '720', '1080' ]) {
-        const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-' + resolution + '.mp4')
+        const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-' + resolution + '.mp4'))
+
         const bitrate = await getVideoFileBitrate(path)
         const fps = await getVideoFileFPS(path)
         const resolution2 = await getVideoFileResolution(path)
@@ -334,7 +344,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should accept and transcode additional extensions', async function () {
-    this.timeout(300000)
+    this.timeout(300_000)
 
     let tempFixturePath: string
 
@@ -371,14 +381,14 @@ describe('Test video transcoding', function () {
   })
 
   it('Should correctly detect if quick transcode is possible', async function () {
-    this.timeout(10000)
+    this.timeout(10_000)
 
     expect(await canDoQuickTranscode(buildAbsoluteFixturePath('video_short.mp4'))).to.be.true
     expect(await canDoQuickTranscode(buildAbsoluteFixturePath('video_short.webm'))).to.be.false
   })
 
   it('Should merge an audio file with the preview file', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributesArg = { name: 'audio_with_preview', previewfile: 'preview.jpg', fixture: 'sample.ogg' }
     await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributesArg)
@@ -394,8 +404,8 @@ describe('Test video transcoding', function () {
 
       expect(videoDetails.files).to.have.lengthOf(1)
 
-      await makeGetRequest({ url: server.url, path: videoDetails.thumbnailPath, statusCodeExpected: 200 })
-      await makeGetRequest({ url: server.url, path: videoDetails.previewPath, statusCodeExpected: 200 })
+      await makeGetRequest({ url: server.url, path: videoDetails.thumbnailPath, statusCodeExpected: HttpStatusCode.OK_200 })
+      await makeGetRequest({ url: server.url, path: videoDetails.previewPath, statusCodeExpected: HttpStatusCode.OK_200 })
 
       const magnetUri = videoDetails.files[0].magnetUri
       expect(magnetUri).to.contain('.mp4')
@@ -403,7 +413,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should upload an audio file and choose a default background image', async function () {
-    this.timeout(60000)
+    this.timeout(60_000)
 
     const videoAttributesArg = { name: 'audio_without_preview', fixture: 'sample.ogg' }
     await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributesArg)
@@ -419,8 +429,8 @@ describe('Test video transcoding', function () {
 
       expect(videoDetails.files).to.have.lengthOf(1)
 
-      await makeGetRequest({ url: server.url, path: videoDetails.thumbnailPath, statusCodeExpected: 200 })
-      await makeGetRequest({ url: server.url, path: videoDetails.previewPath, statusCodeExpected: 200 })
+      await makeGetRequest({ url: server.url, path: videoDetails.thumbnailPath, statusCodeExpected: HttpStatusCode.OK_200 })
+      await makeGetRequest({ url: server.url, path: videoDetails.previewPath, statusCodeExpected: HttpStatusCode.OK_200 })
 
       const magnetUri = videoDetails.files[0].magnetUri
       expect(magnetUri).to.contain('.mp4')
@@ -428,7 +438,7 @@ describe('Test video transcoding', function () {
   })
 
   it('Should downscale to the closest divisor standard framerate', async function () {
-    this.timeout(160000)
+    this.timeout(200_000)
 
     let tempFixturePath: string
 
@@ -455,28 +465,67 @@ describe('Test video transcoding', function () {
       const video = res.body.data.find(v => v.name === videoAttributes.name)
 
       {
-        const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-240.mp4')
+        const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-240.mp4'))
         const fps = await getVideoFileFPS(path)
         expect(fps).to.be.equal(25)
       }
 
       {
-        const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', video.uuid + '-720.mp4')
+        const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-720.mp4'))
         const fps = await getVideoFileFPS(path)
         expect(fps).to.be.equal(59)
       }
     }
   })
 
+  it('Should not transcode to an higher bitrate than the original file', async function () {
+    this.timeout(160_000)
+
+    const config = {
+      transcoding: {
+        enabled: true,
+        resolutions: {
+          '240p': true,
+          '360p': true,
+          '480p': true,
+          '720p': true,
+          '1080p': true,
+          '1440p': true,
+          '2160p': true
+        },
+        webtorrent: { enabled: true },
+        hls: { enabled: true }
+      }
+    }
+    await updateCustomSubConfig(servers[1].url, servers[1].accessToken, config)
+
+    const videoAttributes = {
+      name: 'low bitrate',
+      fixture: 'low-bitrate.mp4'
+    }
+
+    const resUpload = await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
+    const videoUUID = resUpload.body.video.uuid
+
+    await waitJobs(servers)
+
+    const resolutions = [ 240, 360, 480, 720, 1080 ]
+    for (const r of resolutions) {
+      const path = `videos/${videoUUID}-${r}.mp4`
+      const size = await getServerFileSize(servers[1], path)
+      expect(size, `${path} not below ${60_000}`).to.be.below(60_000)
+    }
+  })
+
   it('Should provide valid ffprobe data', async function () {
-    this.timeout(160000)
+    this.timeout(160_000)
 
     const videoUUID = (await uploadVideoAndGetId({ server: servers[1], videoName: 'ffprobe data' })).uuid
     await waitJobs(servers)
 
     {
-      const path = join(root(), 'test' + servers[1].internalServerNumber, 'videos', videoUUID + '-240.mp4')
-      const metadata = await getMetadataFromFile<VideoFileMetadata>(path)
+      const path = buildServerDirectory(servers[1], join('videos', videoUUID + '-240.mp4'))
+      const metadata = await getMetadataFromFile(path)
 
       // expected format properties
       for (const p of [
@@ -525,6 +574,69 @@ describe('Test video transcoding', function () {
     }
   })
 
+  it('Should transcode a 4k video', async function () {
+    this.timeout(200_000)
+
+    const videoAttributes = {
+      name: '4k video',
+      fixture: 'video_short_4k.mp4'
+    }
+
+    const resUpload = await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
+    video4k = resUpload.body.video.uuid
+
+    await waitJobs(servers)
+
+    const resolutions = [ 240, 360, 480, 720, 1080, 1440, 2160 ]
+
+    for (const server of servers) {
+      const res = await getVideo(server.url, video4k)
+      const videoDetails: VideoDetails = res.body
+
+      expect(videoDetails.files).to.have.lengthOf(resolutions.length)
+
+      for (const r of resolutions) {
+        expect(videoDetails.files.find(f => f.resolution.id === r)).to.not.be.undefined
+        expect(videoDetails.streamingPlaylists[0].files.find(f => f.resolution.id === r)).to.not.be.undefined
+      }
+    }
+  })
+
+  it('Should have the appropriate priorities for transcoding jobs', async function () {
+    const res = await getJobsListPaginationAndSort({
+      url: servers[1].url,
+      accessToken: servers[1].accessToken,
+      start: 0,
+      count: 100,
+      sort: '-createdAt',
+      jobType: 'video-transcoding'
+    })
+
+    const jobs = res.body.data as Job[]
+
+    const transcodingJobs = jobs.filter(j => j.data.videoUUID === video4k)
+
+    expect(transcodingJobs).to.have.lengthOf(14)
+
+    const hlsJobs = transcodingJobs.filter(j => j.data.type === 'new-resolution-to-hls')
+    const webtorrentJobs = transcodingJobs.filter(j => j.data.type === 'new-resolution-to-webtorrent')
+    const optimizeJobs = transcodingJobs.filter(j => j.data.type === 'optimize-to-webtorrent')
+
+    expect(hlsJobs).to.have.lengthOf(7)
+    expect(webtorrentJobs).to.have.lengthOf(6)
+    expect(optimizeJobs).to.have.lengthOf(1)
+
+    for (const j of optimizeJobs) {
+      expect(j.priority).to.be.greaterThan(11)
+      expect(j.priority).to.be.lessThan(50)
+    }
+
+    for (const j of hlsJobs.concat(webtorrentJobs)) {
+      expect(j.priority).to.be.greaterThan(100)
+      expect(j.priority).to.be.lessThan(150)
+    }
+  })
+
   after(async function () {
     await cleanupTests(servers)
   })