1 import { copyFile, ensureDir, move, remove, stat } from 'fs-extra'
2 import { basename, extname as extnameUtil, join } from 'path'
3 import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
4 import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoWithAllFiles, MVideoWithFile } from '@server/types/models'
5 import { VideoResolution } from '../../shared/models/videos'
6 import { VideoStreamingPlaylistType } from '../../shared/models/videos/video-streaming-playlist.type'
7 import { transcode, TranscodeOptions, TranscodeOptionsType } from '../helpers/ffmpeg-utils'
8 import { canDoQuickTranscode, getDurationFromVideoFile, getMetadataFromFile, getVideoFileFPS } from '../helpers/ffprobe-utils'
9 import { logger } from '../helpers/logger'
10 import { CONFIG } from '../initializers/config'
11 import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION, WEBSERVER } from '../initializers/constants'
12 import { VideoFileModel } from '../models/video/video-file'
13 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
14 import { updateMasterHLSPlaylist, updateSha256VODSegments } from './hls'
15 import { generateVideoStreamingPlaylistName, getVideoFilename, getVideoFilePath } from './video-paths'
16 import { availableEncoders } from './video-transcoding-profiles'
20 * Functions that run transcoding functions, update the database, cleanup files, create torrent files...
21 * Mainly called by the job queue
25 // Optimize the original video file and replace it. The resolution is not changed.
26 async function optimizeOriginalVideofile (video: MVideoWithFile, inputVideoFileArg?: MVideoFile) {
27 const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
28 const newExtname = '.mp4'
30 const inputVideoFile = inputVideoFileArg || video.getMaxQualityFile()
31 const videoInputPath = getVideoFilePath(video, inputVideoFile)
32 const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
34 const transcodeType: TranscodeOptionsType = await canDoQuickTranscode(videoInputPath)
38 const transcodeOptions: TranscodeOptions = {
41 inputPath: videoInputPath,
42 outputPath: videoTranscodedPath,
47 resolution: inputVideoFile.resolution
50 // Could be very long!
51 await transcode(transcodeOptions)
54 await remove(videoInputPath)
56 // Important to do this before getVideoFilename() to take in account the new file extension
57 inputVideoFile.extname = newExtname
59 const videoOutputPath = getVideoFilePath(video, inputVideoFile)
61 await onVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
65 // Auto destruction...
66 video.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
72 // Transcode the original video file to a lower resolution.
73 async function transcodeNewResolution (video: MVideoWithFile, resolution: VideoResolution, isPortrait: boolean) {
74 const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
75 const extname = '.mp4'
77 // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
78 const videoInputPath = getVideoFilePath(video, video.getMaxQualityFile())
80 const newVideoFile = new VideoFileModel({
86 const videoOutputPath = getVideoFilePath(video, newVideoFile)
87 const videoTranscodedPath = join(transcodeDirectory, getVideoFilename(video, newVideoFile))
89 const transcodeOptions = resolution === VideoResolution.H_NOVIDEO
91 type: 'only-audio' as 'only-audio',
93 inputPath: videoInputPath,
94 outputPath: videoTranscodedPath,
102 type: 'video' as 'video',
103 inputPath: videoInputPath,
104 outputPath: videoTranscodedPath,
110 isPortraitMode: isPortrait
113 await transcode(transcodeOptions)
115 return onVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
118 // Merge an image with an audio file to create a video
119 async function mergeAudioVideofile (video: MVideoWithAllFiles, resolution: VideoResolution) {
120 const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
121 const newExtname = '.mp4'
123 const inputVideoFile = video.getMinQualityFile()
125 const audioInputPath = getVideoFilePath(video, inputVideoFile)
126 const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
128 // If the user updates the video preview during transcoding
129 const previewPath = video.getPreview().getPath()
130 const tmpPreviewPath = join(CONFIG.STORAGE.TMP_DIR, basename(previewPath))
131 await copyFile(previewPath, tmpPreviewPath)
133 const transcodeOptions = {
134 type: 'merge-audio' as 'merge-audio',
136 inputPath: tmpPreviewPath,
137 outputPath: videoTranscodedPath,
142 audioPath: audioInputPath,
147 await transcode(transcodeOptions)
149 await remove(audioInputPath)
150 await remove(tmpPreviewPath)
152 await remove(tmpPreviewPath)
156 // Important to do this before getVideoFilename() to take in account the new file extension
157 inputVideoFile.extname = newExtname
159 const videoOutputPath = getVideoFilePath(video, inputVideoFile)
160 // ffmpeg generated a new video file, so update the video duration
161 // See https://trac.ffmpeg.org/ticket/5456
162 video.duration = await getDurationFromVideoFile(videoTranscodedPath)
165 return onVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
168 // Concat TS segments from a live video to a fragmented mp4 HLS playlist
169 async function generateHlsPlaylistFromTS (options: {
170 video: MVideoWithFile
171 concatenatedTsFilePath: string
172 resolution: VideoResolution
173 isPortraitMode: boolean
176 return generateHlsPlaylistCommon({
177 video: options.video,
178 resolution: options.resolution,
179 isPortraitMode: options.isPortraitMode,
180 inputPath: options.concatenatedTsFilePath,
181 type: 'hls-from-ts' as 'hls-from-ts',
186 // Generate an HLS playlist from an input file, and update the master playlist
187 function generateHlsPlaylist (options: {
188 video: MVideoWithFile
189 videoInputPath: string
190 resolution: VideoResolution
192 isPortraitMode: boolean
194 return generateHlsPlaylistCommon({
195 video: options.video,
196 resolution: options.resolution,
197 copyCodecs: options.copyCodecs,
198 isPortraitMode: options.isPortraitMode,
199 inputPath: options.videoInputPath,
204 // ---------------------------------------------------------------------------
208 generateHlsPlaylistFromTS,
209 optimizeOriginalVideofile,
210 transcodeNewResolution,
214 // ---------------------------------------------------------------------------
216 async function onVideoFileTranscoding (video: MVideoWithFile, videoFile: MVideoFile, transcodingPath: string, outputPath: string) {
217 const stats = await stat(transcodingPath)
218 const fps = await getVideoFileFPS(transcodingPath)
219 const metadata = await getMetadataFromFile(transcodingPath)
221 await move(transcodingPath, outputPath, { overwrite: true })
223 videoFile.size = stats.size
225 videoFile.metadata = metadata
227 await createTorrentAndSetInfoHash(video, videoFile)
229 await VideoFileModel.customUpsert(videoFile, 'video', undefined)
230 video.VideoFiles = await video.$get('VideoFiles')
235 async function generateHlsPlaylistCommon (options: {
236 type: 'hls' | 'hls-from-ts'
237 video: MVideoWithFile
239 resolution: VideoResolution
242 isPortraitMode: boolean
244 const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC } = options
246 const baseHlsDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
247 await ensureDir(join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid))
249 const outputPath = join(baseHlsDirectory, VideoStreamingPlaylistModel.getHlsPlaylistFilename(resolution))
250 const videoFilename = generateVideoStreamingPlaylistName(video.uuid, resolution)
252 const transcodeOptions = {
272 await transcode(transcodeOptions)
274 const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid)
276 const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({
279 segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive),
280 p2pMediaLoaderInfohashes: [],
281 p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
283 type: VideoStreamingPlaylistType.HLS
284 }, { returning: true }) as [ MStreamingPlaylistFilesVideo, boolean ]
285 videoStreamingPlaylist.Video = video
287 const newVideoFile = new VideoFileModel({
289 extname: extnameUtil(videoFilename),
292 videoStreamingPlaylistId: videoStreamingPlaylist.id
295 const videoFilePath = getVideoFilePath(videoStreamingPlaylist, newVideoFile)
296 const stats = await stat(videoFilePath)
298 newVideoFile.size = stats.size
299 newVideoFile.fps = await getVideoFileFPS(videoFilePath)
300 newVideoFile.metadata = await getMetadataFromFile(videoFilePath)
302 await createTorrentAndSetInfoHash(videoStreamingPlaylist, newVideoFile)
304 await VideoFileModel.customUpsert(newVideoFile, 'streaming-playlist', undefined)
305 videoStreamingPlaylist.VideoFiles = await videoStreamingPlaylist.$get('VideoFiles')
307 videoStreamingPlaylist.p2pMediaLoaderInfohashes = VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(
308 playlistUrl, videoStreamingPlaylist.VideoFiles
310 await videoStreamingPlaylist.save()
312 video.setHLSPlaylist(videoStreamingPlaylist)
314 await updateMasterHLSPlaylist(video)
315 await updateSha256VODSegments(video)