Passed
Push — self-contained-model ( 0ea11c...ff9f8b )
by Matias
05:11
created

DlibCnnModel::detectFaces()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 2
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 1
c 0
b 0
f 0
nc 1
nop 1
dl 0
loc 2
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
/**
3
 * @copyright Copyright (c) 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
25
namespace OCA\FaceRecognition\Model\DlibCnnModel;
26
27
use OCP\IDBConnection;
28
29
use OCA\FaceRecognition\Service\FileService;
30
use OCA\FaceRecognition\Service\ModelService;
31
use OCA\FaceRecognition\Service\SettingsService;
32
33
use OCA\FaceRecognition\Model\IModel;
34
35
class DlibCnnModel implements IModel {
36
37
	/*
38
	 * Model files.
39
	 */
40
	const FACE_MODEL_ID = -1;
41
	const FACE_MODEL_NAME = "";
42
	const FACE_MODEL_DESC = "";
43
44
	/** Relationship between image size and memory consumed */
45
	const MEMORY_AREA_RELATIONSHIP = -1;
46
47
	const FACE_MODEL_BZ2_URLS = array();
48
	const FACE_MODEL_FILES = array();
49
50
	const I_MODEL_DETECTOR = 0;
51
	const I_MODEL_PREDICTOR = 1;
52
	const I_MODEL_RESNET = 2;
53
54
	/** @var \CnnFaceDetection */
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...
55
	private $cfd;
56
57
	/** @var \FaceLandmarkDetection */
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...
58
	private $fld;
59
60
	/** @var \FaceRecognition */
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...
61
	private $fr;
62
63
	/** @var IDBConnection */
64
	private $connection;
65
66
	/** @var FileService */
67
	private $fileService;
68
69
	/** @var ModelService */
70
	private $modelService;
71
72
	/** @var SettingsService */
73
	private $settingsService;
74
75
76
	/**
77
	 * DlibCnnModel __construct.
78
	 *
79
	 * @param IDBConnection $connection
80
	 * @param FileService $fileService
81
	 * @param ModelService $modelService
82
	 * @param SettingsService $settingsService
83
	 */
84 1
	public function __construct(IDBConnection   $connection,
85
	                            FileService     $fileService,
86
	                            ModelService    $modelService,
87
	                            SettingsService $settingsService)
88
	{
89 1
		$this->connection       = $connection;
90 1
		$this->fileService      = $fileService;
91 1
		$this->modelService     = $modelService;
92 1
		$this->settingsService  = $settingsService;
93
94 1
		$this->modelService->useModelVersion($this->getId());
95 1
	}
96
97 1
	public function getId(): int {
98 1
		return static::FACE_MODEL_ID;
99
	}
100
101
	public function getName(): string {
102
		return static::FACE_MODEL_NAME;
103
	}
104
105
	public function getDescription(): string {
106
		return static::FACE_MODEL_DESC;
107
	}
108
109
	public function isInstalled(): bool {
110
		if (!$this->modelService->modelFileExists(static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]))
111
			return false;
112
		if (!$this->modelService->modelFileExists(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]))
113
			return false;
114
		if (!$this->modelService->modelFileExists(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]))
115
			return false;
116
		return true;
117
	}
118
119
	public function meetDependencies(): bool {
120
		return extension_loaded('pdlib');
121
	}
122
123
	public function install() {
124
		if ($this->isInstalled()) {
125
			return;
126
		}
127
128
		/* Download and install models */
129
		$detectorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_DETECTOR]);
130
		$this->fileService->bunzip2($detectorModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
131
132
		$predictorModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_PREDICTOR]);
133
		$this->fileService->bunzip2($predictorModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
134
135
		$resnetModelBz2 = $this->fileService->downloaldFile(static::FACE_MODEL_BZ2_URLS[self::I_MODEL_RESNET]);
136
		$this->fileService->bunzip2($resnetModelBz2, $this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
137
138
		/* Clean temporary files */
139
		$this->fileService->clean();
140
141
		// Insert on database and enable it
142
		$qb = $this->connection->getQueryBuilder();
143
		$query = $qb->select($qb->createFunction('COUNT(' . $qb->getColumnName('id') . ')'))
144
			->from('facerecog_models')
145
			->where($qb->expr()->eq('id', $qb->createParameter('id')))
146
			->setParameter('id', $this->getId());
147
		$resultStatement = $query->execute();
148
		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
149
		$resultStatement->closeCursor();
150
151
		if ((int)$data[0] <= 0) {
152
			$query = $this->connection->getQueryBuilder();
153
			$query->insert('facerecog_models')
154
			->values([
155
				'id' => $query->createNamedParameter($this->getId()),
156
				'name' => $query->createNamedParameter($this->getName()),
157
				'description' => $query->createNamedParameter($this->getDescription())
158
			])
159
			->execute();
160
		}
161
	}
162
163
	public function setDefault() {
164
		// Use default model, if it is not set already.
165
		if ($this->settingsService->getCurrentFaceModel() !== $this->getId()) {
166
			$this->settingsService->setCurrentFaceModel($this->getId());
167
		}
168
	}
169
170 4
	public function open() {
171 4
		$this->cfd = new \CnnFaceDetection($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_DETECTOR]));
172 3
		$this->fld = new \FaceLandmarkDetection($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_PREDICTOR]));
173 3
		$this->fr = new \FaceRecognition($this->modelService->getModelPath(static::FACE_MODEL_FILES[self::I_MODEL_RESNET]));
174 3
	}
175
176
	public function getMemoryAreaRelation(): int {
177
		return static::MEMORY_AREA_RELATIONSHIP;
178
	}
179
180 2
	public function detectFaces(string $imagePath): array {
181 2
		return $this->cfd->detect($imagePath);
182
	}
183
184 1
	public function detectLandmarks(string $imagePath, array $rect): array {
185 1
		return $this->fld->detect($imagePath, $rect);
186
	}
187
188 1
	public function computeDescriptor(string $imagePath, array $landmarks): array {
189 1
		return $this->fr->computeDescriptor($imagePath, $landmarks);
190
	}
191
192
}
193