]>
Commit | Line | Data |
---|---|---|
1 | import { copy, readFile, remove, rename } from 'fs-extra' | |
2 | import Jimp, { read as jimpRead } from 'jimp' | |
3 | import { join } from 'path' | |
4 | import { getLowercaseExtension } from '@shared/core-utils' | |
5 | import { buildUUID } from '@shared/extra-utils' | |
6 | import { convertWebPToJPG, generateThumbnailFromVideo, processGIF } from './ffmpeg/ffmpeg-images' | |
7 | import { logger, loggerTagsFactory } from './logger' | |
8 | ||
9 | const lTags = loggerTagsFactory('image-utils') | |
10 | ||
11 | function generateImageFilename (extension = '.jpg') { | |
12 | return buildUUID() + extension | |
13 | } | |
14 | ||
15 | async function processImage ( | |
16 | path: string, | |
17 | destination: string, | |
18 | newSize: { width: number, height: number }, | |
19 | keepOriginal = false | |
20 | ) { | |
21 | const extension = getLowercaseExtension(path) | |
22 | ||
23 | if (path === destination) { | |
24 | throw new Error('Jimp/FFmpeg needs an input path different that the output path.') | |
25 | } | |
26 | ||
27 | logger.debug('Processing image %s to %s.', path, destination) | |
28 | ||
29 | // Use FFmpeg to process GIF | |
30 | if (extension === '.gif') { | |
31 | await processGIF(path, destination, newSize) | |
32 | } else { | |
33 | await jimpProcessor(path, destination, newSize, extension) | |
34 | } | |
35 | ||
36 | if (keepOriginal !== true) await remove(path) | |
37 | } | |
38 | ||
39 | async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { | |
40 | const pendingImageName = 'pending-' + imageName | |
41 | const pendingImagePath = join(folder, pendingImageName) | |
42 | ||
43 | try { | |
44 | await generateThumbnailFromVideo(fromPath, folder, imageName) | |
45 | ||
46 | const destination = join(folder, imageName) | |
47 | await processImage(pendingImagePath, destination, size) | |
48 | } catch (err) { | |
49 | logger.error('Cannot generate image from video %s.', fromPath, { err, ...lTags() }) | |
50 | ||
51 | try { | |
52 | await remove(pendingImagePath) | |
53 | } catch (err) { | |
54 | logger.debug('Cannot remove pending image path after generation error.', { err, ...lTags() }) | |
55 | } | |
56 | } | |
57 | } | |
58 | ||
59 | async function getImageSize (path: string) { | |
60 | const inputBuffer = await readFile(path) | |
61 | ||
62 | const image = await jimpRead(inputBuffer) | |
63 | ||
64 | return { | |
65 | width: image.getWidth(), | |
66 | height: image.getHeight() | |
67 | } | |
68 | } | |
69 | ||
70 | // --------------------------------------------------------------------------- | |
71 | ||
72 | export { | |
73 | generateImageFilename, | |
74 | generateImageFromVideoFile, | |
75 | ||
76 | processImage, | |
77 | ||
78 | getImageSize | |
79 | } | |
80 | ||
81 | // --------------------------------------------------------------------------- | |
82 | ||
83 | async function jimpProcessor (path: string, destination: string, newSize: { width: number, height: number }, inputExt: string) { | |
84 | let sourceImage: Jimp | |
85 | const inputBuffer = await readFile(path) | |
86 | ||
87 | try { | |
88 | sourceImage = await jimpRead(inputBuffer) | |
89 | } catch (err) { | |
90 | logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err }) | |
91 | ||
92 | const newName = path + '.jpg' | |
93 | await convertWebPToJPG(path, newName) | |
94 | await rename(newName, path) | |
95 | ||
96 | sourceImage = await jimpRead(path) | |
97 | } | |
98 | ||
99 | await remove(destination) | |
100 | ||
101 | // Optimization if the source file has the appropriate size | |
102 | const outputExt = getLowercaseExtension(destination) | |
103 | if (skipProcessing({ sourceImage, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt })) { | |
104 | return copy(path, destination) | |
105 | } | |
106 | ||
107 | await autoResize({ sourceImage, newSize, destination }) | |
108 | } | |
109 | ||
110 | async function autoResize (options: { | |
111 | sourceImage: Jimp | |
112 | newSize: { width: number, height: number } | |
113 | destination: string | |
114 | }) { | |
115 | const { sourceImage, newSize, destination } = options | |
116 | ||
117 | // Portrait mode targetting a landscape, apply some effect on the image | |
118 | const sourceIsPortrait = sourceImage.getWidth() < sourceImage.getHeight() | |
119 | const destIsPortraitOrSquare = newSize.width <= newSize.height | |
120 | ||
121 | removeExif(sourceImage) | |
122 | ||
123 | if (sourceIsPortrait && !destIsPortraitOrSquare) { | |
124 | const baseImage = sourceImage.cloneQuiet().cover(newSize.width, newSize.height) | |
125 | .color([ { apply: 'shade', params: [ 50 ] } ]) | |
126 | ||
127 | const topImage = sourceImage.cloneQuiet().contain(newSize.width, newSize.height) | |
128 | ||
129 | return write(baseImage.blit(topImage, 0, 0), destination) | |
130 | } | |
131 | ||
132 | return write(sourceImage.cover(newSize.width, newSize.height), destination) | |
133 | } | |
134 | ||
135 | function write (image: Jimp, destination: string) { | |
136 | return image.quality(80).writeAsync(destination) | |
137 | } | |
138 | ||
139 | function skipProcessing (options: { | |
140 | sourceImage: Jimp | |
141 | newSize: { width: number, height: number } | |
142 | imageBytes: number | |
143 | inputExt: string | |
144 | outputExt: string | |
145 | }) { | |
146 | const { sourceImage, newSize, imageBytes, inputExt, outputExt } = options | |
147 | const { width, height } = newSize | |
148 | ||
149 | if (hasExif(sourceImage)) return false | |
150 | if (sourceImage.getWidth() > width || sourceImage.getHeight() > height) return false | |
151 | if (inputExt !== outputExt) return false | |
152 | ||
153 | const kB = 1000 | |
154 | ||
155 | if (height >= 1000) return imageBytes <= 200 * kB | |
156 | if (height >= 500) return imageBytes <= 100 * kB | |
157 | ||
158 | return imageBytes <= 15 * kB | |
159 | } | |
160 | ||
161 | function hasExif (image: Jimp) { | |
162 | return !!(image.bitmap as any).exifBuffer | |
163 | } | |
164 | ||
165 | function removeExif (image: Jimp) { | |
166 | (image.bitmap as any).exifBuffer = null | |
167 | } |