Passed
Push — tracing-on-memory-limits ( e3a97e...1c9ced )
by Branko
02:13
created

ImageProcessingTask::resizeImage()   A

Complexity

Conditions 5
Paths 4

Size

Total Lines 30
Code Lines 20

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 14
CRAP Score 5.9256

Importance

Changes 0
Metric Value
cc 5
eloc 20
nc 4
nop 2
dl 0
loc 30
ccs 14
cts 21
cp 0.6667
crap 5.9256
rs 9.2888
c 0
b 0
f 0
1
<?php
2
/**
3
 * @copyright Copyright (c) 2017, Matias De lellis <[email protected]>
4
 * @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
5
 *
6
 * @author Branko Kokanovic <[email protected]>
7
 *
8
 * @license GNU AGPL version 3 or any later version
9
 *
10
 * This program is free software: you can redistribute it and/or modify
11
 * it under the terms of the GNU Affero General Public License as
12
 * published by the Free Software Foundation, either version 3 of the
13
 * License, or (at your option) any later version.
14
 *
15
 * This program is distributed in the hope that it will be useful,
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 * GNU Affero General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU Affero General Public License
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
 *
23
 */
24
namespace OCA\FaceRecognition\BackgroundJob\Tasks;
25
26
use OCP\Image as OCP_Image;
27
28
use OCP\Files\File;
29
use OCP\Files\Folder;
30
use OCP\IConfig;
31
use OCP\ITempManager;
32
use OCP\IUser;
33
34
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionBackgroundTask;
35
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionContext;
36
use OCA\FaceRecognition\Db\Face;
37
use OCA\FaceRecognition\Db\Image;
38
use OCA\FaceRecognition\Db\ImageMapper;
39
use OCA\FaceRecognition\Helper\Requirements;
40
use OCA\FaceRecognition\Migration\AddDefaultFaceModel;
41
42
/**
43
 * Plain old PHP object holding all information
44
 * that are needed to process all faces from one image
45
 */
46
class ImageProcessingContext {
47
	/** @var string Path to the image being processed */
48
	private $imagePath;
49
50
	/** @var string Path to temporary, resized image */
51
	private $tempPath;
52
53
	/** @var float Ratio of resized image, when scaling it */
54
	private $ratio;
55
56
	/** @var array<Face> All found faces in image */
57
	private $faces;
58
59
	public function __construct(string $imagePath, string $tempPath, float $ratio) {
60
		$this->imagePath = $imagePath;
61
		$this->tempPath = $tempPath;
62
		$this->ratio = $ratio;
63
	}
64
65
	public function getImagePath(): string {
66
		return $this->imagePath;
67
	}
68
69
	public function getTempPath(): string {
70
		return $this->tempPath;
71
	}
72
73
	public function getRatio(): float {
74
		return $this->ratio;
75
	}
76
77
	/**
78
	 * Gets all faces
79
	 *
80
	 * @return Face[] Array of faces
81
	 */
82
	public function getFaces(): array {
83
		return $this->faces;
84
	}
85
86
	/**
87
	 * @param array<Face> $faces Array of faces to set
88
	 */
89
	public function setFaces($faces) {
90
		$this->faces = $faces;
91
	}
92
}
93
94
/**
95
 * Taks that get all images that are still not processed and processes them.
96
 * Processing image means that each image is prepared, faces extracted form it,
97
 * and for each found face - face descriptor is extracted.
98
 */
99
class ImageProcessingTask extends FaceRecognitionBackgroundTask {
100
	/** @var IConfig Config */
101
	private $config;
102
103
	/** @var ImageMapper Image mapper*/
104
	protected $imageMapper;
105
106
	/** @var ITempManager */
107
	private $tempManager;
108
109
	/**
110
	 * @param ImageMapper $imageMapper Image mapper
111
	 */
112 1
	public function __construct(IConfig $config, ImageMapper $imageMapper, ITempManager $tempManager) {
113 1
		parent::__construct();
114 1
		$this->config = $config;
115 1
		$this->imageMapper = $imageMapper;
116 1
		$this->tempManager = $tempManager;
117 1
	}
118
119
	/**
120
	 * @inheritdoc
121
	 */
122
	public function description() {
123
		return "Process all images to extract faces";
124
	}
125
126
	/**
127
	 * @inheritdoc
128
	 */
129
	public function execute(FaceRecognitionContext $context) {
130
		$this->setContext($context);
131
132
		$model = intval($this->config->getAppValue('facerecognition', 'model', AddDefaultFaceModel::DEFAULT_FACE_MODEL_ID));
133
		$requirements = new Requirements($context->appManager, $model);
134
135
		$dataDir = rtrim($context->config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data'), '/');
136
		$images = $context->propertyBag['images'];
137
138
		$cfd = new \CnnFaceDetection($requirements->getFaceDetectionModel());
0 ignored issues
show
Bug introduced by
The type CnnFaceDetection was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
139
		$fld = new \FaceLandmarkDetection($requirements->getLandmarksDetectionModel());
0 ignored issues
show
Bug introduced by
The type FaceLandmarkDetection was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
140
		$fr = new \FaceRecognition($requirements->getFaceRecognitionModel());
0 ignored issues
show
Bug introduced by
The type FaceRecognition was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
141
142
		foreach($images as $image) {
143
			yield;
144
145
			$imageProcessingContext = null;
0 ignored issues
show
Unused Code introduced by
The assignment to $imageProcessingContext is dead and can be removed.
Loading history...
146
			$startMillis = round(microtime(true) * 1000);
147
			try {
148
				$imageProcessingContext = $this->findFaces($cfd, $dataDir, $image);
149
				if ($imageProcessingContext === null) {
150
					// We didn't got exception, but null result means we should skip this image
151
					continue;
152
				}
153
154
				$this->populateDescriptors($fld, $fr, $imageProcessingContext);
155
156
				$endMillis = round(microtime(true) * 1000);
157
				$duration = max($endMillis - $startMillis, 0);
158
				$this->imageMapper->imageProcessed($image, $imageProcessingContext->getFaces(), $duration);
159
			} catch (\Exception $e) {
160
				$this->imageMapper->imageProcessed($image, array(), 0, $e);
161
			} finally {
162
				$this->tempManager->clean();
163
			}
164
		}
165
166
		return true;
167
	}
168
169
	/**
170
	 * Given an image, it finds all faces on it.
171
	 * If image should be skipped, returns null.
172
	 * If there is any error, throws exception
173
	 *
174
	 * @param \CnnFaceDetection $cfd Face detection model
175
	 * @param string $dataDir Directory where data is stored
176
	 * @param Image $image Image to find faces on
177
	 * @return ImageProcessingContext|null Generated context that hold all information needed later for this image
178
	 */
179
	private function findFaces(\CnnFaceDetection $cfd, string $dataDir, Image $image) {
180
		// todo: check if this hits I/O (database, disk...), consider having lazy caching to return user folder from user
181
		$userFolder = $this->context->rootFolder->getUserFolder($image->user);
182
		$userRoot = $userFolder->getParent();
183
		$file = $userRoot->getById($image->file);
184
		if (empty($file)) {
185
			$this->logInfo('File with ID ' . $image->file . ' doesn\'t exist anymore, skipping it');
186
			return null;
187
		}
188
189
		// todo: this concat is wrong with shared files.
190
		$imagePath = $dataDir . $file[0]->getPath();
191
		$this->logInfo('Processing image ' . $imagePath);
192
		$imageProcessingContext = $this->prepareImage($imagePath);
193
		if ($imageProcessingContext == null) {
194
			return null;
195
		}
196
197
		// Detect faces from model
198
		$facesFound = $cfd->detect($imageProcessingContext->getTempPath());
199
200
		// Convert from dictionary of faces to our Face Db Entity
201
		$faces = array();
202
		foreach ($facesFound as $faceFound) {
203
			$face = Face::fromModel($image->getId(), $faceFound);
204
			$face->normalizeSize($imageProcessingContext->getRatio());
205
			$faces[] = $face;
206
		}
207
208
		$imageProcessingContext->setFaces($faces);
209
		$this->logInfo('Faces found ' . count($faces));
210
211
		return $imageProcessingContext;
212
	}
213
214
	/**
215
	 * Given an image, it will rotate, scale and save image to temp location, ready to be consumed by pdlib.
216
	 *
217
	 * @param string $imagePath Path to image on disk
218
	 *
219
	 * @return ImageProcessingContext|null Generated context that hold all information needed later for this image
220
	 * or null if images should be skipped.
221
	 */
222
	private function prepareImage(string $imagePath) {
223
		$image = new OCP_Image(null, $this->context->logger->getLogger(), $this->context->config);
224
		$image->loadFromFile($imagePath);
225
		$image->fixOrientation();
226
		if (!$image->valid()) {
227
			throw new \RuntimeException("Image is not valid, probably cannot be loaded");
228
		}
229
230
		// Ignore processing of images that are not large enough.
231
		$minImageSize = intval($this->config->getAppValue('facerecognition', 'min_image_size', '512'));
232
		if ((imagesx($image->resource()) < $minImageSize) || (imagesy($image->resource()) < $minImageSize)) {
233
			return null;
234
		}
235
236
		// Based on amount on memory PHP have, we will determine maximum amount of image size that we need to scale to.
237
		// This reasoning and calculations are all based on analysis given here:
238
		// https://github.com/matiasdelellis/facerecognition/wiki/Performance-analysis-of-DLib%E2%80%99s-CNN-face-detection
239
		$allowedMemory = $this->context->propertyBag['memory'];
240
		$maxImageArea = intval((0.75 * $allowedMemory) / 1024); // in pixels^2
241
		$ratio = $this->resizeImage($image, $maxImageArea);
242
243
		$tempfile = $this->tempManager->getTemporaryFile(pathinfo($imagePath, PATHINFO_EXTENSION));
244
		$image->save($tempfile);
245
		return new ImageProcessingContext($imagePath, $tempfile, $ratio);
246
	}
247
248
	/**
249
	 * Resizes the image to reach max image area, but preserving ratio.
250
	 * Stolen and adopted from OC_Image->resize() (difference is that this returns ratio of resize.)
251
	 *
252
	 * @param OC_Image $image Image to resize
0 ignored issues
show
Bug introduced by
The type OCA\FaceRecognition\BackgroundJob\Tasks\OC_Image was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
253
	 * @param int $maxImageArea The maximum size of image we can handle (in pixels^2).
254
	 *
255
	 * @return float Ratio of resize. 1 if there was no resize
256
	 */
257 1
	public function resizeImage(OCP_Image $image, int $maxImageArea): float {
258 1
		if (!$image->valid()) {
259
			$message = "Image is not valid, probably cannot be loaded";
260
			$this->logInfo($message);
261
			throw new \RuntimeException($message);
262
		}
263
264 1
		$widthOrig = imagesx($image->resource());
265 1
		$heightOrig = imagesy($image->resource());
266 1
		if (($widthOrig <= 0) || ($heightOrig <= 0)) {
267
			$message = "Image is having non-positive width or height, cannot continue";
268
			$this->logInfo($message);
269
			throw new \RuntimeException($message);
270
		}
271
272 1
		$areaRatio = $maxImageArea / ($widthOrig * $heightOrig);
273 1
		$scaleFactor = sqrt($areaRatio);
274
275 1
		$newWidth = intval(round($widthOrig * $scaleFactor));
276 1
		$newHeight = intval(round($heightOrig * $scaleFactor));
277
278 1
		$success = $image->preciseResize($newWidth, $newHeight);
279 1
		if ($success === false) {
280
			throw new \RuntimeException("Error during image resize");
281
		}
282
283 1
		$this->logDebug(sprintf('Image scaled from %dx%d to %dx%d (since max image area is %d pixels^2)',
284 1
			$newWidth, $newHeight, $widthOrig, $heightOrig, $maxImageArea));
285
286 1
		return 1 / $scaleFactor;
287
	}
288
289
	/**
290
	 * Gets all face descriptors in a given image processing context. Populates "descriptor" in array of faces.
291
	 *
292
	 * @param \FaceLandmarkDetection $fld Landmark detection model
293
	 * @param \FaceRecognition $fr Face recognition model
294
	 * @param ImageProcessingContext Image processing context
295
	 */
296
	private function populateDescriptors(\FaceLandmarkDetection $fld, \FaceRecognition $fr, ImageProcessingContext $imageProcessingContext) {
297
		$faces = $imageProcessingContext->getFaces();
298
299
		foreach($faces as &$face) {
300
			$tempfilePath = $this->cropFace($imageProcessingContext->getImagePath(), $face);
301
302
			// Usually, second argument to detect should be just $face. However, since we are doing image acrobatics
303
			// and already have cropped image, bounding box for landmark detection is now complete (cropped) image!
304
			$landmarks = $fld->detect($tempfilePath, array(
305
				"left" => 0, "top" => 0, "bottom" => $face->height(), "right" => $face->width()));
306
			$descriptor = $fr->computeDescriptor($tempfilePath, $landmarks);
307
			$face->descriptor = $descriptor;
308
		}
309
	}
310
311
	private function cropFace(string $imagePath, Face $face): string {
312
		// todo: we are loading same image two times, fix this
313
		$image = new OCP_Image(null, $this->context->logger->getLogger(), $this->context->config);
314
		$image->loadFromFile($imagePath);
315
		$image->fixOrientation();
316
		$success = $image->crop($face->left, $face->top, $face->width(), $face->height());
317
		if ($success === false) {
318
			throw new \RuntimeException("Error during image cropping");
319
		}
320
321
		$tempfile = $this->tempManager->getTemporaryFile(pathinfo($imagePath, PATHINFO_EXTENSION));
322
		$image->save($tempfile);
323
		return $tempfile;
324
	}
325
}