Create a dedicated table to track video thumbnails

1 files changed, 151 insertions, 0 deletions

diff --git a/server/lib/thumbnail.ts b/server/lib/thumbnail.ts
new file mode 100644
index 000000000..344c28566
--- /dev/null
+++ b/server/lib/thumbnail.ts
@@ -0,0 +1,151 @@
+import { VideoFileModel } from '../models/video/video-file'
+import { generateImageFromVideoFile } from '../helpers/ffmpeg-utils'
+import { CONFIG } from '../initializers/config'
+import { PREVIEWS_SIZE, THUMBNAILS_SIZE } from '../initializers/constants'
+import { VideoModel } from '../models/video/video'
+import { ThumbnailModel } from '../models/video/thumbnail'
+import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
+import { processImage } from '../helpers/image-utils'
+import { join } from 'path'
+import { downloadImage } from '../helpers/requests'
+import { VideoPlaylistModel } from '../models/video/video-playlist'
+
+type ImageSize = { height: number, width: number }
+
+function createPlaylistThumbnailFromExisting (inputPath: string, playlist: VideoPlaylistModel, keepOriginal = false, size?: ImageSize) {
+  const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
+  const type = ThumbnailType.THUMBNAIL
+
+  const thumbnailCreator = () => processImage({ path: inputPath }, outputPath, { width, height }, keepOriginal)
+  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail })
+}
+
+function createPlaylistThumbnailFromUrl (url: string, playlist: VideoPlaylistModel, size?: ImageSize) {
+  const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
+  const type = ThumbnailType.THUMBNAIL
+
+  const thumbnailCreator = () => downloadImage(url, basePath, filename, { width, height })
+  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, url })
+}
+
+function createVideoThumbnailFromUrl (url: string, video: VideoModel, type: ThumbnailType, size?: ImageSize) {
+  const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
+  const thumbnailCreator = () => downloadImage(url, basePath, filename, { width, height })
+
+  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, url })
+}
+
+function createVideoThumbnailFromExisting (inputPath: string, video: VideoModel, type: ThumbnailType, size?: ImageSize) {
+  const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
+  const thumbnailCreator = () => processImage({ path: inputPath }, outputPath, { width, height })
+
+  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail })
+}
+
+function generateVideoThumbnail (video: VideoModel, videoFile: VideoFileModel, type: ThumbnailType) {
+  const input = video.getVideoFilePath(videoFile)
+
+  const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type)
+  const thumbnailCreator = () => generateImageFromVideoFile(input, basePath, filename, { height, width })
+
+  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail })
+}
+
+function createPlaceholderThumbnail (url: string, video: VideoModel, type: ThumbnailType, size: ImageSize) {
+  const { filename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
+
+  const thumbnail = existingThumbnail ? existingThumbnail : new ThumbnailModel()
+
+  thumbnail.filename = filename
+  thumbnail.height = height
+  thumbnail.width = width
+  thumbnail.type = type
+  thumbnail.url = url
+
+  return thumbnail
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  generateVideoThumbnail,
+  createVideoThumbnailFromUrl,
+  createVideoThumbnailFromExisting,
+  createPlaceholderThumbnail,
+  createPlaylistThumbnailFromUrl,
+  createPlaylistThumbnailFromExisting
+}
+
+function buildMetadataFromPlaylist (playlist: VideoPlaylistModel, size: ImageSize) {
+  const filename = playlist.generateThumbnailName()
+  const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
+
+  return {
+    filename,
+    basePath,
+    existingThumbnail: playlist.Thumbnail,
+    outputPath: join(basePath, filename),
+    height: size ? size.height : THUMBNAILS_SIZE.height,
+    width: size ? size.width : THUMBNAILS_SIZE.width
+  }
+}
+
+function buildMetadataFromVideo (video: VideoModel, type: ThumbnailType, size?: ImageSize) {
+  const existingThumbnail = Array.isArray(video.Thumbnails)
+    ? video.Thumbnails.find(t => t.type === type)
+    : undefined
+
+  if (type === ThumbnailType.THUMBNAIL) {
+    const filename = video.generateThumbnailName()
+    const basePath = CONFIG.STORAGE.THUMBNAILS_DIR
+
+    return {
+      filename,
+      basePath,
+      existingThumbnail,
+      outputPath: join(basePath, filename),
+      height: size ? size.height : THUMBNAILS_SIZE.height,
+      width: size ? size.width : THUMBNAILS_SIZE.width
+    }
+  }
+
+  if (type === ThumbnailType.PREVIEW) {
+    const filename = video.generatePreviewName()
+    const basePath = CONFIG.STORAGE.PREVIEWS_DIR
+
+    return {
+      filename,
+      basePath,
+      existingThumbnail,
+      outputPath: join(basePath, filename),
+      height: size ? size.height : PREVIEWS_SIZE.height,
+      width: size ? size.width : PREVIEWS_SIZE.width
+    }
+  }
+
+  return undefined
+}
+
+async function createThumbnailFromFunction (parameters: {
+  thumbnailCreator: () => Promise<any>,
+  filename: string,
+  height: number,
+  width: number,
+  type: ThumbnailType,
+  url?: string,
+  existingThumbnail?: ThumbnailModel
+}) {
+  const { thumbnailCreator, filename, width, height, type, existingThumbnail, url = null } = parameters
+
+  const thumbnail = existingThumbnail ? existingThumbnail : new ThumbnailModel()
+
+  thumbnail.filename = filename
+  thumbnail.height = height
+  thumbnail.width = width
+  thumbnail.type = type
+  thumbnail.url = url
+
+  await thumbnailCreator()
+
+  return thumbnail
+}