server/lib/runners/job-handlers/vod-hls-transcoding-job-handler.ts

   1 import { move } from 'fs-extra'
   2 import { dirname, join } from 'path'
   3 import { logger } from '@server/helpers/logger'
   4 import { renameVideoFileInPlaylist } from '@server/lib/hls'
   5 import { getHlsResolutionPlaylistFilename } from '@server/lib/paths'
   6 import { onTranscodingEnded } from '@server/lib/transcoding/ended-transcoding'
   7 import { onHLSVideoFileTranscoding } from '@server/lib/transcoding/hls-transcoding'
   8 import { buildNewFile, removeAllWebTorrentFiles } from '@server/lib/video-file'
   9 import { VideoJobInfoModel } from '@server/models/video/video-job-info'
  10 import { MVideo } from '@server/types/models'
  11 import { MRunnerJob } from '@server/types/models/runners'
  12 import { pick } from '@shared/core-utils'
  13 import { buildUUID } from '@shared/extra-utils'
  14 import {
  15   RunnerJobUpdatePayload,
  16   RunnerJobVODHLSTranscodingPayload,
  17   RunnerJobVODHLSTranscodingPrivatePayload,
  18   VODHLSTranscodingSuccess
  19 } from '@shared/models'
  20 import { generateRunnerTranscodingVideoInputFileUrl } from '../runner-urls'
  21 import { AbstractVODTranscodingJobHandler } from './abstract-vod-transcoding-job-handler'
  22 import { loadTranscodingRunnerVideo } from './shared'
  23
  24 type CreateOptions = {
  25   video: MVideo
  26   isNewVideo: boolean
  27   deleteWebVideoFiles: boolean
  28   resolution: number
  29   fps: number
  30   priority: number
  31   dependsOnRunnerJob?: MRunnerJob
  32 }
  33
  34 // eslint-disable-next-line max-len
  35 export class VODHLSTranscodingJobHandler extends AbstractVODTranscodingJobHandler<CreateOptions, RunnerJobUpdatePayload, VODHLSTranscodingSuccess> {
  36
  37   async create (options: CreateOptions) {
  38     const { video, resolution, fps, dependsOnRunnerJob, priority } = options
  39
  40     const jobUUID = buildUUID()
  41
  42     const payload: RunnerJobVODHLSTranscodingPayload = {
  43       input: {
  44         videoFileUrl: generateRunnerTranscodingVideoInputFileUrl(jobUUID, video.uuid)
  45       },
  46       output: {
  47         resolution,
  48         fps
  49       }
  50     }
  51
  52     const privatePayload: RunnerJobVODHLSTranscodingPrivatePayload = {
  53       ...pick(options, [ 'isNewVideo', 'deleteWebVideoFiles' ]),
  54
  55       videoUUID: video.uuid
  56     }
  57
  58     const job = await this.createRunnerJob({
  59       type: 'vod-hls-transcoding',
  60       jobUUID,
  61       payload,
  62       privatePayload,
  63       priority,
  64       dependsOnRunnerJob
  65     })
  66
  67     await VideoJobInfoModel.increaseOrCreate(video.uuid, 'pendingTranscode')
  68
  69     return job
  70   }
  71
  72   // ---------------------------------------------------------------------------
  73
  74   protected async specificComplete (options: {
  75     runnerJob: MRunnerJob
  76     resultPayload: VODHLSTranscodingSuccess
  77   }) {
  78     const { runnerJob, resultPayload } = options
  79     const privatePayload = runnerJob.privatePayload as RunnerJobVODHLSTranscodingPrivatePayload
  80
  81     const video = await loadTranscodingRunnerVideo(runnerJob, this.lTags)
  82     if (!video) return
  83
  84     const videoFilePath = resultPayload.videoFile as string
  85     const resolutionPlaylistFilePath = resultPayload.resolutionPlaylistFile as string
  86
  87     const videoFile = await buildNewFile({ path: videoFilePath, mode: 'hls' })
  88     const newVideoFilePath = join(dirname(videoFilePath), videoFile.filename)
  89     await move(videoFilePath, newVideoFilePath)
  90
  91     const resolutionPlaylistFilename = getHlsResolutionPlaylistFilename(videoFile.filename)
  92     const newResolutionPlaylistFilePath = join(dirname(resolutionPlaylistFilePath), resolutionPlaylistFilename)
  93     await move(resolutionPlaylistFilePath, newResolutionPlaylistFilePath)
  94
  95     await renameVideoFileInPlaylist(newResolutionPlaylistFilePath, videoFile.filename)
  96
  97     await onHLSVideoFileTranscoding({
  98       video,
  99       videoFile,
 100       m3u8OutputPath: newResolutionPlaylistFilePath,
 101       videoOutputPath: newVideoFilePath
 102     })
 103
 104     await onTranscodingEnded({ isNewVideo: privatePayload.isNewVideo, moveVideoToNextState: true, video })
 105
 106     if (privatePayload.deleteWebVideoFiles === true) {
 107       logger.info('Removing web video files of %s now we have a HLS version of it.', video.uuid, this.lTags(video.uuid))
 108
 109       await removeAllWebTorrentFiles(video)
 110     }
 111
 112     logger.info('Runner VOD HLS job %s for %s ended.', runnerJob.uuid, video.uuid, this.lTags(runnerJob.uuid, video.uuid))
 113   }
 114 }