server/lib/thumbnail.ts

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