server/lib/transcoding/video-transcoding.ts

   1 import { Job } from 'bull'
   2 import { copyFile, ensureDir, move, remove, stat } from 'fs-extra'
   3 import { basename, extname as extnameUtil, join } from 'path'
   4 import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
   5 import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoFullLight } from '@server/types/models'
   6 import { VideoResolution } from '../../../shared/models/videos'
   7 import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
   8 import { transcode, TranscodeOptions, TranscodeOptionsType } from '../../helpers/ffmpeg-utils'
   9 import { canDoQuickTranscode, getDurationFromVideoFile, getMetadataFromFile, getVideoFileFPS } from '../../helpers/ffprobe-utils'
  10 import { logger } from '../../helpers/logger'
  11 import { CONFIG } from '../../initializers/config'
  12 import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION, WEBSERVER } from '../../initializers/constants'
  13 import { VideoFileModel } from '../../models/video/video-file'
  14 import { VideoStreamingPlaylistModel } from '../../models/video/video-streaming-playlist'
  15 import { updateMasterHLSPlaylist, updateSha256VODSegments } from '../hls'
  16 import { generateVideoFilename, generateVideoStreamingPlaylistName, getVideoFilePath } from '../video-paths'
  17 import { VideoTranscodingProfilesManager } from './video-transcoding-profiles'
  18
  19 /**
  20  *
  21  * Functions that run transcoding functions, update the database, cleanup files, create torrent files...
  22  * Mainly called by the job queue
  23  *
  24  */
  25
  26 // Optimize the original video file and replace it. The resolution is not changed.
  27 async function optimizeOriginalVideofile (video: MVideoFullLight, inputVideoFile: MVideoFile, job?: Job) {
  28   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
  29   const newExtname = '.mp4'
  30
  31   const videoInputPath = getVideoFilePath(video, inputVideoFile)
  32   const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
  33
  34   const transcodeType: TranscodeOptionsType = await canDoQuickTranscode(videoInputPath)
  35     ? 'quick-transcode'
  36     : 'video'
  37
  38   const transcodeOptions: TranscodeOptions = {
  39     type: transcodeType,
  40
  41     inputPath: videoInputPath,
  42     outputPath: videoTranscodedPath,
  43
  44     availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
  45     profile: CONFIG.TRANSCODING.PROFILE,
  46
  47     resolution: inputVideoFile.resolution,
  48
  49     job
  50   }
  51
  52   // Could be very long!
  53   await transcode(transcodeOptions)
  54
  55   try {
  56     await remove(videoInputPath)
  57
  58     // Important to do this before getVideoFilename() to take in account the new filename
  59     inputVideoFile.extname = newExtname
  60     inputVideoFile.filename = generateVideoFilename(video, false, inputVideoFile.resolution, newExtname)
  61
  62     const videoOutputPath = getVideoFilePath(video, inputVideoFile)
  63
  64     await onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
  65
  66     return transcodeType
  67   } catch (err) {
  68     // Auto destruction...
  69     video.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
  70
  71     throw err
  72   }
  73 }
  74
  75 // Transcode the original video file to a lower resolution.
  76 async function transcodeNewWebTorrentResolution (video: MVideoFullLight, resolution: VideoResolution, isPortrait: boolean, job: Job) {
  77   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
  78   const extname = '.mp4'
  79
  80   // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
  81   const videoInputPath = getVideoFilePath(video, video.getMaxQualityFile())
  82
  83   const newVideoFile = new VideoFileModel({
  84     resolution,
  85     extname,
  86     filename: generateVideoFilename(video, false, resolution, extname),
  87     size: 0,
  88     videoId: video.id
  89   })
  90
  91   const videoOutputPath = getVideoFilePath(video, newVideoFile)
  92   const videoTranscodedPath = join(transcodeDirectory, newVideoFile.filename)
  93
  94   const transcodeOptions = resolution === VideoResolution.H_NOVIDEO
  95     ? {
  96       type: 'only-audio' as 'only-audio',
  97
  98       inputPath: videoInputPath,
  99       outputPath: videoTranscodedPath,
 100
 101       availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
 102       profile: CONFIG.TRANSCODING.PROFILE,
 103
 104       resolution,
 105
 106       job
 107     }
 108     : {
 109       type: 'video' as 'video',
 110       inputPath: videoInputPath,
 111       outputPath: videoTranscodedPath,
 112
 113       availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
 114       profile: CONFIG.TRANSCODING.PROFILE,
 115
 116       resolution,
 117       isPortraitMode: isPortrait,
 118
 119       job
 120     }
 121
 122   await transcode(transcodeOptions)
 123
 124   return onWebTorrentVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
 125 }
 126
 127 // Merge an image with an audio file to create a video
 128 async function mergeAudioVideofile (video: MVideoFullLight, resolution: VideoResolution, job: Job) {
 129   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
 130   const newExtname = '.mp4'
 131
 132   const inputVideoFile = video.getMinQualityFile()
 133
 134   const audioInputPath = getVideoFilePath(video, inputVideoFile)
 135   const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
 136
 137   // If the user updates the video preview during transcoding
 138   const previewPath = video.getPreview().getPath()
 139   const tmpPreviewPath = join(CONFIG.STORAGE.TMP_DIR, basename(previewPath))
 140   await copyFile(previewPath, tmpPreviewPath)
 141
 142   const transcodeOptions = {
 143     type: 'merge-audio' as 'merge-audio',
 144
 145     inputPath: tmpPreviewPath,
 146     outputPath: videoTranscodedPath,
 147
 148     availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
 149     profile: CONFIG.TRANSCODING.PROFILE,
 150
 151     audioPath: audioInputPath,
 152     resolution,
 153
 154     job
 155   }
 156
 157   try {
 158     await transcode(transcodeOptions)
 159
 160     await remove(audioInputPath)
 161     await remove(tmpPreviewPath)
 162   } catch (err) {
 163     await remove(tmpPreviewPath)
 164     throw err
 165   }
 166
 167   // Important to do this before getVideoFilename() to take in account the new file extension
 168   inputVideoFile.extname = newExtname
 169   inputVideoFile.filename = generateVideoFilename(video, false, inputVideoFile.resolution, newExtname)
 170
 171   const videoOutputPath = getVideoFilePath(video, inputVideoFile)
 172   // ffmpeg generated a new video file, so update the video duration
 173   // See https://trac.ffmpeg.org/ticket/5456
 174   video.duration = await getDurationFromVideoFile(videoTranscodedPath)
 175   await video.save()
 176
 177   return onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
 178 }
 179
 180 // Concat TS segments from a live video to a fragmented mp4 HLS playlist
 181 async function generateHlsPlaylistResolutionFromTS (options: {
 182   video: MVideoFullLight
 183   concatenatedTsFilePath: string
 184   resolution: VideoResolution
 185   isPortraitMode: boolean
 186   isAAC: boolean
 187 }) {
 188   return generateHlsPlaylistCommon({
 189     video: options.video,
 190     resolution: options.resolution,
 191     isPortraitMode: options.isPortraitMode,
 192     inputPath: options.concatenatedTsFilePath,
 193     type: 'hls-from-ts' as 'hls-from-ts',
 194     isAAC: options.isAAC
 195   })
 196 }
 197
 198 // Generate an HLS playlist from an input file, and update the master playlist
 199 function generateHlsPlaylistResolution (options: {
 200   video: MVideoFullLight
 201   videoInputPath: string
 202   resolution: VideoResolution
 203   copyCodecs: boolean
 204   isPortraitMode: boolean
 205   job?: Job
 206 }) {
 207   return generateHlsPlaylistCommon({
 208     video: options.video,
 209     resolution: options.resolution,
 210     copyCodecs: options.copyCodecs,
 211     isPortraitMode: options.isPortraitMode,
 212     inputPath: options.videoInputPath,
 213     type: 'hls' as 'hls',
 214     job: options.job
 215   })
 216 }
 217
 218 // ---------------------------------------------------------------------------
 219
 220 export {
 221   generateHlsPlaylistResolution,
 222   generateHlsPlaylistResolutionFromTS,
 223   optimizeOriginalVideofile,
 224   transcodeNewWebTorrentResolution,
 225   mergeAudioVideofile
 226 }
 227
 228 // ---------------------------------------------------------------------------
 229
 230 async function onWebTorrentVideoFileTranscoding (
 231   video: MVideoFullLight,
 232   videoFile: MVideoFile,
 233   transcodingPath: string,
 234   outputPath: string
 235 ) {
 236   const stats = await stat(transcodingPath)
 237   const fps = await getVideoFileFPS(transcodingPath)
 238   const metadata = await getMetadataFromFile(transcodingPath)
 239
 240   await move(transcodingPath, outputPath, { overwrite: true })
 241
 242   videoFile.size = stats.size
 243   videoFile.fps = fps
 244   videoFile.metadata = metadata
 245
 246   await createTorrentAndSetInfoHash(video, videoFile)
 247
 248   await VideoFileModel.customUpsert(videoFile, 'video', undefined)
 249   video.VideoFiles = await video.$get('VideoFiles')
 250
 251   return video
 252 }
 253
 254 async function generateHlsPlaylistCommon (options: {
 255   type: 'hls' | 'hls-from-ts'
 256   video: MVideoFullLight
 257   inputPath: string
 258   resolution: VideoResolution
 259   copyCodecs?: boolean
 260   isAAC?: boolean
 261   isPortraitMode: boolean
 262
 263   job?: Job
 264 }) {
 265   const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC, job } = options
 266   const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
 267
 268   const videoTranscodedBasePath = join(transcodeDirectory, type)
 269   await ensureDir(videoTranscodedBasePath)
 270
 271   const videoFilename = generateVideoStreamingPlaylistName(video.uuid, resolution)
 272   const playlistFilename = VideoStreamingPlaylistModel.getHlsPlaylistFilename(resolution)
 273   const playlistFileTranscodePath = join(videoTranscodedBasePath, playlistFilename)
 274
 275   const transcodeOptions = {
 276     type,
 277
 278     inputPath,
 279     outputPath: playlistFileTranscodePath,
 280
 281     availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
 282     profile: CONFIG.TRANSCODING.PROFILE,
 283
 284     resolution,
 285     copyCodecs,
 286     isPortraitMode,
 287
 288     isAAC,
 289
 290     hlsPlaylist: {
 291       videoFilename
 292     },
 293
 294     job
 295   }
 296
 297   await transcode(transcodeOptions)
 298
 299   const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid)
 300
 301   // Create or update the playlist
 302   const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({
 303     videoId: video.id,
 304     playlistUrl,
 305     segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive),
 306     p2pMediaLoaderInfohashes: [],
 307     p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
 308
 309     type: VideoStreamingPlaylistType.HLS
 310   }, { returning: true }) as [ MStreamingPlaylistFilesVideo, boolean ]
 311   videoStreamingPlaylist.Video = video
 312
 313   // Build the new playlist file
 314   const extname = extnameUtil(videoFilename)
 315   const newVideoFile = new VideoFileModel({
 316     resolution,
 317     extname,
 318     size: 0,
 319     filename: generateVideoFilename(video, true, resolution, extname),
 320     fps: -1,
 321     videoStreamingPlaylistId: videoStreamingPlaylist.id
 322   })
 323
 324   const videoFilePath = getVideoFilePath(videoStreamingPlaylist, newVideoFile)
 325
 326   // Move files from tmp transcoded directory to the appropriate place
 327   const baseHlsDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
 328   await ensureDir(baseHlsDirectory)
 329
 330   // Move playlist file
 331   const playlistPath = join(baseHlsDirectory, playlistFilename)
 332   await move(playlistFileTranscodePath, playlistPath, { overwrite: true })
 333   // Move video file
 334   await move(join(videoTranscodedBasePath, videoFilename), videoFilePath, { overwrite: true })
 335
 336   const stats = await stat(videoFilePath)
 337
 338   newVideoFile.size = stats.size
 339   newVideoFile.fps = await getVideoFileFPS(videoFilePath)
 340   newVideoFile.metadata = await getMetadataFromFile(videoFilePath)
 341
 342   await createTorrentAndSetInfoHash(videoStreamingPlaylist, newVideoFile)
 343
 344   await VideoFileModel.customUpsert(newVideoFile, 'streaming-playlist', undefined)
 345   videoStreamingPlaylist.VideoFiles = await videoStreamingPlaylist.$get('VideoFiles')
 346
 347   videoStreamingPlaylist.p2pMediaLoaderInfohashes = VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(
 348     playlistUrl, videoStreamingPlaylist.VideoFiles
 349   )
 350   await videoStreamingPlaylist.save()
 351
 352   video.setHLSPlaylist(videoStreamingPlaylist)
 353
 354   await updateMasterHLSPlaylist(video)
 355   await updateSha256VODSegments(video)
 356
 357   return playlistPath
 358 }