1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*
* Copyright (C) 2016 Canonical, Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Thomas Voß <thomas.voss@canonical.com>
*
*/
#ifndef BIOMETRYD_DEVICES_FINGERPRINT_READER_H_
#define BIOMETRYD_DEVICES_FINGERPRINT_READER_H_
#include <biometry/device.h>
#include <biometry/optional.h>
#include <biometry/percent.h>
#include <biometry/geometry.h>
#include <biometry/template_store.h>
#include <biometry/visibility.h>
namespace biometry
{
namespace devices
{
/// @brief FingerprintReader specializes a biometry::Device, providing
/// methods and structures to handle specific feedback during enrollment of
/// fingerprints.
class BIOMETRY_DLL_PUBLIC FingerprintReader : public Device
{
public:
/// @brief Direction enumerates all known direction hints.
enum class Direction
{
not_available = 0,
south_west = 1,
south = 2,
south_east = 3,
north_west = 4,
north = 5,
north_east = 6,
east = 7,
west = 8
};
/// @brief GuidedEnrollment describes a guided enrollment operation with the
/// underlying hw/driver stack providing guidance data to users of the device
/// such that enrollment can happen as fast as possible.
struct GuidedEnrollment
{
struct Hints
{
/// @cond
static constexpr const char* key_is_finger_present
{
"FingerprintReader::Hints::is_finger_present"
};
static constexpr const char* key_is_main_cluster_identified
{
"FingerprintReader::Hints::is_main_cluster_identified"
};
static constexpr const char* key_suggested_next_direction
{
"FingerprintReader::Hints::suggested_next_direction"
};
static constexpr const char* key_estimated_finger_size
{
"FingerprintReader::Hints::estimated_finger_size"
};
static constexpr const char* key_masks
{
"FingerprintReader::Hints::masks"
};
/// @endcond
/// @brief from_dictionary decodes guidance data from dict.
void from_dictionary(const Dictionary& dict);
/// @brief to_dictionary encodes guidance data to dict.
Dictionary to_dictionary() const;
Optional<bool> is_finger_present{}; ///< If set: true indicates that the user's finger is present.
Optional<bool> is_main_cluster_identified{}; ///< If set: true indicates that the main cluster of the fingerprint has been identified.
Optional<Direction> suggested_next_direction{}; ///< If set: Direction of the next touch.
Optional<std::vector<Rectangle>> masks{}; ///< If set: A vector of rectangles marking all the regions that have been scanned and accepted.
};
/// @brief ProgressWithGuidance bundles guidance data meant for visualization purposes
/// to help the user when enrolling a new fingerprint.
struct ProgressWithGuidance
{
Percent percent{Percent::from_raw_value(0.f)}; ///< Percentage completed.
Hints guidance;
};
typedef ProgressWithGuidance Progress;
typedef biometry::TemplateStore::Enrollment::Reason Reason;
typedef biometry::TemplateStore::Enrollment::Error Error;
typedef biometry::TemplateStore::Enrollment::Result Result;
};
/// @brief TemplateStore is an implementation of biometry::TemplateStore providing
/// additional guidance data during the enrollment process.
class TemplateStore : public biometry::TemplateStore
{
public:
/// @brief TemplateStore initializes a new instance with the given impl.
explicit TemplateStore(const std::reference_wrapper<biometry::TemplateStore>& impl);
/// @brief guided_enroll returns a GuidedEnrollment operation ready to be started.
Operation<GuidedEnrollment>::Ptr guided_enroll(const Application& app, const User& user);
// From biometry::TemplateStore.
Operation<SizeQuery>::Ptr size(const Application& app, const User& user) override;
Operation<List>::Ptr list(const Application& app, const User& user) override;
Operation<Enrollment>::Ptr enroll(const Application& app, const User& user) override;
Operation<Removal>::Ptr remove(const Application& app, const User& user, TemplateStore::TemplateId id) override;
Operation<Clearance>::Ptr clear(const Application& app, const User& user) override;
private:
/// @cond
std::reference_wrapper<biometry::TemplateStore> impl;
/// @endcond
};
/// @brief FingerprintReader initializes a new instance with the given device instance.
explicit FingerprintReader(const std::shared_ptr<Device>& device);
/// @brief template_store_with_guided_enrollment returns a TemplateStore providing support for guided enrollments.
FingerprintReader::TemplateStore& template_store_with_guided_enrollment();
/// @brief enroller returns a device-specific template_store implementation.
biometry::TemplateStore& template_store() override;
/// @brief identifier returns a device-specific Identifier implementation.
biometry::Identifier& identifier() override;
/// @brief verifier returns a device-specific Verifier implementation.
biometry::Verifier& verifier() override;
private:
/// @cond
std::shared_ptr<Device> device_;
FingerprintReader::TemplateStore template_store_;
/// @endcond
};
/// @brief operator== returns true if lhs and rhs compare equal.
BIOMETRY_DLL_PUBLIC bool operator==(
const FingerprintReader::GuidedEnrollment::Hints& lhs,
const FingerprintReader::GuidedEnrollment::Hints& rhs);
}
}
#endif // BIOMETRYD_DEVICES_FINGERPRINT_READER_H_
|
