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)
63 // Auto destruction...
64 video.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err }))
70 // Transcode the original video file to a lower resolution.
71 async function transcodeNewResolution (video: MVideoWithFile, resolution: VideoResolution, isPortrait: boolean) {
72 const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
73 const extname = '.mp4'
75 // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
76 const videoInputPath = getVideoFilePath(video, video.getMaxQualityFile())
78 const newVideoFile = new VideoFileModel({
84 const videoOutputPath = getVideoFilePath(video, newVideoFile)
85 const videoTranscodedPath = join(transcodeDirectory, getVideoFilename(video, newVideoFile))
87 const transcodeOptions = resolution === VideoResolution.H_NOVIDEO
89 type: 'only-audio' as 'only-audio',
91 inputPath: videoInputPath,
92 outputPath: videoTranscodedPath,
100 type: 'video' as 'video',
101 inputPath: videoInputPath,
102 outputPath: videoTranscodedPath,
108 isPortraitMode: isPortrait
111 await transcode(transcodeOptions)
113 return onVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
116 // Merge an image with an audio file to create a video
117 async function mergeAudioVideofile (video: MVideoWithAllFiles, resolution: VideoResolution) {
118 const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
119 const newExtname = '.mp4'
121 const inputVideoFile = video.getMinQualityFile()
123 const audioInputPath = getVideoFilePath(video, inputVideoFile)
124 const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
126 // If the user updates the video preview during transcoding
127 const previewPath = video.getPreview().getPath()
128 const tmpPreviewPath = join(CONFIG.STORAGE.TMP_DIR, basename(previewPath))
129 await copyFile(previewPath, tmpPreviewPath)
131 const transcodeOptions = {
132 type: 'merge-audio' as 'merge-audio',
134 inputPath: tmpPreviewPath,
135 outputPath: videoTranscodedPath,
140 audioPath: audioInputPath,
145 await transcode(transcodeOptions)
147 await remove(audioInputPath)
148 await remove(tmpPreviewPath)
150 await remove(tmpPreviewPath)
154 // Important to do this before getVideoFilename() to take in account the new file extension
155 inputVideoFile.extname = newExtname
157 const videoOutputPath = getVideoFilePath(video, inputVideoFile)
158 // ffmpeg generated a new video file, so update the video duration
159 // See https://trac.ffmpeg.org/ticket/5456
160 video.duration = await getDurationFromVideoFile(videoTranscodedPath)
163 return onVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
166 // Concat TS segments from a live video to a fragmented mp4 HLS playlist
167 async function generateHlsPlaylistFromTS (options: {
168 video: MVideoWithFile
169 concatenatedTsFilePath: string
170 resolution: VideoResolution
171 isPortraitMode: boolean
174 return generateHlsPlaylistCommon({
175 video: options.video,
176 resolution: options.resolution,
177 isPortraitMode: options.isPortraitMode,
178 inputPath: options.concatenatedTsFilePath,
179 type: 'hls-from-ts' as 'hls-from-ts',
184 // Generate an HLS playlist from an input file, and update the master playlist
185 function generateHlsPlaylist (options: {
186 video: MVideoWithFile
187 videoInputPath: string
188 resolution: VideoResolution
190 isPortraitMode: boolean
192 return generateHlsPlaylistCommon({
193 video: options.video,
194 resolution: options.resolution,
195 copyCodecs: options.copyCodecs,
196 isPortraitMode: options.isPortraitMode,
197 inputPath: options.videoInputPath,
202 // ---------------------------------------------------------------------------
206 generateHlsPlaylistFromTS,
207 optimizeOriginalVideofile,
208 transcodeNewResolution,
212 // ---------------------------------------------------------------------------
214 async function onVideoFileTranscoding (video: MVideoWithFile, videoFile: MVideoFile, transcodingPath: string, outputPath: string) {
215 const stats = await stat(transcodingPath)
216 const fps = await getVideoFileFPS(transcodingPath)
217 const metadata = await getMetadataFromFile(transcodingPath)
219 await move(transcodingPath, outputPath, { overwrite: true })
221 videoFile.size = stats.size
223 videoFile.metadata = metadata
225 await createTorrentAndSetInfoHash(video, videoFile)
227 await VideoFileModel.customUpsert(videoFile, 'video', undefined)
228 video.VideoFiles = await video.$get('VideoFiles')
233 async function generateHlsPlaylistCommon (options: {
234 type: 'hls' | 'hls-from-ts'
235 video: MVideoWithFile
237 resolution: VideoResolution
240 isPortraitMode: boolean
242 const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC } = options
244 const baseHlsDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
245 await ensureDir(join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid))
247 const outputPath = join(baseHlsDirectory, VideoStreamingPlaylistModel.getHlsPlaylistFilename(resolution))
248 const videoFilename = generateVideoStreamingPlaylistName(video.uuid, resolution)
250 const transcodeOptions = {
270 await transcode(transcodeOptions)
272 const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid)
274 const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({
277 segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive),
278 p2pMediaLoaderInfohashes: [],
279 p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
281 type: VideoStreamingPlaylistType.HLS
282 }, { returning: true }) as [ MStreamingPlaylistFilesVideo, boolean ]
283 videoStreamingPlaylist.Video = video
285 const newVideoFile = new VideoFileModel({
287 extname: extnameUtil(videoFilename),
290 videoStreamingPlaylistId: videoStreamingPlaylist.id
293 const videoFilePath = getVideoFilePath(videoStreamingPlaylist, newVideoFile)
294 const stats = await stat(videoFilePath)
296 newVideoFile.size = stats.size
297 newVideoFile.fps = await getVideoFileFPS(videoFilePath)
298 newVideoFile.metadata = await getMetadataFromFile(videoFilePath)
300 await createTorrentAndSetInfoHash(videoStreamingPlaylist, newVideoFile)
302 await VideoFileModel.customUpsert(newVideoFile, 'streaming-playlist', undefined)
303 videoStreamingPlaylist.VideoFiles = await videoStreamingPlaylist.$get('VideoFiles')
305 videoStreamingPlaylist.p2pMediaLoaderInfohashes = VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(
306 playlistUrl, videoStreamingPlaylist.VideoFiles
308 await videoStreamingPlaylist.save()
310 video.setHLSPlaylist(videoStreamingPlaylist)
312 await updateMasterHLSPlaylist(video)
313 await updateSha256VODSegments(video)