ImageProcessingTask::prepareImage() - Code Metrics - Inspection of "Fix travis" - matiasdelellis/facerecognition - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — self-contained-model ( e0f8be...f0745e )

by Matias

created 2020-02-19 12:57 UTC

ImageProcessingTask::prepareImage() A

↳ Parent: ImageProcessingTask

Complexity

Conditions	4
Paths	3

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4.0058

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
cc	4
eloc	13
c	3
b	2
f	0
nc	3
nop	1
dl	0
loc	22
ccs	13
cts	14
cp	0.9286
crap	4.0058
rs	9.8333

<?php
/**
 * @copyright Copyright (c) 2017-2020 Matias De lellis <[email protected]>
 * @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
 *
 * @author Branko Kokanovic <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\FaceRecognition\BackgroundJob\Tasks;

use OCP\Image as OCP_Image;

use OCP\Files\File;
use OCP\Files\Folder;
use OCP\IUser;

use OCA\FaceRecognition\BackgroundJob\FaceRecognitionBackgroundTask;
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionContext;

use OCA\FaceRecognition\Db\Face;
use OCA\FaceRecognition\Db\Image;
use OCA\FaceRecognition\Db\ImageMapper;

use OCA\FaceRecognition\Helper\Requirements;

use OCA\FaceRecognition\Model\DlibCnnModel;
use OCA\FaceRecognition\Model\ModelManager;

use OCA\FaceRecognition\Service\FileService;
use OCA\FaceRecognition\Service\SettingsService;

/**
 * Plain old PHP object holding all information
 * that are needed to process all faces from one image
 */
class ImageProcessingContext {
	/** @var string Path to the image being processed */
	private $imagePath;

	/** @var string Path to temporary, resized image */
	private $tempPath;

	/** @var float Ratio of resized image, when scaling it */
	private $ratio;

	/** @var array<Face> All found faces in image */
	private $faces;

	/**
	 * @var bool True if detection should be skipped, but image should be marked as processed.
	 * If this is set, $tempPath and $ratio will be invalid and $faces should be empty array.
	 */
	private $skipDetection;

	public function __construct(string $imagePath, string $tempPath, float $ratio, bool $skipDetection) {
		$this->imagePath = $imagePath;
		$this->tempPath = $tempPath;
		$this->ratio = $ratio;
		$this->faces = array();
		$this->skipDetection = $skipDetection;
	}

	public function getImagePath(): string {
		return $this->imagePath;
	}

	public function getTempPath(): string {
		return $this->tempPath;
	}

	public function getRatio(): float {
		return $this->ratio;
	}

	public function getSkipDetection(): bool {
		return $this->skipDetection;
	}

	/**
	 * Gets all faces
	 *
	 * @return Face[] Array of faces
	 */
	public function getFaces(): array {
		return $this->faces;
	}

	/**
	 * @param array<Face> $faces Array of faces to set
	 */
	public function setFaces($faces) {
		$this->faces = $faces;
	}
}

/**
 * Taks that get all images that are still not processed and processes them.
 * Processing image means that each image is prepared, faces extracted form it,
 * and for each found face - face descriptor is extracted.
 */
class ImageProcessingTask extends FaceRecognitionBackgroundTask {
	/** @var ImageMapper Image mapper*/
	protected $imageMapper;

	/** @var FileService */
	protected $fileService;

	/** @var SettingsService */
	protected $settingsService;

	/** @var ModelManager */
	protected $modelManager;

	/** @var  DlibCnnModel */
	private $model;

	/** @var int|null Maximum image area (cached, so it is not recalculated for each image) */
	private $maxImageAreaCached;

	/**
	 * @param ImageMapper $imageMapper Image mapper
	 * @param FileService $fileService
	 * @param SettingsService $settingsService
	 * @param ModelManager $modelManager Model manager
	 */
	public function __construct(ImageMapper     $imageMapper,
	                            FileService     $fileService,
	                            SettingsService $settingsService,
	                            ModelManager    $modelManager)
	{
		parent::__construct();

		$this->imageMapper        = $imageMapper;
		$this->fileService        = $fileService;
		$this->settingsService    = $settingsService;
		$this->modelManager       = $modelManager;

		$this->model              = null;
		$this->maxImageAreaCached = null;
	}

	/**
	 * @inheritdoc
	 */
	public function description() {
		return "Process all images to extract faces";
	}

	/**
	 * @inheritdoc
	 */
	public function execute(FaceRecognitionContext $context) {
		$this->setContext($context);

		$this->logInfo('NOTE: Starting face recognition. If you experience random crashes after this point, please look FAQ at https://github.com/matiasdelellis/facerecognition/wiki/FAQ');

		// Get current model.
		$modelVersion = $this->settingsService->getCurrentFaceModel();
		$this->model = $this->modelManager->getModel($modelVersion);

		// Open model.
		$this->model->open();

		$images = $context->propertyBag['images'];
		foreach($images as $image) {
			yield;

			$startMillis = round(microtime(true) * 1000);

			try {
				$imageProcessingContext = $this->findFaces($this->model, $image);

				if (($imageProcessingContext !== null) && ($imageProcessingContext->getSkipDetection() === false)) {
					$this->populateDescriptors($this->model, $imageProcessingContext);
				}

				if ($imageProcessingContext === null) {
					continue;
				}

				$endMillis = round(microtime(true) * 1000);
				$duration = max($endMillis - $startMillis, 0);
				$this->imageMapper->imageProcessed($image, $imageProcessingContext->getFaces(), $duration);
			} catch (\Exception $e) {
				if ($e->getMessage() === "std::bad_alloc") {
					throw new \RuntimeException("Not enough memory to run face recognition! Please look FAQ at https://github.com/matiasdelellis/facerecognition/wiki/FAQ");
				}
				$this->logInfo('Faces found: 0. Image will be skipped because of the following error: ' . $e->getMessage());
				$this->logDebug($e);
				$this->imageMapper->imageProcessed($image, array(), 0, $e);
			} finally {
				$this->fileService->clean();
			}
		}

		return true;
	}

	/**
	 * Given an image, it finds all faces on it.
	 * If image should be skipped, returns null.
	 * If there is any error, throws exception
	 *
	 * @param DlibCnnModel $model Resnet model
	 * @param Image $image Image to find faces on
	 * @return ImageProcessingContext|null Generated context that hold all information needed later for this image
	 */
	private function findFaces(DlibCnnModel $model, Image $image) {
		// todo: check if this hits I/O (database, disk...), consider having lazy caching to return user folder from user
		$file = $this->fileService->getFileById($image->getFile(), $image->getUser());

		if (empty($file)) {
			// If we cannot find a file probably it was deleted out of our control and we must clean our tables.
			$this->settingsService->setNeedRemoveStaleImages(true, $image->user);
			$this->logInfo('File with ID ' . $image->file . ' doesn\'t exist anymore, skipping it');
			return null;
		}

		$imagePath = $this->fileService->getLocalFile($file);

		$this->logInfo('Processing image ' . $imagePath);
		$imageProcessingContext = $this->prepareImage($imagePath);
		if ($imageProcessingContext->getSkipDetection() === true) {
			$this->logInfo('Faces found: 0 (image will be skipped because it is too small)');
			return $imageProcessingContext;
		}

		// Detect faces from model
		$facesFound = $model->detectFaces($imageProcessingContext->getTempPath());

		// Convert from dictionary of faces to our Face Db Entity
		$faces = array();
		foreach ($facesFound as $faceFound) {
			$face = Face::fromModel($image->getId(), $faceFound);
			$face->normalizeSize($imageProcessingContext->getRatio());
			$faces[] = $face;
		}

		$imageProcessingContext->setFaces($faces);
		$this->logInfo('Faces found: ' . count($faces));

		return $imageProcessingContext;
	}

	/**
	 * Given an image, it will rotate, scale and save image to temp location, ready to be consumed by pdlib.
	 *
	 * @param string $imagePath Path to image on disk
	 *
	 * @return ImageProcessingContext Generated context that hold all information needed later for this image.
	 */
	private function prepareImage(string $imagePath) {
		$image = new OCP_Image(null, $this->context->logger->getLogger(), $this->context->config);
		$image->loadFromFile($imagePath);
		$image->fixOrientation();

		if (!$image->valid()) {
			throw new \RuntimeException("Image is not valid, probably cannot be loaded");
		}

		// Ignore processing of images that are not large enough.
		$minImageSize = $this->settingsService->getMinimumImageSize();
		if ((imagesx($image->resource()) < $minImageSize) || (imagesy($image->resource()) < $minImageSize)) {
			return new ImageProcessingContext($imagePath, "", -1, true);
		}

		$maxImageArea = $this->getMaxImageArea();
		$ratio = $this->resizeImage($image, $maxImageArea);

		$tempfile = $this->fileService->getTemporaryFile(pathinfo($imagePath, PATHINFO_EXTENSION));
		$image->save($tempfile);

		return new ImageProcessingContext($imagePath, $tempfile, $ratio, false);
	}

	/**
	 * Resizes the image to reach max image area, but preserving ratio.
	 * Stolen and adopted from OC_Image->resize() (difference is that this returns ratio of resize.)
	 *
	 * @param Image $image Image to resize
	 * @param int $maxImageArea The maximum size of image we can handle (in pixels^2).
	 *
	 * @return float Ratio of resize. 1 if there was no resize
	 */
	public function resizeImage(OCP_Image $image, int $maxImageArea): float {
		if (!$image->valid()) {
			$message = "Image is not valid, probably cannot be loaded";
			$this->logInfo($message);
			throw new \RuntimeException($message);
		}

		$widthOrig = imagesx($image->resource());
		$heightOrig = imagesy($image->resource());
		if (($widthOrig <= 0) || ($heightOrig <= 0)) {
			$message = "Image is having non-positive width or height, cannot continue";
			$this->logInfo($message);
			throw new \RuntimeException($message);
		}

		$areaRatio = $maxImageArea / ($widthOrig * $heightOrig);
		$scaleFactor = sqrt($areaRatio);

		$newWidth = intval(round($widthOrig * $scaleFactor));
		$newHeight = intval(round($heightOrig * $scaleFactor));

		$success = $image->preciseResize($newWidth, $newHeight);
		if ($success === false) {
			throw new \RuntimeException("Error during image resize");
		}

		$this->logDebug(sprintf('Image scaled from %dx%d to %dx%d (since max image area is %d pixels^2)',
			$widthOrig, $heightOrig, $newWidth, $newHeight, $maxImageArea));

		return 1 / $scaleFactor;
	}

	/**
	 * Gets all face descriptors in a given image processing context. Populates "descriptor" in array of faces.
	 *
	 * @param DlibCnnModel $model Resnet model
	 * @param ImageProcessingContext Image processing context
	 */
	private function populateDescriptors(DlibCnnModel $model, ImageProcessingContext $imageProcessingContext) {
		$faces = $imageProcessingContext->getFaces();

		foreach($faces as &$face) {
			// For each face, we want to detect landmarks and compute descriptors.
			// We use already resized image (from temp, used to detect faces) for this.
			// (better would be to work with original image, but that will require
			// another orientation fix and another save to the temp)
			// But, since our face coordinates are already changed to align to original image,
			// we need to fix them up to align them to temp image here.
			$normalizedFace = clone $face;
			$normalizedFace->normalizeSize(1.0 / $imageProcessingContext->getRatio());

			// We are getting face landmarks from already prepared (temp) image (resized and with orienation fixed).
			$landmarks = $model->detectLandmarks($imageProcessingContext->getTempPath(), array(
				"left" => $normalizedFace->left, "top" => $normalizedFace->top,
				"bottom" => $normalizedFace->bottom, "right" => $normalizedFace->right));
			$face->landmarks = $landmarks['parts'];

			$descriptor = $model->computeDescriptor($imageProcessingContext->getTempPath(), $landmarks);
			$face->descriptor = $descriptor;
		}
	}

	/**
	 * Obtains max image area lazily (from cache, or calculates it and puts it to cache)
	 *
	 * @return int Max image area (in pixels^2)
	 */
	private function getMaxImageArea(): int {
		if (!is_null($this->maxImageAreaCached)) {
			return $this->maxImageAreaCached;
		}

		$this->maxImageAreaCached = $this->calculateMaxImageArea();
		return $this->maxImageAreaCached;
	}

	/**
	 * Calculates max image area. This is separate function, as there are several levels of user overrides.
	 *
	 * @return int Max image area (in pixels^2)
	 */
	private function calculateMaxImageArea(): int {
		// First check if we are provided value from command line
		//
		if (
			(array_key_exists('max_image_area', $this->context->propertyBag)) &&
			(!is_null($this->context->propertyBag['max_image_area']))
		) {
				return $this->context->propertyBag['max_image_area'];
		}

		// Check if admin persisted this setting in config and it is valid value
		//
		$maxImageArea = $this->settingsService->getMaximumImageArea();
		if ($maxImageArea > 0) {
			return $maxImageArea;
		}

		// Calculate it from memory
		//
		$allowedMemory = $this->context->propertyBag['memory'];

		// Based on amount on memory PHP have, we will determine maximum amount of image size that we need to scale to.
		// This reasoning and calculations are all based on analysis given here:
		// https://github.com/matiasdelellis/facerecognition/wiki/Performance-analysis-of-DLib%E2%80%99s-CNN-face-detection
		$maxImageArea = intval(($allowedMemory) / SettingsService::MEMORY_AREA_RELATIONSHIP); // TODO: Maybe another helper.

		return $maxImageArea;
	}

}

1		<?php
2		/**
3		* @copyright Copyright (c) 2017-2020 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\IUser;
31
32		use OCA\FaceRecognition\BackgroundJob\FaceRecognitionBackgroundTask;
33		use OCA\FaceRecognition\BackgroundJob\FaceRecognitionContext;
34
35		use OCA\FaceRecognition\Db\Face;
36		use OCA\FaceRecognition\Db\Image;
37		use OCA\FaceRecognition\Db\ImageMapper;
38
39		use OCA\FaceRecognition\Helper\Requirements;
40
41		use OCA\FaceRecognition\Model\DlibCnnModel;
42		use OCA\FaceRecognition\Model\ModelManager;
43
44		use OCA\FaceRecognition\Service\FileService;
45		use OCA\FaceRecognition\Service\SettingsService;
46
47		/**
48		* Plain old PHP object holding all information
49		* that are needed to process all faces from one image
50		*/
51		class ImageProcessingContext {
52		/** @var string Path to the image being processed */
53		private $imagePath;
54
55		/** @var string Path to temporary, resized image */
56		private $tempPath;
57
58		/** @var float Ratio of resized image, when scaling it */
59		private $ratio;
60
61		/** @var array<Face> All found faces in image */
62		private $faces;
63
64		/**
65		* @var bool True if detection should be skipped, but image should be marked as processed.
66		* If this is set, $tempPath and $ratio will be invalid and $faces should be empty array.
67		*/
68		private $skipDetection;
69
70	3	public function __construct(string $imagePath, string $tempPath, float $ratio, bool $skipDetection) {
71	3	$this->imagePath = $imagePath;
72	3	$this->tempPath = $tempPath;
73	3	$this->ratio = $ratio;
74	3	$this->faces = array();
75	3	$this->skipDetection = $skipDetection;
76	3	}
77
78		public function getImagePath(): string {
79		return $this->imagePath;
80		}
81
82	2	public function getTempPath(): string {
83	2	return $this->tempPath;
84		}
85
86	1	public function getRatio(): float {
87	1	return $this->ratio;
88		}
89
90	3	public function getSkipDetection(): bool {
91	3	return $this->skipDetection;
92		}
93
94		/**
95		* Gets all faces
96		*
97		* @return Face[] Array of faces
98		*/
99	3	public function getFaces(): array {
100	3	return $this->faces;
101		}
102
103		/**
104		* @param array<Face> $faces Array of faces to set
105		*/
106	2	public function setFaces($faces) {
107	2	$this->faces = $faces;
108	2	}
109		}
110
111		/**
112		* Taks that get all images that are still not processed and processes them.
113		* Processing image means that each image is prepared, faces extracted form it,
114		* and for each found face - face descriptor is extracted.
115		*/
116		class ImageProcessingTask extends FaceRecognitionBackgroundTask {
117		/** @var ImageMapper Image mapper*/
118		protected $imageMapper;
119
120		/** @var FileService */
121		protected $fileService;
122
123		/** @var SettingsService */
124		protected $settingsService;
125
126		/** @var ModelManager */
127		protected $modelManager;
128
129		/** @var DlibCnnModel */
130		private $model;
131
132		/** @var int\|null Maximum image area (cached, so it is not recalculated for each image) */
133		private $maxImageAreaCached;
134
135		/**
136		* @param ImageMapper $imageMapper Image mapper
137		* @param FileService $fileService
138		* @param SettingsService $settingsService
139		* @param ModelManager $modelManager Model manager
140		*/
141	5	public function __construct(ImageMapper $imageMapper,
142		FileService $fileService,
143		SettingsService $settingsService,
144		ModelManager $modelManager)
145		{
146	5	parent::__construct();
147
148	5	$this->imageMapper = $imageMapper;
149	5	$this->fileService = $fileService;
150	5	$this->settingsService = $settingsService;
151	5	$this->modelManager = $modelManager;
152
153	5	$this->model = null;
154	5	$this->maxImageAreaCached = null;
155	5	}
156
157		/**
158		* @inheritdoc
159		*/
160	4	public function description() {
161	4	return "Process all images to extract faces";
162		}
163
164		/**
165		* @inheritdoc
166		*/
167	4	public function execute(FaceRecognitionContext $context) {
168	4	$this->setContext($context);
169
170	4	$this->logInfo('NOTE: Starting face recognition. If you experience random crashes after this point, please look FAQ at https://github.com/matiasdelellis/facerecognition/wiki/FAQ');
171
172		// Get current model.
173	4	$modelVersion = $this->settingsService->getCurrentFaceModel();
174	4	$this->model = $this->modelManager->getModel($modelVersion);
175
176		// Open model.
177	4	$this->model->open();
178
179	4	$images = $context->propertyBag['images'];
180	4	foreach($images as $image) {
181	4	yield;
182
183	4	$startMillis = round(microtime(true) * 1000);
184
185		try {
186	4	$imageProcessingContext = $this->findFaces($this->model, $image);
187
188	3	if (($imageProcessingContext !== null) && ($imageProcessingContext->getSkipDetection() === false)) {
189	2	$this->populateDescriptors($this->model, $imageProcessingContext);
190		}
191
192	3	if ($imageProcessingContext === null) {
193		continue;
194		}
195
196	3	$endMillis = round(microtime(true) * 1000);
197	3	$duration = max($endMillis - $startMillis, 0);
198	3	$this->imageMapper->imageProcessed($image, $imageProcessingContext->getFaces(), $duration);
199	1	} catch (\Exception $e) {
200	1	if ($e->getMessage() === "std::bad_alloc") {
201		throw new \RuntimeException("Not enough memory to run face recognition! Please look FAQ at https://github.com/matiasdelellis/facerecognition/wiki/FAQ");
202		}
203	1	$this->logInfo('Faces found: 0. Image will be skipped because of the following error: ' . $e->getMessage());
204	1	$this->logDebug($e);
205	1	$this->imageMapper->imageProcessed($image, array(), 0, $e);
206	4	} finally {
207	4	$this->fileService->clean();
208		}
209		}
210
211	4	return true;
212		}
213
214		/**
215		* Given an image, it finds all faces on it.
216		* If image should be skipped, returns null.
217		* If there is any error, throws exception
218		*
219		* @param DlibCnnModel $model Resnet model
220		* @param Image $image Image to find faces on
221		* @return ImageProcessingContext\|null Generated context that hold all information needed later for this image
222		*/
223	4	private function findFaces(DlibCnnModel $model, Image $image) {
224		// todo: check if this hits I/O (database, disk...), consider having lazy caching to return user folder from user
225	4	$file = $this->fileService->getFileById($image->getFile(), $image->getUser());
226
227	4	if (empty($file)) {
228		// If we cannot find a file probably it was deleted out of our control and we must clean our tables.
229		$this->settingsService->setNeedRemoveStaleImages(true, $image->user);
230		$this->logInfo('File with ID ' . $image->file . ' doesn\'t exist anymore, skipping it');
231		return null;
232		}
233
234	4	$imagePath = $this->fileService->getLocalFile($file);
235
236	4	$this->logInfo('Processing image ' . $imagePath);
237	4	$imageProcessingContext = $this->prepareImage($imagePath);
238	3	if ($imageProcessingContext->getSkipDetection() === true) {
239	1	$this->logInfo('Faces found: 0 (image will be skipped because it is too small)');
240	1	return $imageProcessingContext;
241		}
242
243		// Detect faces from model
244	2	$facesFound = $model->detectFaces($imageProcessingContext->getTempPath());
245
246		// Convert from dictionary of faces to our Face Db Entity
247	2	$faces = array();
248	2	foreach ($facesFound as $faceFound) {
249	1	$face = Face::fromModel($image->getId(), $faceFound);
250	1	$face->normalizeSize($imageProcessingContext->getRatio());
251	1	$faces[] = $face;
252		}
253
254	2	$imageProcessingContext->setFaces($faces);
255	2	$this->logInfo('Faces found: ' . count($faces));
256
257	2	return $imageProcessingContext;
258		}
259
260		/**
261		* Given an image, it will rotate, scale and save image to temp location, ready to be consumed by pdlib.
262		*
263		* @param string $imagePath Path to image on disk
264		*
265		* @return ImageProcessingContext Generated context that hold all information needed later for this image.
266		*/
267	4	private function prepareImage(string $imagePath) {
268	4	$image = new OCP_Image(null, $this->context->logger->getLogger(), $this->context->config);
269	4	$image->loadFromFile($imagePath);
270	3	$image->fixOrientation();
271
272	3	if (!$image->valid()) {
273		throw new \RuntimeException("Image is not valid, probably cannot be loaded");
274		}
275
276		// Ignore processing of images that are not large enough.
277	3	$minImageSize = $this->settingsService->getMinimumImageSize();
278	3	if ((imagesx($image->resource()) < $minImageSize) \|\| (imagesy($image->resource()) < $minImageSize)) {
279	1	return new ImageProcessingContext($imagePath, "", -1, true);
280		}
281
282	2	$maxImageArea = $this->getMaxImageArea();
283	2	$ratio = $this->resizeImage($image, $maxImageArea);
284
285	2	$tempfile = $this->fileService->getTemporaryFile(pathinfo($imagePath, PATHINFO_EXTENSION));
286	2	$image->save($tempfile);
287
288	2	return new ImageProcessingContext($imagePath, $tempfile, $ratio, false);
289		}
290
291		/**
292		* Resizes the image to reach max image area, but preserving ratio.
293		* Stolen and adopted from OC_Image->resize() (difference is that this returns ratio of resize.)
294		*
295		* @param Image $image Image to resize
296		* @param int $maxImageArea The maximum size of image we can handle (in pixels^2).
297		*
298		* @return float Ratio of resize. 1 if there was no resize
299		*/
300	3	public function resizeImage(OCP_Image $image, int $maxImageArea): float {
301	3	if (!$image->valid()) {
302		$message = "Image is not valid, probably cannot be loaded";
303		$this->logInfo($message);
304		throw new \RuntimeException($message);
305		}
306
307	3	$widthOrig = imagesx($image->resource());
308	3	$heightOrig = imagesy($image->resource());
309	3	if (($widthOrig <= 0) \|\| ($heightOrig <= 0)) {
310		$message = "Image is having non-positive width or height, cannot continue";
311		$this->logInfo($message);
312		throw new \RuntimeException($message);
313		}
314
315	3	$areaRatio = $maxImageArea / ($widthOrig * $heightOrig);
316	3	$scaleFactor = sqrt($areaRatio);
317
318	3	$newWidth = intval(round($widthOrig * $scaleFactor));
319	3	$newHeight = intval(round($heightOrig * $scaleFactor));
320
321	3	$success = $image->preciseResize($newWidth, $newHeight);
322	3	if ($success === false) {
323		throw new \RuntimeException("Error during image resize");
324		}
325
326	3	$this->logDebug(sprintf('Image scaled from %dx%d to %dx%d (since max image area is %d pixels^2)',
327	3	$widthOrig, $heightOrig, $newWidth, $newHeight, $maxImageArea));
328
329	3	return 1 / $scaleFactor;
330		}
331
332		/**
333		* Gets all face descriptors in a given image processing context. Populates "descriptor" in array of faces.
334		*
335		* @param DlibCnnModel $model Resnet model
336		* @param ImageProcessingContext Image processing context
337		*/
338	2	private function populateDescriptors(DlibCnnModel $model, ImageProcessingContext $imageProcessingContext) {
339	2	$faces = $imageProcessingContext->getFaces();
340
341	2	foreach($faces as &$face) {
342		// For each face, we want to detect landmarks and compute descriptors.
343		// We use already resized image (from temp, used to detect faces) for this.
344		// (better would be to work with original image, but that will require
345		// another orientation fix and another save to the temp)
346		// But, since our face coordinates are already changed to align to original image,
347		// we need to fix them up to align them to temp image here.
348	1	$normalizedFace = clone $face;
349	1	$normalizedFace->normalizeSize(1.0 / $imageProcessingContext->getRatio());
350
351		// We are getting face landmarks from already prepared (temp) image (resized and with orienation fixed).
352	1	$landmarks = $model->detectLandmarks($imageProcessingContext->getTempPath(), array(
353	1	"left" => $normalizedFace->left, "top" => $normalizedFace->top,
354	1	"bottom" => $normalizedFace->bottom, "right" => $normalizedFace->right));
355	1	$face->landmarks = $landmarks['parts'];
356
357	1	$descriptor = $model->computeDescriptor($imageProcessingContext->getTempPath(), $landmarks);
358	1	$face->descriptor = $descriptor;
359		}
360	2	}
361
362		/**
363		* Obtains max image area lazily (from cache, or calculates it and puts it to cache)
364		*
365		* @return int Max image area (in pixels^2)
366		*/
367	2	private function getMaxImageArea(): int {
368	2	if (!is_null($this->maxImageAreaCached)) {
369		return $this->maxImageAreaCached;
370		}
371
372	2	$this->maxImageAreaCached = $this->calculateMaxImageArea();
373	2	return $this->maxImageAreaCached;
374		}
375
376		/**
377		* Calculates max image area. This is separate function, as there are several levels of user overrides.
378		*
379		* @return int Max image area (in pixels^2)
380		*/
381	2	private function calculateMaxImageArea(): int {
382		// First check if we are provided value from command line
383		//
384		if (
385	2	(array_key_exists('max_image_area', $this->context->propertyBag)) &&
386	2	(!is_null($this->context->propertyBag['max_image_area']))
387		) {
388		return $this->context->propertyBag['max_image_area'];
389		}
390
391		// Check if admin persisted this setting in config and it is valid value
392		//
393	2	$maxImageArea = $this->settingsService->getMaximumImageArea();
394	2	if ($maxImageArea > 0) {
395	2	return $maxImageArea;
396		}
397
398		// Calculate it from memory
399		//
400		$allowedMemory = $this->context->propertyBag['memory'];
401
402		// Based on amount on memory PHP have, we will determine maximum amount of image size that we need to scale to.
403		// This reasoning and calculations are all based on analysis given here:
404		// https://github.com/matiasdelellis/facerecognition/wiki/Performance-analysis-of-DLib%E2%80%99s-CNN-face-detection
405		$maxImageArea = intval(($allowedMemory) / SettingsService::MEMORY_AREA_RELATIONSHIP); // TODO: Maybe another helper.
406
407		return $maxImageArea;
408		}
409
410		}

matiasdelellis / facerecognition

Push — self-contained-model ( e0f8be...f0745e )

ImageProcessingTask::prepareImage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like