server/lib/thumbnail.ts

   1 import { join } from 'path'
   2 import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
   3 import { generateImageFromVideoFile } from '../helpers/ffmpeg-utils'
   4 import { generateImageFilename, processImage } from '../helpers/image-utils'
   5 import { downloadImage } from '../helpers/requests'
   6 import { CONFIG } from '../initializers/config'
   7 import { ASSETS_PATH, PREVIEWS_SIZE, THUMBNAILS_SIZE } from '../initializers/constants'
   8 import { ThumbnailModel } from '../models/video/thumbnail'
   9 import { MVideoFile, MVideoThumbnail, MVideoUUID } from '../types/models'
  10 import { MThumbnail } from '../types/models/video/thumbnail'
  11 import { MVideoPlaylistThumbnail } from '../types/models/video/video-playlist'
  12 import { VideoPathManager } from './video-path-manager'
  13
  14 type ImageSize = { height?: number, width?: number }
  15
  16 function updatePlaylistMiniatureFromExisting (options: {
  17   inputPath: string
  18   playlist: MVideoPlaylistThumbnail
  19   automaticallyGenerated: boolean
  20   keepOriginal?: boolean // default to false
  21   size?: ImageSize
  22 }) {
  23   const { inputPath, playlist, automaticallyGenerated, keepOriginal = false, size } = options
  24   const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
  25   const type = ThumbnailType.MINIATURE
  26
  27   const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
  28   return updateThumbnailFromFunction({
  29     thumbnailCreator,
  30     filename,
  31     height,
  32     width,
  33     type,
  34     automaticallyGenerated,
  35     existingThumbnail
  36   })
  37 }
  38
  39 function updatePlaylistMiniatureFromUrl (options: {
  40   downloadUrl: string
  41   playlist: MVideoPlaylistThumbnail
  42   size?: ImageSize
  43 }) {
  44   const { downloadUrl, playlist, size } = options
  45   const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
  46   const type = ThumbnailType.MINIATURE
  47
  48   // Only save the file URL if it is a remote playlist
  49   const fileUrl = playlist.isOwned()
  50     ? null
  51     : downloadUrl
  52
  53   const thumbnailCreator = () => downloadImage(downloadUrl, basePath, filename, { width, height })
  54   return updateThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
  55 }
  56
  57 function updateVideoMiniatureFromUrl (options: {
  58   downloadUrl: string
  59   video: MVideoThumbnail
  60   type: ThumbnailType
  61   size?: ImageSize
  62 }) {
  63   const { downloadUrl, video, type, size } = options
  64   const { filename: updatedFilename, basePath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
  65
  66   // Only save the file URL if it is a remote video
  67   const fileUrl = video.isOwned()
  68     ? null
  69     : downloadUrl
  70
  71   const thumbnailUrlChanged = hasThumbnailUrlChanged(existingThumbnail, downloadUrl, video)
  72
  73   // Do not change the thumbnail filename if the file did not change
  74   const filename = thumbnailUrlChanged
  75     ? updatedFilename
  76     : existingThumbnail.filename
  77
  78   const thumbnailCreator = () => {
  79     if (thumbnailUrlChanged) return downloadImage(downloadUrl, basePath, filename, { width, height })
  80
  81     return Promise.resolve()
  82   }
  83
  84   return updateThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
  85 }
  86
  87 function updateVideoMiniatureFromExisting (options: {
  88   inputPath: string
  89   video: MVideoThumbnail
  90   type: ThumbnailType
  91   automaticallyGenerated: boolean
  92   size?: ImageSize
  93   keepOriginal?: boolean // default to false
  94 }) {
  95   const { inputPath, video, type, automaticallyGenerated, size, keepOriginal = false } = options
  96
  97   const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
  98   const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
  99
 100   return updateThumbnailFromFunction({
 101     thumbnailCreator,
 102     filename,
 103     height,
 104     width,
 105     type,
 106     automaticallyGenerated,
 107     existingThumbnail
 108   })
 109 }
 110
 111 function generateVideoMiniature (options: {
 112   video: MVideoThumbnail
 113   videoFile: MVideoFile
 114   type: ThumbnailType
 115 }) {
 116   const { video, videoFile, type } = options
 117
 118   return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(video), input => {
 119     const { filename, basePath, height, width, existingThumbnail, outputPath } = buildMetadataFromVideo(video, type)
 120
 121     const thumbnailCreator = videoFile.isAudio()
 122       ? () => processImage(ASSETS_PATH.DEFAULT_AUDIO_BACKGROUND, outputPath, { width, height }, true)
 123       : () => generateImageFromVideoFile(input, basePath, filename, { height, width })
 124
 125     return updateThumbnailFromFunction({
 126       thumbnailCreator,
 127       filename,
 128       height,
 129       width,
 130       type,
 131       automaticallyGenerated: true,
 132       existingThumbnail
 133     })
 134   })
 135 }
 136
 137 function updatePlaceholderThumbnail (options: {
 138   fileUrl: string
 139   video: MVideoThumbnail
 140   type: ThumbnailType
 141   size: ImageSize
 142 }) {
 143   const { fileUrl, video, type, size } = options
 144   const { filename: updatedFilename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
 145
 146   const thumbnailUrlChanged = hasThumbnailUrlChanged(existingThumbnail, fileUrl, video)
 147
 148   const thumbnail = existingThumbnail || new ThumbnailModel()
 149
 150   // Do not change the thumbnail filename if the file did not change
 151   const filename = thumbnailUrlChanged
 152     ? updatedFilename
 153     : existingThumbnail.filename
 154
 155   thumbnail.filename = filename
 156   thumbnail.height = height
 157   thumbnail.width = width
 158   thumbnail.type = type
 159   thumbnail.fileUrl = fileUrl
 160
 161   return thumbnail
 162 }
 163
 164 // ---------------------------------------------------------------------------
 165
 166 export {
 167   generateVideoMiniature,
 168   updateVideoMiniatureFromUrl,
 169   updateVideoMiniatureFromExisting,
 170   updatePlaceholderThumbnail,
 171   updatePlaylistMiniatureFromUrl,
 172   updatePlaylistMiniatureFromExisting
 173 }
 174
 175 function hasThumbnailUrlChanged (existingThumbnail: MThumbnail, downloadUrl: string, video: MVideoUUID) {
 176   const existingUrl = existingThumbnail
 177     ? existingThumbnail.fileUrl
 178     : null
 179
 180   // If the thumbnail URL did not change and has a unique filename (introduced in 3.1), avoid thumbnail processing
 181   return !existingUrl || existingUrl !== downloadUrl || downloadUrl.endsWith(`${video.uuid}.jpg`)
 182 }
 183
 184 function buildMetadataFromPlaylist (playlist: MVideoPlaylistThumbnail, size: ImageSize) {
 185   const filename = playlist.generateThumbnailName()
 186   const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
 187
 188   return {
 189     filename,
 190     basePath,
 191     existingThumbnail: playlist.Thumbnail,
 192     outputPath: join(basePath, filename),
 193     height: size ? size.height : THUMBNAILS_SIZE.height,
 194     width: size ? size.width : THUMBNAILS_SIZE.width
 195   }
 196 }
 197
 198 function buildMetadataFromVideo (video: MVideoThumbnail, type: ThumbnailType, size?: ImageSize) {
 199   const existingThumbnail = Array.isArray(video.Thumbnails)
 200     ? video.Thumbnails.find(t => t.type === type)
 201     : undefined
 202
 203   if (type === ThumbnailType.MINIATURE) {
 204     const filename = generateImageFilename()
 205     const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
 206
 207     return {
 208       filename,
 209       basePath,
 210       existingThumbnail,
 211       outputPath: join(basePath, filename),
 212       height: size ? size.height : THUMBNAILS_SIZE.height,
 213       width: size ? size.width : THUMBNAILS_SIZE.width
 214     }
 215   }
 216
 217   if (type === ThumbnailType.PREVIEW) {
 218     const filename = generateImageFilename()
 219     const basePath = CONFIG.STORAGE.PREVIEWS_DIR
 220
 221     return {
 222       filename,
 223       basePath,
 224       existingThumbnail,
 225       outputPath: join(basePath, filename),
 226       height: size ? size.height : PREVIEWS_SIZE.height,
 227       width: size ? size.width : PREVIEWS_SIZE.width
 228     }
 229   }
 230
 231   return undefined
 232 }
 233
 234 async function updateThumbnailFromFunction (parameters: {
 235   thumbnailCreator: () => Promise<any>
 236   filename: string
 237   height: number
 238   width: number
 239   type: ThumbnailType
 240   automaticallyGenerated?: boolean
 241   fileUrl?: string
 242   existingThumbnail?: MThumbnail
 243 }) {
 244   const {
 245     thumbnailCreator,
 246     filename,
 247     width,
 248     height,
 249     type,
 250     existingThumbnail,
 251     automaticallyGenerated = null,
 252     fileUrl = null
 253   } = parameters
 254
 255   const oldFilename = existingThumbnail && existingThumbnail.filename !== filename
 256     ? existingThumbnail.filename
 257     : undefined
 258
 259   const thumbnail: MThumbnail = existingThumbnail || new ThumbnailModel()
 260
 261   thumbnail.filename = filename
 262   thumbnail.height = height
 263   thumbnail.width = width
 264   thumbnail.type = type
 265   thumbnail.fileUrl = fileUrl
 266   thumbnail.automaticallyGenerated = automaticallyGenerated
 267
 268   if (oldFilename) thumbnail.previousThumbnailFilename = oldFilename
 269
 270   await thumbnailCreator()
 271
 272   return thumbnail
 273 }