server/lib/hls.ts

   1 import { close, ensureDir, move, open, outputJSON, pathExists, read, readFile, remove, writeFile } from 'fs-extra'
   2 import { flatten, uniq } from 'lodash'
   3 import { basename, dirname, join } from 'path'
   4 import { MVideoWithFile } from '@server/types/models'
   5 import { sha256 } from '../helpers/core-utils'
   6 import { getAudioStreamCodec, getVideoStreamCodec, getVideoStreamSize } from '../helpers/ffprobe-utils'
   7 import { logger } from '../helpers/logger'
   8 import { doRequest, doRequestAndSaveToFile } from '../helpers/requests'
   9 import { generateRandomString } from '../helpers/utils'
  10 import { CONFIG } from '../initializers/config'
  11 import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION } from '../initializers/constants'
  12 import { sequelizeTypescript } from '../initializers/database'
  13 import { VideoFileModel } from '../models/video/video-file'
  14 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
  15 import { getVideoFilePath } from './video-paths'
  16
  17 async function updateStreamingPlaylistsInfohashesIfNeeded () {
  18   const playlistsToUpdate = await VideoStreamingPlaylistModel.listByIncorrectPeerVersion()
  19
  20   // Use separate SQL queries, because we could have many videos to update
  21   for (const playlist of playlistsToUpdate) {
  22     await sequelizeTypescript.transaction(async t => {
  23       const videoFiles = await VideoFileModel.listByStreamingPlaylist(playlist.id, t)
  24
  25       playlist.p2pMediaLoaderInfohashes = VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(playlist.playlistUrl, videoFiles)
  26       playlist.p2pMediaLoaderPeerVersion = P2P_MEDIA_LOADER_PEER_VERSION
  27       await playlist.save({ transaction: t })
  28     })
  29   }
  30 }
  31
  32 async function updateMasterHLSPlaylist (video: MVideoWithFile) {
  33   const directory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
  34   const masterPlaylists: string[] = [ '#EXTM3U', '#EXT-X-VERSION:3' ]
  35   const masterPlaylistPath = join(directory, VideoStreamingPlaylistModel.getMasterHlsPlaylistFilename())
  36   const streamingPlaylist = video.getHLSPlaylist()
  37
  38   for (const file of streamingPlaylist.VideoFiles) {
  39     const playlistFilename = VideoStreamingPlaylistModel.getHlsPlaylistFilename(file.resolution)
  40
  41     // If we did not generated a playlist for this resolution, skip
  42     const filePlaylistPath = join(directory, playlistFilename)
  43     if (await pathExists(filePlaylistPath) === false) continue
  44
  45     const videoFilePath = getVideoFilePath(streamingPlaylist, file)
  46
  47     const size = await getVideoStreamSize(videoFilePath)
  48
  49     const bandwidth = 'BANDWIDTH=' + video.getBandwidthBits(file)
  50     const resolution = `RESOLUTION=${size.width}x${size.height}`
  51
  52     let line = `#EXT-X-STREAM-INF:${bandwidth},${resolution}`
  53     if (file.fps) line += ',FRAME-RATE=' + file.fps
  54
  55     const codecs = await Promise.all([
  56       getVideoStreamCodec(videoFilePath),
  57       getAudioStreamCodec(videoFilePath)
  58     ])
  59
  60     line += `,CODECS="${codecs.filter(c => !!c).join(',')}"`
  61
  62     masterPlaylists.push(line)
  63     masterPlaylists.push(playlistFilename)
  64   }
  65
  66   await writeFile(masterPlaylistPath, masterPlaylists.join('\n') + '\n')
  67 }
  68
  69 async function updateSha256VODSegments (video: MVideoWithFile) {
  70   const json: { [filename: string]: { [range: string]: string } } = {}
  71
  72   const playlistDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
  73   const hlsPlaylist = video.getHLSPlaylist()
  74
  75   // For all the resolutions available for this video
  76   for (const file of hlsPlaylist.VideoFiles) {
  77     const rangeHashes: { [range: string]: string } = {}
  78
  79     const videoPath = getVideoFilePath(hlsPlaylist, file)
  80     const playlistPath = join(playlistDirectory, VideoStreamingPlaylistModel.getHlsPlaylistFilename(file.resolution))
  81
  82     // Maybe the playlist is not generated for this resolution yet
  83     if (!await pathExists(playlistPath)) continue
  84
  85     const playlistContent = await readFile(playlistPath)
  86     const ranges = getRangesFromPlaylist(playlistContent.toString())
  87
  88     const fd = await open(videoPath, 'r')
  89     for (const range of ranges) {
  90       const buf = Buffer.alloc(range.length)
  91       await read(fd, buf, 0, range.length, range.offset)
  92
  93       rangeHashes[`${range.offset}-${range.offset + range.length - 1}`] = sha256(buf)
  94     }
  95     await close(fd)
  96
  97     const videoFilename = file.filename
  98     json[videoFilename] = rangeHashes
  99   }
 100
 101   const outputPath = join(playlistDirectory, VideoStreamingPlaylistModel.getHlsSha256SegmentsFilename())
 102   await outputJSON(outputPath, json)
 103 }
 104
 105 async function buildSha256Segment (segmentPath: string) {
 106   const buf = await readFile(segmentPath)
 107   return sha256(buf)
 108 }
 109
 110 function downloadPlaylistSegments (playlistUrl: string, destinationDir: string, timeout: number) {
 111   let timer
 112
 113   logger.info('Importing HLS playlist %s', playlistUrl)
 114
 115   return new Promise<void>(async (res, rej) => {
 116     const tmpDirectory = join(CONFIG.STORAGE.TMP_DIR, await generateRandomString(10))
 117
 118     await ensureDir(tmpDirectory)
 119
 120     timer = setTimeout(() => {
 121       deleteTmpDirectory(tmpDirectory)
 122
 123       return rej(new Error('HLS download timeout.'))
 124     }, timeout)
 125
 126     try {
 127       // Fetch master playlist
 128       const subPlaylistUrls = await fetchUniqUrls(playlistUrl)
 129
 130       const subRequests = subPlaylistUrls.map(u => fetchUniqUrls(u))
 131       const fileUrls = uniq(flatten(await Promise.all(subRequests)))
 132
 133       logger.debug('Will download %d HLS files.', fileUrls.length, { fileUrls })
 134
 135       for (const fileUrl of fileUrls) {
 136         const destPath = join(tmpDirectory, basename(fileUrl))
 137
 138         const bodyKBLimit = 10 * 1000 * 1000 // 10GB
 139         await doRequestAndSaveToFile(fileUrl, destPath, { bodyKBLimit })
 140       }
 141
 142       clearTimeout(timer)
 143
 144       await move(tmpDirectory, destinationDir, { overwrite: true })
 145
 146       return res()
 147     } catch (err) {
 148       deleteTmpDirectory(tmpDirectory)
 149
 150       return rej(err)
 151     }
 152   })
 153
 154   function deleteTmpDirectory (directory: string) {
 155     remove(directory)
 156       .catch(err => logger.error('Cannot delete path on HLS download error.', { err }))
 157   }
 158
 159   async function fetchUniqUrls (playlistUrl: string) {
 160     const { body } = await doRequest(playlistUrl)
 161
 162     if (!body) return []
 163
 164     const urls = body.split('\n')
 165       .filter(line => line.endsWith('.m3u8') || line.endsWith('.mp4'))
 166       .map(url => {
 167         if (url.startsWith('http://') || url.startsWith('https://')) return url
 168
 169         return `${dirname(playlistUrl)}/${url}`
 170       })
 171
 172     return uniq(urls)
 173   }
 174 }
 175
 176 // ---------------------------------------------------------------------------
 177
 178 export {
 179   updateMasterHLSPlaylist,
 180   updateSha256VODSegments,
 181   buildSha256Segment,
 182   downloadPlaylistSegments,
 183   updateStreamingPlaylistsInfohashesIfNeeded
 184 }
 185
 186 // ---------------------------------------------------------------------------
 187
 188 function getRangesFromPlaylist (playlistContent: string) {
 189   const ranges: { offset: number, length: number }[] = []
 190   const lines = playlistContent.split('\n')
 191   const regex = /^#EXT-X-BYTERANGE:(\d+)@(\d+)$/
 192
 193   for (const line of lines) {
 194     const captured = regex.exec(line)
 195
 196     if (captured) {
 197       ranges.push({ length: parseInt(captured[1], 10), offset: parseInt(captured[2], 10) })
 198     }
 199   }
 200
 201   return ranges
 202 }