Add basic video editor support

1 files changed, 373 insertions, 0 deletions

diff --git a/server/lib/transcoding/transcoding.ts b/server/lib/transcoding/transcoding.ts
new file mode 100644
index 000000000..d55364e25
--- /dev/null
+++ b/server/lib/transcoding/transcoding.ts
@@ -0,0 +1,373 @@
+import { Job } from 'bull'
+import { copyFile, ensureDir, move, remove, stat } from 'fs-extra'
+import { basename, extname as extnameUtil, join } from 'path'
+import { toEven } from '@server/helpers/core-utils'
+import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
+import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoFullLight } from '@server/types/models'
+import { VideoResolution, VideoStorage } from '../../../shared/models/videos'
+import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
+import {
+  canDoQuickTranscode,
+  getVideoStreamDuration,
+  buildFileMetadata,
+  getVideoStreamFPS,
+  transcodeVOD,
+  TranscodeVODOptions,
+  TranscodeVODOptionsType
+} from '../../helpers/ffmpeg'
+import { CONFIG } from '../../initializers/config'
+import { P2P_MEDIA_LOADER_PEER_VERSION } from '../../initializers/constants'
+import { VideoFileModel } from '../../models/video/video-file'
+import { VideoStreamingPlaylistModel } from '../../models/video/video-streaming-playlist'
+import { updateMasterHLSPlaylist, updateSha256VODSegments } from '../hls'
+import {
+  generateHLSMasterPlaylistFilename,
+  generateHlsSha256SegmentsFilename,
+  generateHLSVideoFilename,
+  generateWebTorrentVideoFilename,
+  getHlsResolutionPlaylistFilename
+} from '../paths'
+import { VideoPathManager } from '../video-path-manager'
+import { VideoTranscodingProfilesManager } from './default-transcoding-profiles'
+
+/**
+ *
+ * Functions that run transcoding functions, update the database, cleanup files, create torrent files...
+ * Mainly called by the job queue
+ *
+ */
+
+// Optimize the original video file and replace it. The resolution is not changed.
+function optimizeOriginalVideofile (video: MVideoFullLight, inputVideoFile: MVideoFile, job?: Job) {
+  const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
+  const newExtname = '.mp4'
+
+  return VideoPathManager.Instance.makeAvailableVideoFile(inputVideoFile.withVideoOrPlaylist(video), async videoInputPath => {
+    const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
+
+    const transcodeType: TranscodeVODOptionsType = await canDoQuickTranscode(videoInputPath)
+      ? 'quick-transcode'
+      : 'video'
+
+    const resolution = toEven(inputVideoFile.resolution)
+
+    const transcodeOptions: TranscodeVODOptions = {
+      type: transcodeType,
+
+      inputPath: videoInputPath,
+      outputPath: videoTranscodedPath,
+
+      availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+      profile: CONFIG.TRANSCODING.PROFILE,
+
+      resolution,
+
+      job
+    }
+
+    // Could be very long!
+    await transcodeVOD(transcodeOptions)
+
+    // Important to do this before getVideoFilename() to take in account the new filename
+    inputVideoFile.extname = newExtname
+    inputVideoFile.filename = generateWebTorrentVideoFilename(resolution, newExtname)
+    inputVideoFile.storage = VideoStorage.FILE_SYSTEM
+
+    const videoOutputPath = VideoPathManager.Instance.getFSVideoFileOutputPath(video, inputVideoFile)
+
+    const { videoFile } = await onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
+    await remove(videoInputPath)
+
+    return { transcodeType, videoFile }
+  })
+}
+
+// Transcode the original video file to a lower resolution
+// We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
+function transcodeNewWebTorrentResolution (video: MVideoFullLight, resolution: VideoResolution, isPortrait: boolean, job: Job) {
+  const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
+  const extname = '.mp4'
+
+  return VideoPathManager.Instance.makeAvailableVideoFile(video.getMaxQualityFile().withVideoOrPlaylist(video), async videoInputPath => {
+    const newVideoFile = new VideoFileModel({
+      resolution,
+      extname,
+      filename: generateWebTorrentVideoFilename(resolution, extname),
+      size: 0,
+      videoId: video.id
+    })
+
+    const videoOutputPath = VideoPathManager.Instance.getFSVideoFileOutputPath(video, newVideoFile)
+    const videoTranscodedPath = join(transcodeDirectory, newVideoFile.filename)
+
+    const transcodeOptions = resolution === VideoResolution.H_NOVIDEO
+      ? {
+        type: 'only-audio' as 'only-audio',
+
+        inputPath: videoInputPath,
+        outputPath: videoTranscodedPath,
+
+        availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+        profile: CONFIG.TRANSCODING.PROFILE,
+
+        resolution,
+
+        job
+      }
+      : {
+        type: 'video' as 'video',
+        inputPath: videoInputPath,
+        outputPath: videoTranscodedPath,
+
+        availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+        profile: CONFIG.TRANSCODING.PROFILE,
+
+        resolution,
+        isPortraitMode: isPortrait,
+
+        job
+      }
+
+    await transcodeVOD(transcodeOptions)
+
+    return onWebTorrentVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
+  })
+}
+
+// Merge an image with an audio file to create a video
+function mergeAudioVideofile (video: MVideoFullLight, resolution: VideoResolution, job: Job) {
+  const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
+  const newExtname = '.mp4'
+
+  const inputVideoFile = video.getMinQualityFile()
+
+  return VideoPathManager.Instance.makeAvailableVideoFile(inputVideoFile.withVideoOrPlaylist(video), async audioInputPath => {
+    const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
+
+    // If the user updates the video preview during transcoding
+    const previewPath = video.getPreview().getPath()
+    const tmpPreviewPath = join(CONFIG.STORAGE.TMP_DIR, basename(previewPath))
+    await copyFile(previewPath, tmpPreviewPath)
+
+    const transcodeOptions = {
+      type: 'merge-audio' as 'merge-audio',
+
+      inputPath: tmpPreviewPath,
+      outputPath: videoTranscodedPath,
+
+      availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+      profile: CONFIG.TRANSCODING.PROFILE,
+
+      audioPath: audioInputPath,
+      resolution,
+
+      job
+    }
+
+    try {
+      await transcodeVOD(transcodeOptions)
+
+      await remove(audioInputPath)
+      await remove(tmpPreviewPath)
+    } catch (err) {
+      await remove(tmpPreviewPath)
+      throw err
+    }
+
+    // Important to do this before getVideoFilename() to take in account the new file extension
+    inputVideoFile.extname = newExtname
+    inputVideoFile.resolution = resolution
+    inputVideoFile.filename = generateWebTorrentVideoFilename(inputVideoFile.resolution, newExtname)
+
+    const videoOutputPath = VideoPathManager.Instance.getFSVideoFileOutputPath(video, inputVideoFile)
+    // ffmpeg generated a new video file, so update the video duration
+    // See https://trac.ffmpeg.org/ticket/5456
+    video.duration = await getVideoStreamDuration(videoTranscodedPath)
+    await video.save()
+
+    return onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
+  })
+}
+
+// Concat TS segments from a live video to a fragmented mp4 HLS playlist
+async function generateHlsPlaylistResolutionFromTS (options: {
+  video: MVideoFullLight
+  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: MVideoFullLight
+  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
+  })
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  generateHlsPlaylistResolution,
+  generateHlsPlaylistResolutionFromTS,
+  optimizeOriginalVideofile,
+  transcodeNewWebTorrentResolution,
+  mergeAudioVideofile
+}
+
+// ---------------------------------------------------------------------------
+
+async function onWebTorrentVideoFileTranscoding (
+  video: MVideoFullLight,
+  videoFile: MVideoFile,
+  transcodingPath: string,
+  outputPath: string
+) {
+  const stats = await stat(transcodingPath)
+  const fps = await getVideoStreamFPS(transcodingPath)
+  const metadata = await buildFileMetadata(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, videoFile }
+}
+
+async function generateHlsPlaylistCommon (options: {
+  type: 'hls' | 'hls-from-ts'
+  video: MVideoFullLight
+  inputPath: string
+  resolution: VideoResolution
+  copyCodecs?: boolean
+  isAAC?: boolean
+  isPortraitMode: boolean
+
+  job?: Job
+}) {
+  const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC, job } = options
+  const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
+
+  const videoTranscodedBasePath = join(transcodeDirectory, type)
+  await ensureDir(videoTranscodedBasePath)
+
+  const videoFilename = generateHLSVideoFilename(resolution)
+  const resolutionPlaylistFilename = getHlsResolutionPlaylistFilename(videoFilename)
+  const resolutionPlaylistFileTranscodePath = join(videoTranscodedBasePath, resolutionPlaylistFilename)
+
+  const transcodeOptions = {
+    type,
+
+    inputPath,
+    outputPath: resolutionPlaylistFileTranscodePath,
+
+    availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
+    profile: CONFIG.TRANSCODING.PROFILE,
+
+    resolution,
+    copyCodecs,
+    isPortraitMode,
+
+    isAAC,
+
+    hlsPlaylist: {
+      videoFilename
+    },
+
+    job
+  }
+
+  await transcodeVOD(transcodeOptions)
+
+  // Create or update the playlist
+  const playlist = await VideoStreamingPlaylistModel.loadOrGenerate(video)
+
+  if (!playlist.playlistFilename) {
+    playlist.playlistFilename = generateHLSMasterPlaylistFilename(video.isLive)
+  }
+
+  if (!playlist.segmentsSha256Filename) {
+    playlist.segmentsSha256Filename = generateHlsSha256SegmentsFilename(video.isLive)
+  }
+
+  playlist.p2pMediaLoaderInfohashes = []
+  playlist.p2pMediaLoaderPeerVersion = P2P_MEDIA_LOADER_PEER_VERSION
+
+  playlist.type = VideoStreamingPlaylistType.HLS
+
+  await playlist.save()
+
+  // Build the new playlist file
+  const extname = extnameUtil(videoFilename)
+  const newVideoFile = new VideoFileModel({
+    resolution,
+    extname,
+    size: 0,
+    filename: videoFilename,
+    fps: -1,
+    videoStreamingPlaylistId: playlist.id
+  })
+
+  const videoFilePath = VideoPathManager.Instance.getFSVideoFileOutputPath(playlist, newVideoFile)
+
+  // Move files from tmp transcoded directory to the appropriate place
+  await ensureDir(VideoPathManager.Instance.getFSHLSOutputPath(video))
+
+  // Move playlist file
+  const resolutionPlaylistPath = VideoPathManager.Instance.getFSHLSOutputPath(video, resolutionPlaylistFilename)
+  await move(resolutionPlaylistFileTranscodePath, resolutionPlaylistPath, { overwrite: true })
+  // Move video file
+  await move(join(videoTranscodedBasePath, videoFilename), videoFilePath, { overwrite: true })
+
+  const stats = await stat(videoFilePath)
+
+  newVideoFile.size = stats.size
+  newVideoFile.fps = await getVideoStreamFPS(videoFilePath)
+  newVideoFile.metadata = await buildFileMetadata(videoFilePath)
+
+  await createTorrentAndSetInfoHash(playlist, newVideoFile)
+
+  const savedVideoFile = await VideoFileModel.customUpsert(newVideoFile, 'streaming-playlist', undefined)
+
+  const playlistWithFiles = playlist as MStreamingPlaylistFilesVideo
+  playlistWithFiles.VideoFiles = await playlist.$get('VideoFiles')
+  playlist.assignP2PMediaLoaderInfoHashes(video, playlistWithFiles.VideoFiles)
+
+  await playlist.save()
+
+  video.setHLSPlaylist(playlist)
+
+  await updateMasterHLSPlaylist(video, playlistWithFiles)
+  await updateSha256VODSegments(video, playlistWithFiles)
+
+  return { resolutionPlaylistPath, videoFile: savedVideoFile }
+}