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