PeerTube/server/lib/video-transcoding.ts

370 lines
12 KiB
TypeScript
Raw Normal View History

2021-01-21 14:42:43 +01:00
import { Job } from 'bull'
2020-12-04 15:10:13 +01:00
import { copyFile, ensureDir, move, remove, stat } from 'fs-extra'
import { basename, extname as extnameUtil, join } from 'path'
2020-11-06 10:57:40 +01:00
import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent'
import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoFullLight } from '@server/types/models'
2020-11-24 14:08:23 +01:00
import { VideoResolution } from '../../shared/models/videos'
2020-11-06 10:57:40 +01:00
import { VideoStreamingPlaylistType } from '../../shared/models/videos/video-streaming-playlist.type'
2020-11-24 14:08:23 +01:00
import { transcode, TranscodeOptions, TranscodeOptionsType } from '../helpers/ffmpeg-utils'
import { canDoQuickTranscode, getDurationFromVideoFile, getMetadataFromFile, getVideoFileFPS } from '../helpers/ffprobe-utils'
import { logger } from '../helpers/logger'
2020-11-06 10:57:40 +01:00
import { CONFIG } from '../initializers/config'
2020-11-24 14:08:23 +01:00
import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION, WEBSERVER } from '../initializers/constants'
import { VideoFileModel } from '../models/video/video-file'
2019-01-29 08:37:25 +01:00
import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
2020-11-06 10:57:40 +01:00
import { updateMasterHLSPlaylist, updateSha256VODSegments } from './hls'
import { generateVideoFilename, generateVideoStreamingPlaylistName, getVideoFilePath } from './video-paths'
2021-01-28 09:37:26 +01:00
import { VideoTranscodingProfilesManager } from './video-transcoding-profiles'
2019-05-13 13:02:42 +02:00
/**
2020-11-24 16:29:39 +01:00
*
* Functions that run transcoding functions, update the database, cleanup files, create torrent files...
* Mainly called by the job queue
*
2019-05-13 13:02:42 +02:00
*/
2020-11-24 16:29:39 +01:00
// Optimize the original video file and replace it. The resolution is not changed.
async function optimizeOriginalVideofile (video: MVideoFullLight, inputVideoFile: MVideoFile, job?: Job) {
const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
const newExtname = '.mp4'
const videoInputPath = getVideoFilePath(video, inputVideoFile)
const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname)
2019-05-16 16:55:34 +02:00
const transcodeType: TranscodeOptionsType = await canDoQuickTranscode(videoInputPath)
? 'quick-transcode'
: 'video'
2019-05-16 16:55:34 +02:00
const transcodeOptions: TranscodeOptions = {
type: transcodeType,
inputPath: videoInputPath,
2019-01-29 08:37:25 +01:00
outputPath: videoTranscodedPath,
2021-01-28 09:37:26 +01:00
availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
profile: CONFIG.TRANSCODING.PROFILE,
2021-01-21 14:42:43 +01:00
resolution: inputVideoFile.resolution,
job
}
// Could be very long!
await transcode(transcodeOptions)
try {
await remove(videoInputPath)
// Important to do this before getVideoFilename() to take in account the new filename
2019-05-16 16:55:34 +02:00
inputVideoFile.extname = newExtname
inputVideoFile.filename = generateVideoFilename(video, false, inputVideoFile.resolution, newExtname)
const videoOutputPath = getVideoFilePath(video, inputVideoFile)
2021-01-21 15:58:17 +01:00
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 }))
throw err
}
}
2020-11-24 16:29:39 +01:00
// Transcode the original video file to a lower resolution.
async function transcodeNewWebTorrentResolution (video: MVideoFullLight, resolution: VideoResolution, isPortrait: boolean, job: Job) {
const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
const extname = '.mp4'
// We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed
const videoInputPath = getVideoFilePath(video, video.getMaxQualityFile())
const newVideoFile = new VideoFileModel({
resolution,
extname,
filename: generateVideoFilename(video, false, resolution, extname),
size: 0,
videoId: video.id
})
const videoOutputPath = getVideoFilePath(video, newVideoFile)
const videoTranscodedPath = join(transcodeDirectory, newVideoFile.filename)
const transcodeOptions = resolution === VideoResolution.H_NOVIDEO
? {
2019-11-22 11:43:17 +01:00
type: 'only-audio' as 'only-audio',
2019-11-22 11:43:17 +01:00
inputPath: videoInputPath,
outputPath: videoTranscodedPath,
2021-01-28 09:37:26 +01:00
availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
profile: CONFIG.TRANSCODING.PROFILE,
2021-01-21 14:42:43 +01:00
resolution,
job
2019-11-22 11:43:17 +01:00
}
: {
2019-11-22 11:43:17 +01:00
type: 'video' as 'video',
inputPath: videoInputPath,
outputPath: videoTranscodedPath,
2021-01-28 09:37:26 +01:00
availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
profile: CONFIG.TRANSCODING.PROFILE,
2019-11-22 11:43:17 +01:00
resolution,
2021-01-21 14:42:43 +01:00
isPortraitMode: isPortrait,
job
2019-11-22 11:43:17 +01:00
}
await transcode(transcodeOptions)
2021-01-21 15:58:17 +01:00
return onWebTorrentVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath)
2019-05-16 16:55:34 +02:00
}
2020-11-24 16:29:39 +01:00
// Merge an image with an audio file to create a video
async function mergeAudioVideofile (video: MVideoFullLight, resolution: VideoResolution, job: Job) {
2019-05-16 16:55:34 +02:00
const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
const newExtname = '.mp4'
const inputVideoFile = video.getMinQualityFile()
const audioInputPath = getVideoFilePath(video, inputVideoFile)
2019-05-16 16:55:34 +02:00
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)
2019-05-16 16:55:34 +02:00
const transcodeOptions = {
type: 'merge-audio' as 'merge-audio',
inputPath: tmpPreviewPath,
2019-05-16 16:55:34 +02:00
outputPath: videoTranscodedPath,
2021-01-28 09:37:26 +01:00
availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
profile: CONFIG.TRANSCODING.PROFILE,
2019-05-16 16:55:34 +02:00
audioPath: audioInputPath,
2021-01-21 14:42:43 +01:00
resolution,
job
2019-05-16 16:55:34 +02:00
}
try {
await transcode(transcodeOptions)
await remove(audioInputPath)
await remove(tmpPreviewPath)
} catch (err) {
await remove(tmpPreviewPath)
throw err
}
2019-05-16 16:55:34 +02:00
// Important to do this before getVideoFilename() to take in account the new file extension
inputVideoFile.extname = newExtname
2021-02-17 09:36:09 +01:00
inputVideoFile.filename = generateVideoFilename(video, false, inputVideoFile.resolution, newExtname)
2019-05-16 16:55:34 +02:00
const videoOutputPath = getVideoFilePath(video, inputVideoFile)
// ffmpeg generated a new video file, so update the video duration
// See https://trac.ffmpeg.org/ticket/5456
video.duration = await getDurationFromVideoFile(videoTranscodedPath)
await video.save()
2019-05-16 16:55:34 +02:00
2021-01-21 15:58:17 +01:00
return onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath)
}
2020-12-02 10:07:26 +01:00
// Concat TS segments from a live video to a fragmented mp4 HLS playlist
2021-01-21 15:58:17 +01:00
async function generateHlsPlaylistResolutionFromTS (options: {
video: MVideoFullLight
2020-12-04 15:10:13 +01:00
concatenatedTsFilePath: string
2020-12-02 10:07:26 +01:00
resolution: VideoResolution
isPortraitMode: boolean
isAAC: boolean
2020-12-02 10:07:26 +01:00
}) {
2020-12-04 15:10:13 +01:00
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
2020-12-04 15:10:13 +01:00
})
2020-12-02 10:07:26 +01:00
}
2020-11-24 16:29:39 +01:00
// Generate an HLS playlist from an input file, and update the master playlist
2021-01-21 15:58:17 +01:00
function generateHlsPlaylistResolution (options: {
video: MVideoFullLight
2020-10-26 16:44:23 +01:00
videoInputPath: string
resolution: VideoResolution
copyCodecs: boolean
isPortraitMode: boolean
2021-01-21 14:42:43 +01:00
job?: Job
2020-10-26 16:44:23 +01:00
}) {
2020-12-02 10:07:26 +01:00
return generateHlsPlaylistCommon({
video: options.video,
resolution: options.resolution,
copyCodecs: options.copyCodecs,
isPortraitMode: options.isPortraitMode,
inputPath: options.videoInputPath,
2021-01-21 14:42:43 +01:00
type: 'hls' as 'hls',
job: options.job
2020-12-02 10:07:26 +01:00
})
}
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))
}
2020-12-02 10:07:26 +01:00
// ---------------------------------------------------------------------------
export {
2021-01-21 15:58:17 +01:00
generateHlsPlaylistResolution,
generateHlsPlaylistResolutionFromTS,
2020-12-02 10:07:26 +01:00
optimizeOriginalVideofile,
2021-01-21 15:58:17 +01:00
transcodeNewWebTorrentResolution,
mergeAudioVideofile,
getEnabledResolutions
2020-12-02 10:07:26 +01:00
}
// ---------------------------------------------------------------------------
2021-01-21 15:58:17 +01:00
async function onWebTorrentVideoFileTranscoding (
video: MVideoFullLight,
2021-01-21 15:58:17 +01:00
videoFile: MVideoFile,
transcodingPath: string,
outputPath: string
) {
2020-12-02 10:07:26 +01:00
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
2021-02-18 11:28:00 +01:00
await createTorrentAndSetInfoHash(video, videoFile)
2020-12-02 10:07:26 +01:00
await VideoFileModel.customUpsert(videoFile, 'video', undefined)
video.VideoFiles = await video.$get('VideoFiles')
return video
}
async function generateHlsPlaylistCommon (options: {
type: 'hls' | 'hls-from-ts'
video: MVideoFullLight
2020-12-02 10:07:26 +01:00
inputPath: string
resolution: VideoResolution
copyCodecs?: boolean
isAAC?: boolean
2020-12-02 10:07:26 +01:00
isPortraitMode: boolean
2021-01-21 14:42:43 +01:00
job?: Job
2020-12-02 10:07:26 +01:00
}) {
2021-01-21 14:42:43 +01:00
const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC, job } = options
const transcodeDirectory = CONFIG.STORAGE.TMP_DIR
2020-10-26 16:44:23 +01:00
const videoTranscodedBasePath = join(transcodeDirectory, type)
await ensureDir(videoTranscodedBasePath)
2019-01-29 08:37:25 +01:00
const videoFilename = generateVideoStreamingPlaylistName(video.uuid, resolution)
const playlistFilename = VideoStreamingPlaylistModel.getHlsPlaylistFilename(resolution)
const playlistFileTranscodePath = join(videoTranscodedBasePath, playlistFilename)
2019-01-29 08:37:25 +01:00
const transcodeOptions = {
2020-12-02 10:07:26 +01:00
type,
2020-12-02 10:07:26 +01:00
inputPath,
outputPath: playlistFileTranscodePath,
2021-01-28 09:37:26 +01:00
availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(),
profile: CONFIG.TRANSCODING.PROFILE,
2019-01-29 08:37:25 +01:00
resolution,
copyCodecs,
2019-01-29 08:37:25 +01:00
isPortraitMode,
isAAC,
hlsPlaylist: {
videoFilename
2021-01-21 14:42:43 +01:00
},
job
2019-01-29 08:37:25 +01:00
}
await transcode(transcodeOptions)
2019-01-29 08:37:25 +01:00
2019-04-11 11:33:44 +02:00
const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid)
2019-01-29 08:37:25 +01:00
// Create or update the playlist
const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({
2019-01-29 08:37:25 +01:00
videoId: video.id,
playlistUrl,
segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive),
2020-10-26 16:44:23 +01:00
p2pMediaLoaderInfohashes: [],
2019-04-08 12:08:16 +02:00
p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
2019-01-29 08:37:25 +01:00
type: VideoStreamingPlaylistType.HLS
}, { returning: true }) as [ MStreamingPlaylistFilesVideo, boolean ]
videoStreamingPlaylist.Video = video
// Build the new playlist file
const extname = extnameUtil(videoFilename)
const newVideoFile = new VideoFileModel({
resolution,
extname,
size: 0,
filename: generateVideoFilename(video, true, resolution, extname),
fps: -1,
videoStreamingPlaylistId: videoStreamingPlaylist.id
2019-01-29 08:37:25 +01:00
})
const videoFilePath = getVideoFilePath(videoStreamingPlaylist, newVideoFile)
// Move files from tmp transcoded directory to the appropriate place
const baseHlsDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
await ensureDir(baseHlsDirectory)
// Move playlist file
const playlistPath = join(baseHlsDirectory, playlistFilename)
2021-02-02 14:00:46 +01:00
await move(playlistFileTranscodePath, playlistPath, { overwrite: true })
// Move video file
2021-02-02 14:00:46 +01:00
await move(join(videoTranscodedBasePath, videoFilename), videoFilePath, { overwrite: true })
const stats = await stat(videoFilePath)
newVideoFile.size = stats.size
newVideoFile.fps = await getVideoFileFPS(videoFilePath)
newVideoFile.metadata = await getMetadataFromFile(videoFilePath)
2021-02-18 11:28:00 +01:00
await createTorrentAndSetInfoHash(videoStreamingPlaylist, newVideoFile)
2020-03-12 15:37:28 +01:00
await VideoFileModel.customUpsert(newVideoFile, 'streaming-playlist', undefined)
videoStreamingPlaylist.VideoFiles = await videoStreamingPlaylist.$get('VideoFiles')
2020-10-26 16:44:23 +01:00
videoStreamingPlaylist.p2pMediaLoaderInfohashes = VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(
playlistUrl, videoStreamingPlaylist.VideoFiles
)
await videoStreamingPlaylist.save()
video.setHLSPlaylist(videoStreamingPlaylist)
await updateMasterHLSPlaylist(video)
await updateSha256VODSegments(video)
return playlistPath
}