]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/lib/video-transcoding.ts
Use a profile manager for transcoding
[github/Chocobozzz/PeerTube.git] / server / lib / video-transcoding.ts
index c62b3c1ceed9be66f12ae0162befcda5a5f455d8..c4b3425d1e86edbac831d5f10362048337f74d98 100644 (file)
@@ -1,35 +1,33 @@
-import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION, WEBSERVER } from '../initializers/constants'
-import { basename, extname as extnameUtil, join } from 'path'
-import {
-  canDoQuickTranscode,
-  getDurationFromVideoFile,
-  getMetadataFromFile,
-  getVideoFileFPS,
-  transcode,
-  TranscodeOptions,
-  TranscodeOptionsType
-} from '../helpers/ffmpeg-utils'
+import { Job } from 'bull'
 import { copyFile, ensureDir, move, remove, stat } from 'fs-extra'
-import { logger } from '../helpers/logger'
+import { basename, extname as extnameUtil, join } from 'path'
+import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
+import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoWithAllFiles, MVideoWithFile } from '@server/types/models'
 import { VideoResolution } from '../../shared/models/videos'
-import { VideoFileModel } from '../models/video/video-file'
-import { updateMasterHLSPlaylist, updateSha256VODSegments } from './hls'
-import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
 import { VideoStreamingPlaylistType } from '../../shared/models/videos/video-streaming-playlist.type'
+import { transcode, TranscodeOptions, TranscodeOptionsType } from '../helpers/ffmpeg-utils'
+import { canDoQuickTranscode, getDurationFromVideoFile, getMetadataFromFile, getVideoFileFPS } from '../helpers/ffprobe-utils'
+import { logger } from '../helpers/logger'
 import { CONFIG } from '../initializers/config'
-import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoWithAllFiles, MVideoWithFile } from '@server/types/models'
-import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
+import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION, WEBSERVER } from '../initializers/constants'
+import { VideoFileModel } from '../models/video/video-file'
+import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
+import { updateMasterHLSPlaylist, updateSha256VODSegments } from './hls'
 import { generateVideoStreamingPlaylistName, getVideoFilename, getVideoFilePath } from './video-paths'
-import { spawn } from 'child_process'
+import { VideoTranscodingProfilesManager } from './video-transcoding-profiles'
 
 /**
- * Optimize the original video file and replace it. The resolution is not changed.
+ *
+ * Functions that run transcoding functions, update the database, cleanup files, create torrent files...
+ * Mainly called by the job queue
+ *
  */
-async function optimizeOriginalVideofile (video: MVideoWithFile, inputVideoFileArg?: MVideoFile) {
+
+// Optimize the original video file and replace it. The resolution is not changed.
+async function optimizeOriginalVideofile (video: MVideoWithFile, inputVideoFile: MVideoFile, job?: Job) {
   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
   const newExtname = '.mp4'
 
-  const inputVideoFile = inputVideoFileArg || video.getMaxQualityFile()
   const videoInputPath = getVideoFilePath(video, inputVideoFile)
   const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
 
@@ -39,9 +37,16 @@ async function optimizeOriginalVideofile (video: MVideoWithFile, inputVideoFileA
 
   const transcodeOptions: TranscodeOptions = {
     type: transcodeType,
+
     inputPath: videoInputPath,
     outputPath: videoTranscodedPath,
-    resolution: inputVideoFile.resolution
+
+    availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+    profile: 'default',
+
+    resolution: inputVideoFile.resolution,
+
+    job
   }
 
   // Could be very long!
@@ -55,7 +60,9 @@ async function optimizeOriginalVideofile (video: MVideoWithFile, inputVideoFileA
 
     const videoOutputPath = getVideoFilePath(video, inputVideoFile)
 
-    await onVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
+    await onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
+
+    return transcodeType
   } catch (err) {
     // Auto destruction...
     video.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
@@ -64,10 +71,8 @@ async function optimizeOriginalVideofile (video: MVideoWithFile, inputVideoFileA
   }
 }
 
-/**
- * Transcode the original video file to a lower resolution.
- */
-async function transcodeNewResolution (video: MVideoWithFile, resolution: VideoResolution, isPortrait: boolean) {
+// Transcode the original video file to a lower resolution.
+async function transcodeNewWebTorrentResolution (video: MVideoWithFile, resolution: VideoResolution, isPortrait: boolean, job: Job) {
   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
   const extname = '.mp4'
 
@@ -86,24 +91,38 @@ async function transcodeNewResolution (video: MVideoWithFile, resolution: VideoR
   const transcodeOptions = resolution === VideoResolution.H_NOVIDEO
     ? {
       type: 'only-audio' as 'only-audio',
+
       inputPath: videoInputPath,
       outputPath: videoTranscodedPath,
-      resolution
+
+      availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+      profile: 'default',
+
+      resolution,
+
+      job
     }
     : {
       type: 'video' as 'video',
       inputPath: videoInputPath,
       outputPath: videoTranscodedPath,
+
+      availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+      profile: 'default',
+
       resolution,
-      isPortraitMode: isPortrait
+      isPortraitMode: isPortrait,
+
+      job
     }
 
   await transcode(transcodeOptions)
 
-  return onVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
+  return onWebTorrentVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
 }
 
-async function mergeAudioVideofile (video: MVideoWithAllFiles, resolution: VideoResolution) {
+// Merge an image with an audio file to create a video
+async function mergeAudioVideofile (video: MVideoWithAllFiles, resolution: VideoResolution, job: Job) {
   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
   const newExtname = '.mp4'
 
@@ -119,10 +138,17 @@ async function mergeAudioVideofile (video: MVideoWithAllFiles, resolution: Video
 
   const transcodeOptions = {
     type: 'merge-audio' as 'merge-audio',
+
     inputPath: tmpPreviewPath,
     outputPath: videoTranscodedPath,
+
+    availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+    profile: 'default',
+
     audioPath: audioInputPath,
-    resolution
+    resolution,
+
+    job
   }
 
   try {
@@ -144,17 +170,106 @@ async function mergeAudioVideofile (video: MVideoWithAllFiles, resolution: Video
   video.duration = await getDurationFromVideoFile(videoTranscodedPath)
   await video.save()
 
-  return onVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
+  return onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
 }
 
-async function generateHlsPlaylist (options: {
+// Concat TS segments from a live video to a fragmented mp4 HLS playlist
+async function generateHlsPlaylistResolutionFromTS (options: {
+  video: MVideoWithFile
+  concatenatedTsFilePath: string
+  resolution: VideoResolution
+  isPortraitMode: boolean
+  isAAC: boolean
+}) {
+  return generateHlsPlaylistCommon({
+    video: options.video,
+    resolution: options.resolution,
+    isPortraitMode: options.isPortraitMode,
+    inputPath: options.concatenatedTsFilePath,
+    type: 'hls-from-ts' as 'hls-from-ts',
+    isAAC: options.isAAC
+  })
+}
+
+// Generate an HLS playlist from an input file, and update the master playlist
+function generateHlsPlaylistResolution (options: {
   video: MVideoWithFile
   videoInputPath: string
   resolution: VideoResolution
   copyCodecs: boolean
   isPortraitMode: boolean
+  job?: Job
+}) {
+  return generateHlsPlaylistCommon({
+    video: options.video,
+    resolution: options.resolution,
+    copyCodecs: options.copyCodecs,
+    isPortraitMode: options.isPortraitMode,
+    inputPath: options.videoInputPath,
+    type: 'hls' as 'hls',
+    job: options.job
+  })
+}
+
+function getEnabledResolutions (type: 'vod' | 'live') {
+  const transcoding = type === 'vod'
+    ? CONFIG.TRANSCODING
+    : CONFIG.LIVE.TRANSCODING
+
+  return Object.keys(transcoding.RESOLUTIONS)
+               .filter(key => transcoding.ENABLED && transcoding.RESOLUTIONS[key] === true)
+               .map(r => parseInt(r, 10))
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  generateHlsPlaylistResolution,
+  generateHlsPlaylistResolutionFromTS,
+  optimizeOriginalVideofile,
+  transcodeNewWebTorrentResolution,
+  mergeAudioVideofile,
+  getEnabledResolutions
+}
+
+// ---------------------------------------------------------------------------
+
+async function onWebTorrentVideoFileTranscoding (
+  video: MVideoWithFile,
+  videoFile: MVideoFile,
+  transcodingPath: string,
+  outputPath: string
+) {
+  const stats = await stat(transcodingPath)
+  const fps = await getVideoFileFPS(transcodingPath)
+  const metadata = await getMetadataFromFile(transcodingPath)
+
+  await move(transcodingPath, outputPath, { overwrite: true })
+
+  videoFile.size = stats.size
+  videoFile.fps = fps
+  videoFile.metadata = metadata
+
+  await createTorrentAndSetInfoHash(video, videoFile)
+
+  await VideoFileModel.customUpsert(videoFile, 'video', undefined)
+  video.VideoFiles = await video.$get('VideoFiles')
+
+  return video
+}
+
+async function generateHlsPlaylistCommon (options: {
+  type: 'hls' | 'hls-from-ts'
+  video: MVideoWithFile
+  inputPath: string
+  resolution: VideoResolution
+  copyCodecs?: boolean
+  isAAC?: boolean
+  isPortraitMode: boolean
+
+  job?: Job
 }) {
-  const { video, videoInputPath, resolution, copyCodecs, isPortraitMode } = options
+  const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC, job } = options
 
   const baseHlsDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
   await ensureDir(join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid))
@@ -163,19 +278,26 @@ async function generateHlsPlaylist (options: {
   const videoFilename = generateVideoStreamingPlaylistName(video.uuid, resolution)
 
   const transcodeOptions = {
-    type: 'hls' as 'hls',
-    inputPath: videoInputPath,
+    type,
+
+    inputPath,
     outputPath,
+
+    availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+    profile: 'default',
+
     resolution,
     copyCodecs,
     isPortraitMode,
 
+    isAAC,
+
     hlsPlaylist: {
       videoFilename
-    }
-  }
+    },
 
-  logger.debug('Will run transcode.', { transcodeOptions })
+    job
+  }
 
   await transcode(transcodeOptions)
 
@@ -222,35 +344,5 @@ async function generateHlsPlaylist (options: {
   await updateMasterHLSPlaylist(video)
   await updateSha256VODSegments(video)
 
-  return video
-}
-
-// ---------------------------------------------------------------------------
-
-export {
-  generateHlsPlaylist,
-  optimizeOriginalVideofile,
-  transcodeNewResolution,
-  mergeAudioVideofile
-}
-
-// ---------------------------------------------------------------------------
-
-async function onVideoFileTranscoding (video: MVideoWithFile, videoFile: MVideoFile, transcodingPath: string, outputPath: string) {
-  const stats = await stat(transcodingPath)
-  const fps = await getVideoFileFPS(transcodingPath)
-  const metadata = await getMetadataFromFile(transcodingPath)
-
-  await move(transcodingPath, outputPath, { overwrite: true })
-
-  videoFile.size = stats.size
-  videoFile.fps = fps
-  videoFile.metadata = metadata
-
-  await createTorrentAndSetInfoHash(video, videoFile)
-
-  await VideoFileModel.customUpsert(videoFile, 'video', undefined)
-  video.VideoFiles = await video.$get('VideoFiles')
-
-  return video
+  return outputPath
 }