OCA\FaceRecognition\Model\DlibHogModel\DlibHogModel

Complexity

Total Complexity

16

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	setDefault()	0	4	2
A	computeDescriptor()	0	2	1
A	getId()	0	2	1
A	install()	0	37	3
A	getName()	0	2	1
A	isInstalled()	0	3	1
A	detectFaces()	0	4	1
A	getDescription()	0	2	1
A	__construct()	0	9	1
A	open()	0	5	1
A	detectLandmarks()	0	2	1
A	meetDependencies()	0	3	2

<?php
/**
 * @copyright Copyright (c) 2020, Matias De lellis <mati86dl@gmail.com>
 * @copyright Copyright (c) 2018, Branko Kokanovic <branko@kokanovic.org>
 *
 * @author Branko Kokanovic <branko@kokanovic.org>
 *
 * @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\Model\DlibHogModel;

use OCP\IDBConnection;

use OCA\FaceRecognition\Helper\Requirements;

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

use OCA\FaceRecognition\Model\IModel;

class DlibHogModel implements IModel {

	/*
	 * Model files.
	 */
	const FACE_MODEL_ID = 3;
	const FACE_MODEL_NAME = "DlibHog";
	const FACE_MODEL_DESC = "Dlib HOG Model which needs lower requirements";

	const FACE_MODEL_BZ2_URLS = [
		'https://github.com/davisking/dlib-models/raw/4af9b776281dd7d6e2e30d4a2d40458b1e254e40/shape_predictor_5_face_landmarks.dat.bz2',
		'https://github.com/davisking/dlib-models/raw/2a61575dd45d818271c085ff8cd747613a48f20d/dlib_face_recognition_resnet_model_v1.dat.bz2'
	];

	const FACE_MODEL_FILES = [
		'shape_predictor_5_face_landmarks.dat',
		'dlib_face_recognition_resnet_model_v1.dat'
	];

	const I_MODEL_PREDICTOR = 0;
	const I_MODEL_RESNET = 1;

	/** @var \FaceLandmarkDetection */

The type FaceLandmarkDetection was not found. Maybe you did not declare it correctly or list all dependencies?

	private $fld;

	/** @var \FaceRecognition */

The type FaceRecognition was not found. Maybe you did not declare it correctly or list all dependencies?

	private $fr;

	/** @var IDBConnection */
	private $connection;

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

	/** @var ModelService */
	private $modelService;

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


	/**
	 * DlibCnnModel __construct.
	 *
	 * @param IDBConnection $connection
	 * @param FileService $fileService
	 * @param ModelService $modelService
	 * @param SettingsService $settingsService
	 */
	public function __construct(IDBConnection   $connection,
	                            FileService     $fileService,
	                            ModelService    $modelService,
	                            SettingsService $settingsService)
	{
		$this->connection       = $connection;
		$this->fileService      = $fileService;
		$this->modelService     = $modelService;
		$this->settingsService  = $settingsService;
	}

	public function getId(): int {
		return static::FACE_MODEL_ID;
	}

	public function getName(): string {
		return static::FACE_MODEL_NAME;
	}

	public function getDescription(): string {
		return static::FACE_MODEL_DESC;
	}

	public function isInstalled(): bool {
		$requirements = new Requirements($this->modelService, $this->getId());
		return $requirements->modelFilesPresent();
	}

	public function meetDependencies(): bool {
		return extension_loaded('pdlib') &&
		       version_compare(phpversion('pdlib'), '1.0.1', '>=');
	}

	public function install() {
		if ($this->isInstalled()) {
			return;
		}

		/* Still not installed but it is necessary to get the model folders */
		$this->modelService->useModelVersion($this->getId());

		/* Download and install models */
		$predictorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_PREDICTOR]);
		$this->fileService->bunzip2($predictorModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));

		$resnetModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_RESNET]);
		$this->fileService->bunzip2($resnetModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));

		/* Clean temporary files */
		$this->fileService->clean();

		// Insert on database and enable it
		$qb = $this->connection->getQueryBuilder();
		$query = $qb->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
			->from('facerecog_models')
			->where($qb->expr()->eq('id', $qb->createParameter('id')))
			->setParameter('id', $this->getId());
		$resultStatement = $query->execute();
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
		$resultStatement->closeCursor();

		if ((int)$data[0] <= 0) {
			$query = $this->connection->getQueryBuilder();
			$query->insert('facerecog_models')
			->values([
				'id' => $query->createNamedParameter($this->getId()),
				'name' => $query->createNamedParameter($this->getName()),
				'description' => $query->createNamedParameter($this->getDescription())
			])
			->execute();
		}
	}

	public function setDefault() {
		// Use default model, if it is not set already.
		if ($this->settingsService->getCurrentFaceModel() !== $this->getId()) {
			$this->settingsService->setCurrentFaceModel($this->getId());
		}
	}

	public function open() {
		$this->modelService->useModelVersion($this->getId());

		$this->fld = new \FaceLandmarkDetection($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
		$this->fr = new \FaceRecognition($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
	}

	public function detectFaces(string $imagePath): array {
		$faces_detected = dlib_face_detection($imagePath);

The function dlib_face_detection was not found. Maybe you did not declare it correctly or list all dependencies?

		// To improve clustering a confidence value is needed, which this model does not provide
		return array_map (function (array $face) { $face['detection_confidence'] = 1.0; return $face; }, $faces_detected);
	}

	public function detectLandmarks(string $imagePath, array $rect): array {
		return $this->fld->detect($imagePath, $rect);
	}

	public function computeDescriptor(string $imagePath, array $landmarks): array {
		return $this->fr->computeDescriptor($imagePath, $landmarks);
	}

}