]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/tests/api/videos/video-transcoder.ts
emit more specific status codes on video upload (#3423)
[github/Chocobozzz/PeerTube.git] / server / tests / api / videos / video-transcoder.ts
index fe750253e9b2b4243e60854586d09810b9c5b79c..f88c59f0d6edf38cdb25bdf737b71ec108ae2999 100644 (file)
@@ -1,24 +1,43 @@
-/* tslint:disable:no-unused-expression */
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
 
-import * as chai from 'chai'
 import 'mocha'
-import { VideoDetails, VideoState } from '../../../../shared/models/videos'
-import { getVideoFileFPS } from '../../../helpers/ffmpeg-utils'
+import * as chai from 'chai'
+import { FfprobeData } from 'fluent-ffmpeg'
+import { omit } from 'lodash'
+import { join } from 'path'
+import { VIDEO_TRANSCODING_FPS } from '../../../../server/initializers/constants'
 import {
+  buildAbsoluteFixturePath,
+  buildServerDirectory,
+  cleanupTests,
   doubleFollow,
   flushAndRunMultipleServers,
+  generateHighBitrateVideo,
+  generateVideoWithFramerate,
   getMyVideos,
+  getServerFileSize,
   getVideo,
+  getVideoFileMetadataUrl,
   getVideosList,
-  killallServers,
-  root,
+  makeGetRequest,
   ServerInfo,
   setAccessTokensToServers,
+  updateCustomSubConfig,
   uploadVideo,
+  uploadVideoAndGetId,
+  waitJobs,
   webtorrentAdd
-} from '../../utils'
-import { join } from 'path'
-import { waitJobs } from '../../utils/server/jobs'
+} from '../../../../shared/extra-utils'
+import { getMaxBitrate, VideoDetails, VideoResolution, VideoState } from '../../../../shared/models/videos'
+import {
+  canDoQuickTranscode,
+  getAudioStream,
+  getMetadataFromFile,
+  getVideoFileBitrate,
+  getVideoFileFPS,
+  getVideoFileResolution
+} from '../../../helpers/ffprobe-utils'
+import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
 
 const expect = chai.expect
 
@@ -32,6 +51,8 @@ describe('Test video transcoding', function () {
     servers = await flushAndRunMultipleServers(2)
 
     await setAccessTokensToServers(servers)
+
+    await doubleFollow(servers[0], servers[1])
   })
 
   it('Should not transcode video on server 1', async function () {
@@ -46,24 +67,26 @@ describe('Test video transcoding', function () {
 
     await waitJobs(servers)
 
-    const res = await getVideosList(servers[0].url)
-    const video = res.body.data[0]
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+      const video = res.body.data[0]
 
-    const res2 = await getVideo(servers[0].url, video.id)
-    const videoDetails = res2.body
-    expect(videoDetails.files).to.have.lengthOf(1)
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails = res2.body
+      expect(videoDetails.files).to.have.lengthOf(1)
 
-    const magnetUri = videoDetails.files[0].magnetUri
-    expect(magnetUri).to.match(/\.webm/)
+      const magnetUri = videoDetails.files[0].magnetUri
+      expect(magnetUri).to.match(/\.webm/)
 
-    const torrent = await webtorrentAdd(magnetUri)
-    expect(torrent.files).to.be.an('array')
-    expect(torrent.files.length).to.equal(1)
-    expect(torrent.files[0].path).match(/\.webm$/)
+      const torrent = await webtorrentAdd(magnetUri, true)
+      expect(torrent.files).to.be.an('array')
+      expect(torrent.files.length).to.equal(1)
+      expect(torrent.files[0].path).match(/\.webm$/)
+    }
   })
 
   it('Should transcode video on server 2', async function () {
-    this.timeout(60000)
+    this.timeout(120000)
 
     const videoAttributes = {
       name: 'my super name for server 2',
@@ -74,67 +97,159 @@ describe('Test video transcoding', function () {
 
     await waitJobs(servers)
 
-    const res = await getVideosList(servers[1].url)
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
 
-    const video = res.body.data[0]
-    const res2 = await getVideo(servers[1].url, video.id)
-    const videoDetails = res2.body
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails = res2.body
 
-    expect(videoDetails.files).to.have.lengthOf(4)
+      expect(videoDetails.files).to.have.lengthOf(4)
 
-    const magnetUri = videoDetails.files[0].magnetUri
-    expect(magnetUri).to.match(/\.mp4/)
+      const magnetUri = videoDetails.files[0].magnetUri
+      expect(magnetUri).to.match(/\.mp4/)
 
-    const torrent = await webtorrentAdd(magnetUri)
-    expect(torrent.files).to.be.an('array')
-    expect(torrent.files.length).to.equal(1)
-    expect(torrent.files[0].path).match(/\.mp4$/)
+      const torrent = await webtorrentAdd(magnetUri, true)
+      expect(torrent.files).to.be.an('array')
+      expect(torrent.files.length).to.equal(1)
+      expect(torrent.files[0].path).match(/\.mp4$/)
+    }
   })
 
-  it('Should transcode a 60 FPS video', async function () {
+  it('Should transcode high bit rate mp3 to proper bit rate', async function () {
     this.timeout(60000)
 
     const videoAttributes = {
-      name: 'my super 30fps name for server 2',
-      description: 'my super 30fps description for server 2',
-      fixture: '60fps_720p_small.mp4'
+      name: 'mp3_256k',
+      fixture: 'video_short_mp3_256k.mp4'
     }
     await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
 
     await waitJobs(servers)
 
-    const res = await getVideosList(servers[1].url)
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
 
-    const video = res.body.data[0]
-    const res2 = await getVideo(servers[1].url, video.id)
-    const videoDetails: VideoDetails = res2.body
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails: VideoDetails = res2.body
 
-    expect(videoDetails.files).to.have.lengthOf(4)
-    expect(videoDetails.files[0].fps).to.be.above(58).and.below(62)
-    expect(videoDetails.files[1].fps).to.be.below(31)
-    expect(videoDetails.files[2].fps).to.be.below(31)
-    expect(videoDetails.files[3].fps).to.be.below(31)
+      expect(videoDetails.files).to.have.lengthOf(4)
 
-    for (const resolution of [ '240', '360', '480' ]) {
-      const path = join(root(), 'test2', 'videos', video.uuid + '-' + resolution + '.mp4')
-      const fps = await getVideoFileFPS(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')
+        expect(probe.audioStream['bit_rate']).to.be.at.most(384 * 8000)
+      } else {
+        this.fail('Could not retrieve the audio stream on ' + probe.absolutePath)
+      }
+    }
+  })
 
-      expect(fps).to.be.below(31)
+  it('Should transcode video with no audio and have no audio itself', async function () {
+    this.timeout(60000)
+
+    const videoAttributes = {
+      name: 'no_audio',
+      fixture: 'video_short_no_audio.mp4'
     }
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
 
-    const path = join(root(), 'test2', 'videos', video.uuid + '-720.mp4')
-    const fps = await getVideoFileFPS(path)
+    await waitJobs(servers)
 
-    expect(fps).to.be.above(58).and.below(62)
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails: VideoDetails = res2.body
+
+      expect(videoDetails.files).to.have.lengthOf(4)
+      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 wait transcoding before publishing the video', async function () {
-    this.timeout(80000)
+  it('Should leave the audio untouched, but properly transcode the video', async function () {
+    this.timeout(60000)
 
-    await doubleFollow(servers[0], servers[1])
+    const videoAttributes = {
+      name: 'untouched_audio',
+      fixture: 'video_short.mp4'
+    }
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
+
+    await waitJobs(servers)
+
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails: VideoDetails = res2.body
+
+      expect(videoDetails.files).to.have.lengthOf(4)
+
+      const fixturePath = buildAbsoluteFixturePath(videoAttributes.fixture)
+      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))
+      } else {
+        this.fail('Could not retrieve the audio stream on ' + videoProbe.absolutePath)
+      }
+    }
+  })
+
+  it('Should transcode a 60 FPS video', async function () {
+    this.timeout(60000)
+
+    const videoAttributes = {
+      name: 'my super 30fps name for server 2',
+      description: 'my super 30fps description for server 2',
+      fixture: '60fps_720p_small.mp4'
+    }
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
 
     await waitJobs(servers)
 
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails: VideoDetails = res2.body
+
+      expect(videoDetails.files).to.have.lengthOf(4)
+      expect(videoDetails.files[0].fps).to.be.above(58).and.below(62)
+      expect(videoDetails.files[1].fps).to.be.below(31)
+      expect(videoDetails.files[2].fps).to.be.below(31)
+      expect(videoDetails.files[3].fps).to.be.below(31)
+
+      for (const resolution of [ '240', '360', '480' ]) {
+        const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-' + resolution + '.mp4'))
+        const fps = await getVideoFileFPS(path)
+
+        expect(fps).to.be.below(31)
+      }
+
+      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)
+    }
+  })
+
+  it('Should wait for transcoding before publishing the video', async function () {
+    this.timeout(160000)
+
     {
       // Upload the video, but wait transcoding
       const videoAttributes = {
@@ -142,11 +257,11 @@ describe('Test video transcoding', function () {
         fixture: 'video_short1.webm',
         waitTranscoding: true
       }
-      const resVideo = await uploadVideo(servers[ 1 ].url, servers[ 1 ].accessToken, videoAttributes)
+      const resVideo = await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
       const videoId = resVideo.body.video.uuid
 
       // Should be in transcode state
-      const { body } = await getVideo(servers[ 1 ].url, videoId)
+      const { body } = await getVideo(servers[1].url, videoId)
       expect(body.name).to.equal('waiting video')
       expect(body.state.id).to.equal(VideoState.TO_TRANSCODE)
       expect(body.state.label).to.equal('To transcode')
@@ -154,7 +269,7 @@ describe('Test video transcoding', function () {
 
       // Should have my video
       const resMyVideos = await getMyVideos(servers[1].url, servers[1].accessToken, 0, 10)
-      const videoToFindInMine = resMyVideos.body.data.find(v => v.name === 'waiting video')
+      const videoToFindInMine = resMyVideos.body.data.find(v => v.name === videoAttributes.name)
       expect(videoToFindInMine).not.to.be.undefined
       expect(videoToFindInMine.state.id).to.equal(VideoState.TO_TRANSCODE)
       expect(videoToFindInMine.state.label).to.equal('To transcode')
@@ -162,11 +277,11 @@ describe('Test video transcoding', function () {
 
       // Should not list this video
       const resVideos = await getVideosList(servers[1].url)
-      const videoToFindInList = resVideos.body.data.find(v => v.name === 'waiting video')
+      const videoToFindInList = resVideos.body.data.find(v => v.name === videoAttributes.name)
       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)
@@ -185,7 +300,274 @@ describe('Test video transcoding', function () {
     }
   })
 
+  it('Should respect maximum bitrate values', async function () {
+    this.timeout(160000)
+
+    let tempFixturePath: string
+
+    {
+      tempFixturePath = await generateHighBitrateVideo()
+
+      const bitrate = await getVideoFileBitrate(tempFixturePath)
+      expect(bitrate).to.be.above(getMaxBitrate(VideoResolution.H_1080P, 25, VIDEO_TRANSCODING_FPS))
+    }
+
+    const videoAttributes = {
+      name: 'high bitrate video',
+      description: 'high bitrate video',
+      fixture: tempFixturePath
+    }
+
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
+
+    await waitJobs(servers)
+
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+
+      for (const resolution of [ '240', '360', '480', '720', '1080' ]) {
+        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)
+
+        expect(resolution2.videoFileResolution.toString()).to.equal(resolution)
+        expect(bitrate).to.be.below(getMaxBitrate(resolution2.videoFileResolution, fps, VIDEO_TRANSCODING_FPS))
+      }
+    }
+  })
+
+  it('Should accept and transcode additional extensions', async function () {
+    this.timeout(300000)
+
+    let tempFixturePath: string
+
+    {
+      tempFixturePath = await generateHighBitrateVideo()
+
+      const bitrate = await getVideoFileBitrate(tempFixturePath)
+      expect(bitrate).to.be.above(getMaxBitrate(VideoResolution.H_1080P, 25, VIDEO_TRANSCODING_FPS))
+    }
+
+    for (const fixture of [ 'video_short.mkv', 'video_short.avi' ]) {
+      const videoAttributes = {
+        name: fixture,
+        fixture
+      }
+
+      await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
+
+      await waitJobs(servers)
+
+      for (const server of servers) {
+        const res = await getVideosList(server.url)
+
+        const video = res.body.data.find(v => v.name === videoAttributes.name)
+        const res2 = await getVideo(server.url, video.id)
+        const videoDetails = res2.body
+
+        expect(videoDetails.files).to.have.lengthOf(4)
+
+        const magnetUri = videoDetails.files[0].magnetUri
+        expect(magnetUri).to.contain('.mp4')
+      }
+    }
+  })
+
+  it('Should correctly detect if quick transcode is possible', async function () {
+    this.timeout(10000)
+
+    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)
+
+    const videoAttributesArg = { name: 'audio_with_preview', previewfile: 'preview.jpg', fixture: 'sample.ogg' }
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributesArg)
+
+    await waitJobs(servers)
+
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === 'audio_with_preview')
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails: VideoDetails = res2.body
+
+      expect(videoDetails.files).to.have.lengthOf(1)
+
+      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')
+    }
+  })
+
+  it('Should upload an audio file and choose a default background image', async function () {
+    this.timeout(60000)
+
+    const videoAttributesArg = { name: 'audio_without_preview', fixture: 'sample.ogg' }
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributesArg)
+
+    await waitJobs(servers)
+
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === 'audio_without_preview')
+      const res2 = await getVideo(server.url, video.id)
+      const videoDetails = res2.body
+
+      expect(videoDetails.files).to.have.lengthOf(1)
+
+      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')
+    }
+  })
+
+  it('Should downscale to the closest divisor standard framerate', async function () {
+    this.timeout(200000)
+
+    let tempFixturePath: string
+
+    {
+      tempFixturePath = await generateVideoWithFramerate(59)
+
+      const fps = await getVideoFileFPS(tempFixturePath)
+      expect(fps).to.be.equal(59)
+    }
+
+    const videoAttributes = {
+      name: '59fps video',
+      description: '59fps video',
+      fixture: tempFixturePath
+    }
+
+    await uploadVideo(servers[1].url, servers[1].accessToken, videoAttributes)
+
+    await waitJobs(servers)
+
+    for (const server of servers) {
+      const res = await getVideosList(server.url)
+
+      const video = res.body.data.find(v => v.name === videoAttributes.name)
+
+      {
+        const path = buildServerDirectory(servers[1], join('videos', video.uuid + '-240.mp4'))
+        const fps = await getVideoFileFPS(path)
+        expect(fps).to.be.equal(25)
+      }
+
+      {
+        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(160000)
+
+    const config = {
+      transcoding: {
+        enabled: true,
+        resolutions: {
+          '240p': true,
+          '360p': true,
+          '480p': true,
+          '720p': true,
+          '1080p': 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) {
+      expect(await getServerFileSize(servers[1], `videos/${videoUUID}-${r}.mp4`)).to.be.below(60000)
+    }
+  })
+
+  it('Should provide valid ffprobe data', async function () {
+    this.timeout(160000)
+
+    const videoUUID = (await uploadVideoAndGetId({ server: servers[1], videoName: 'ffprobe data' })).uuid
+    await waitJobs(servers)
+
+    {
+      const path = buildServerDirectory(servers[1], join('videos', videoUUID + '-240.mp4'))
+      const metadata = await getMetadataFromFile(path)
+
+      // expected format properties
+      for (const p of [
+        'tags.encoder',
+        'format_long_name',
+        'size',
+        'bit_rate'
+      ]) {
+        expect(metadata.format).to.have.nested.property(p)
+      }
+
+      // expected stream properties
+      for (const p of [
+        'codec_long_name',
+        'profile',
+        'width',
+        'height',
+        'display_aspect_ratio',
+        'avg_frame_rate',
+        'pix_fmt'
+      ]) {
+        expect(metadata.streams[0]).to.have.nested.property(p)
+      }
+
+      expect(metadata).to.not.have.nested.property('format.filename')
+    }
+
+    for (const server of servers) {
+      const res2 = await getVideo(server.url, videoUUID)
+      const videoDetails: VideoDetails = res2.body
+
+      const videoFiles = videoDetails.files
+                                     .concat(videoDetails.streamingPlaylists[0].files)
+      expect(videoFiles).to.have.lengthOf(8)
+
+      for (const file of videoFiles) {
+        expect(file.metadata).to.be.undefined
+        expect(file.metadataUrl).to.exist
+        expect(file.metadataUrl).to.contain(servers[1].url)
+        expect(file.metadataUrl).to.contain(videoUUID)
+
+        const res3 = await getVideoFileMetadataUrl(file.metadataUrl)
+        const metadata: FfprobeData = res3.body
+        expect(metadata).to.have.nested.property('format.size')
+      }
+    }
+  })
+
   after(async function () {
-    killallServers(servers)
+    await cleanupTests(servers)
   })
 })