server/helpers/image-utils.ts

   1 import { copy, readFile, remove, rename } from 'fs-extra'
   2 import Jimp, { read } from 'jimp'
   3 import { getLowercaseExtension } from '@shared/core-utils'
   4 import { buildUUID } from '@shared/extra-utils'
   5 import { convertWebPToJPG, processGIF } from './ffmpeg-utils'
   6 import { logger } from './logger'
   7
   8 function generateImageFilename (extension = '.jpg') {
   9   return buildUUID() + extension
  10 }
  11
  12 async function processImage (
  13   path: string,
  14   destination: string,
  15   newSize: { width: number, height: number },
  16   keepOriginal = false
  17 ) {
  18   const extension = getLowercaseExtension(path)
  19
  20   if (path === destination) {
  21     throw new Error('Jimp/FFmpeg needs an input path different that the output path.')
  22   }
  23
  24   logger.debug('Processing image %s to %s.', path, destination)
  25
  26   // Use FFmpeg to process GIF
  27   if (extension === '.gif') {
  28     await processGIF(path, destination, newSize)
  29   } else {
  30     await jimpProcessor(path, destination, newSize, extension)
  31   }
  32
  33   if (keepOriginal !== true) await remove(path)
  34 }
  35
  36 // ---------------------------------------------------------------------------
  37
  38 export {
  39   generateImageFilename,
  40   processImage
  41 }
  42
  43 // ---------------------------------------------------------------------------
  44
  45 async function jimpProcessor (path: string, destination: string, newSize: { width: number, height: number }, inputExt: string) {
  46   let sourceImage: Jimp
  47   const inputBuffer = await readFile(path)
  48
  49   try {
  50     sourceImage = await read(inputBuffer)
  51   } catch (err) {
  52     logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err })
  53
  54     const newName = path + '.jpg'
  55     await convertWebPToJPG(path, newName)
  56     await rename(newName, path)
  57
  58     sourceImage = await read(path)
  59   }
  60
  61   await remove(destination)
  62
  63   // Optimization if the source file has the appropriate size
  64   const outputExt = getLowercaseExtension(destination)
  65   if (skipProcessing({ sourceImage, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt })) {
  66     return copy(path, destination)
  67   }
  68
  69   await autoResize({ sourceImage, newSize, destination })
  70 }
  71
  72 async function autoResize (options: {
  73   sourceImage: Jimp
  74   newSize: { width: number, height: number }
  75   destination: string
  76 }) {
  77   const { sourceImage, newSize, destination } = options
  78
  79   // Portrait mode targetting a landscape, apply some effect on the image
  80   const sourceIsPortrait = sourceImage.getWidth() < sourceImage.getHeight()
  81   const destIsPortraitOrSquare = newSize.width <= newSize.height
  82
  83   if (sourceIsPortrait && !destIsPortraitOrSquare) {
  84     const baseImage = sourceImage.cloneQuiet().cover(newSize.width, newSize.height)
  85                                               .color([ { apply: 'shade', params: [ 50 ] } ])
  86
  87     const topImage = sourceImage.cloneQuiet().contain(newSize.width, newSize.height)
  88
  89     return write(baseImage.blit(topImage, 0, 0), destination)
  90   }
  91
  92   return write(sourceImage.cover(newSize.width, newSize.height), destination)
  93 }
  94
  95 function write (image: Jimp, destination: string) {
  96   return image.quality(80).writeAsync(destination)
  97 }
  98
  99 function skipProcessing (options: {
 100   sourceImage: Jimp
 101   newSize: { width: number, height: number }
 102   imageBytes: number
 103   inputExt: string
 104   outputExt: string
 105 }) {
 106   const { sourceImage, newSize, imageBytes, inputExt, outputExt } = options
 107   const { width, height } = newSize
 108
 109   if (sourceImage.getWidth() > width || sourceImage.getHeight() > height) return false
 110   if (inputExt !== outputExt) return false
 111
 112   const kB = 1000
 113
 114   if (height >= 1000) return imageBytes <= 200 * kB
 115   if (height >= 500) return imageBytes <= 100 * kB
 116
 117   return imageBytes <= 15 * kB
 118 }