]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/helpers/image-utils.ts
Fix peertube subtitles import
[github/Chocobozzz/PeerTube.git] / server / helpers / image-utils.ts
index 7d6451db97114647a43e27457612e3e23111dad6..f86f7216d81d0161cf803f0a18026e27c2f5ae83 100644 (file)
@@ -1,9 +1,10 @@
 import { copy, readFile, remove, rename } from 'fs-extra'
 import Jimp, { read as jimpRead } from 'jimp'
 import { join } from 'path'
+import { ColorActionName } from '@jimp/plugin-color'
 import { getLowercaseExtension } from '@shared/core-utils'
 import { buildUUID } from '@shared/extra-utils'
-import { convertWebPToJPG, generateThumbnailFromVideo, processGIF } from './ffmpeg/ffmpeg-images'
+import { convertWebPToJPG, generateThumbnailFromVideo, processGIF } from './ffmpeg'
 import { logger, loggerTagsFactory } from './logger'
 
 const lTags = loggerTagsFactory('image-utils')
@@ -12,12 +13,14 @@ function generateImageFilename (extension = '.jpg') {
   return buildUUID() + extension
 }
 
-async function processImage (
-  path: string,
-  destination: string,
-  newSize: { width: number, height: number },
-  keepOriginal = false
-) {
+async function processImage (options: {
+  path: string
+  destination: string
+  newSize: { width: number, height: number }
+  keepOriginal?: boolean // default false
+}) {
+  const { path, destination, newSize, keepOriginal = false } = options
+
   const extension = getLowercaseExtension(path)
 
   if (path === destination) {
@@ -28,7 +31,7 @@ async function processImage (
 
   // Use FFmpeg to process GIF
   if (extension === '.gif') {
-    await processGIF(path, destination, newSize)
+    await processGIF({ path, destination, newSize })
   } else {
     await jimpProcessor(path, destination, newSize, extension)
   }
@@ -36,15 +39,22 @@ async function processImage (
   if (keepOriginal !== true) await remove(path)
 }
 
-async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
+async function generateImageFromVideoFile (options: {
+  fromPath: string
+  folder: string
+  imageName: string
+  size: { width: number, height: number }
+}) {
+  const { fromPath, folder, imageName, size } = options
+
   const pendingImageName = 'pending-' + imageName
   const pendingImagePath = join(folder, pendingImageName)
 
   try {
-    await generateThumbnailFromVideo(fromPath, folder, imageName)
+    await generateThumbnailFromVideo({ fromPath, folder, imageName })
 
     const destination = join(folder, imageName)
-    await processImage(pendingImagePath, destination, size)
+    await processImage({ path: pendingImagePath, destination, newSize: size })
   } catch (err) {
     logger.error('Cannot generate image from video %s.', fromPath, { err, ...lTags() })
 
@@ -90,7 +100,7 @@ async function jimpProcessor (path: string, destination: string, newSize: { widt
     logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err })
 
     const newName = path + '.jpg'
-    await convertWebPToJPG(path, newName)
+    await convertWebPToJPG({ path, destination: newName })
     await rename(newName, path)
 
     sourceImage = await jimpRead(path)
@@ -114,7 +124,7 @@ async function autoResize (options: {
 }) {
   const { sourceImage, newSize, destination } = options
 
-  // Portrait mode targetting a landscape, apply some effect on the image
+  // Portrait mode targeting a landscape, apply some effect on the image
   const sourceIsPortrait = sourceImage.getWidth() < sourceImage.getHeight()
   const destIsPortraitOrSquare = newSize.width <= newSize.height
 
@@ -122,7 +132,7 @@ async function autoResize (options: {
 
   if (sourceIsPortrait && !destIsPortraitOrSquare) {
     const baseImage = sourceImage.cloneQuiet().cover(newSize.width, newSize.height)
-                                              .color([ { apply: 'shade', params: [ 50 ] } ])
+                                              .color([ { apply: ColorActionName.SHADE, params: [ 50 ] } ])
 
     const topImage = sourceImage.cloneQuiet().contain(newSize.width, newSize.height)