PeerTube/server/helpers/image-utils.ts

119 lines
3.5 KiB
TypeScript
Raw Normal View History

2021-02-16 10:19:09 +01:00
import { copy, readFile, remove, rename } from 'fs-extra'
2021-08-27 14:32:44 +02:00
import Jimp, { read } from 'jimp'
import { getLowercaseExtension } from './core-utils'
import { convertWebPToJPG, processGIF } from './ffmpeg-utils'
2018-12-04 15:12:54 +01:00
import { logger } from './logger'
import { buildUUID } from './uuid'
2020-07-10 14:54:11 +02:00
2021-04-08 11:23:45 +02:00
function generateImageFilename (extension = '.jpg') {
return buildUUID() + extension
2021-04-08 11:23:45 +02:00
}
async function processImage (
2019-04-24 09:56:25 +02:00
path: string,
destination: string,
newSize: { width: number, height: number },
keepOriginal = false
) {
const extension = getLowercaseExtension(path)
2020-11-25 09:50:12 +01:00
if (path === destination) {
throw new Error('Jimp/FFmpeg needs an input path different that the output path.')
}
logger.debug('Processing image %s to %s.', path, destination)
// Use FFmpeg to process GIF
if (extension === '.gif') {
2020-11-25 09:50:12 +01:00
await processGIF(path, destination, newSize)
} else {
2021-02-16 10:19:09 +01:00
await jimpProcessor(path, destination, newSize, extension)
}
2020-11-25 09:50:12 +01:00
if (keepOriginal !== true) await remove(path)
}
2018-11-19 11:24:31 +01:00
2020-11-25 09:50:12 +01:00
// ---------------------------------------------------------------------------
2018-11-19 11:24:31 +01:00
2020-11-25 09:50:12 +01:00
export {
2021-04-08 11:23:45 +02:00
generateImageFilename,
2020-11-25 09:50:12 +01:00
processImage
}
// ---------------------------------------------------------------------------
2021-02-16 10:19:09 +01:00
async function jimpProcessor (path: string, destination: string, newSize: { width: number, height: number }, inputExt: string) {
let sourceImage: Jimp
2021-02-16 10:19:09 +01:00
const inputBuffer = await readFile(path)
2020-07-10 14:54:11 +02:00
try {
sourceImage = await read(inputBuffer)
2020-07-10 14:54:11 +02:00
} catch (err) {
2020-10-26 16:44:23 +01:00
logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err })
2020-07-10 14:54:11 +02:00
const newName = path + '.jpg'
await convertWebPToJPG(path, newName)
await rename(newName, path)
sourceImage = await read(path)
2020-07-10 14:54:11 +02:00
}
2018-11-19 11:24:31 +01:00
await remove(destination)
2021-02-16 10:19:09 +01:00
// Optimization if the source file has the appropriate size
const outputExt = getLowercaseExtension(destination)
if (skipProcessing({ sourceImage, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt })) {
2021-02-16 10:19:09 +01:00
return copy(path, destination)
}
await autoResize({ sourceImage, newSize, destination })
}
async function autoResize (options: {
sourceImage: Jimp
newSize: { width: number, height: number }
destination: string
}) {
const { sourceImage, newSize, destination } = options
// Portrait mode targetting a landscape, apply some effect on the image
const sourceIsPortrait = sourceImage.getWidth() < sourceImage.getHeight()
const destIsPortraitOrSquare = newSize.width <= newSize.height
if (sourceIsPortrait && !destIsPortraitOrSquare) {
const baseImage = sourceImage.cloneQuiet().cover(newSize.width, newSize.height)
.color([ { apply: 'shade', params: [ 50 ] } ])
const topImage = sourceImage.cloneQuiet().contain(newSize.width, newSize.height)
return write(baseImage.blit(topImage, 0, 0), destination)
}
return write(sourceImage.cover(newSize.width, newSize.height), destination)
}
function write (image: Jimp, destination: string) {
return image.quality(80).writeAsync(destination)
}
2021-02-16 10:19:09 +01:00
function skipProcessing (options: {
sourceImage: Jimp
2021-02-16 10:19:09 +01:00
newSize: { width: number, height: number }
imageBytes: number
inputExt: string
outputExt: string
}) {
const { sourceImage, newSize, imageBytes, inputExt, outputExt } = options
2021-02-16 10:19:09 +01:00
const { width, height } = newSize
if (sourceImage.getWidth() > width || sourceImage.getHeight() > height) return false
2021-02-16 10:19:09 +01:00
if (inputExt !== outputExt) return false
const kB = 1000
if (height >= 1000) return imageBytes <= 200 * kB
if (height >= 500) return imageBytes <= 100 * kB
return imageBytes <= 15 * kB
}