447b1f01b3
Add concept of "discovered prints" and flesh out the API. A discovered print was found based on file name but has not been checked for file integrity, and of course there is no guarantee that it is usable when you try to use it later (might have been deleted, etc). The .fprint directory structure was changed - instead of using mnemonics like "rind" we use their numeric value in the fp_finger enum as the filename.
145 lines
4.8 KiB
C
145 lines
4.8 KiB
C
/*
|
|
* Main definitions for libfprint
|
|
* Copyright (C) 2007 Daniel Drake <dsd@gentoo.org>
|
|
*
|
|
* This library 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; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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 library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef __FPRINT_H__
|
|
#define __FPRINT_H__
|
|
|
|
#include <stdint.h>
|
|
|
|
/* structs that applications are not allowed to peek into */
|
|
struct fp_dscv_dev;
|
|
struct fp_dscv_print;
|
|
struct fp_dev;
|
|
struct fp_driver;
|
|
struct fp_print_data;
|
|
struct fp_img;
|
|
|
|
/* misc/general stuff */
|
|
enum fp_finger {
|
|
LEFT_THUMB = 1,
|
|
LEFT_INDEX,
|
|
LEFT_MIDDLE,
|
|
LEFT_RING,
|
|
LEFT_LITTLE,
|
|
RIGHT_THUMB,
|
|
RIGHT_INDEX,
|
|
RIGHT_MIDDLE,
|
|
RIGHT_RING,
|
|
RIGHT_LITTLE,
|
|
};
|
|
|
|
/* Drivers */
|
|
const char *fp_driver_get_name(struct fp_driver *drv);
|
|
const char *fp_driver_get_full_name(struct fp_driver *drv);
|
|
uint16_t fp_driver_get_driver_id(struct fp_driver *drv);
|
|
|
|
/* Device discovery */
|
|
struct fp_dscv_dev **fp_discover_devs(void);
|
|
void fp_dscv_devs_free(struct fp_dscv_dev **devs);
|
|
struct fp_driver *fp_dscv_dev_get_driver(struct fp_dscv_dev *dev);
|
|
uint32_t fp_dscv_dev_get_devtype(struct fp_dscv_dev *dev);
|
|
int fp_dscv_dev_supports_print_data(struct fp_dscv_dev *dev,
|
|
struct fp_print_data *print);
|
|
int fp_dscv_dev_supports_dscv_print(struct fp_dscv_dev *dev,
|
|
struct fp_dscv_print *print);
|
|
struct fp_dscv_dev *fp_dscv_dev_for_print_data(struct fp_dscv_dev **devs,
|
|
struct fp_print_data *print);
|
|
struct fp_dscv_dev *fp_dscv_dev_for_dscv_print(struct fp_dscv_dev **devs,
|
|
struct fp_dscv_print *print);
|
|
|
|
static inline uint16_t fp_dscv_dev_get_driver_id(struct fp_dscv_dev *dev)
|
|
{
|
|
return fp_driver_get_driver_id(fp_dscv_dev_get_driver(dev));
|
|
}
|
|
|
|
/* Print discovery */
|
|
struct fp_dscv_print **fp_discover_prints(void);
|
|
void fp_dscv_prints_free(struct fp_dscv_print **prints);
|
|
uint16_t fp_dscv_print_get_driver_id(struct fp_dscv_print *print);
|
|
uint32_t fp_dscv_print_get_devtype(struct fp_dscv_print *print);
|
|
enum fp_finger fp_dscv_print_get_finger(struct fp_dscv_print *print);
|
|
|
|
/* Device handling */
|
|
struct fp_dev *fp_dev_open(struct fp_dscv_dev *ddev);
|
|
void fp_dev_close(struct fp_dev *dev);
|
|
struct fp_driver *fp_dev_get_driver(struct fp_dev *dev);
|
|
int fp_dev_get_nr_enroll_stages(struct fp_dev *dev);
|
|
struct fp_img_dev *fp_dev_to_img_dev(struct fp_dev *dev);
|
|
uint32_t fp_dev_get_devtype(struct fp_dev *dev);
|
|
int fp_dev_supports_print_data(struct fp_dev *dev, struct fp_print_data *data);
|
|
int fp_dev_supports_dscv_print(struct fp_dev *dev, struct fp_dscv_print *print);
|
|
|
|
/* Enrollment */
|
|
enum fp_enroll_result {
|
|
FP_ENROLL_COMPLETE = 1,
|
|
FP_ENROLL_FAIL,
|
|
FP_ENROLL_PASS,
|
|
FP_ENROLL_RETRY = 100,
|
|
FP_ENROLL_RETRY_TOO_SHORT,
|
|
FP_ENROLL_RETRY_CENTER_FINGER,
|
|
FP_ENROLL_RETRY_REMOVE_FINGER,
|
|
};
|
|
|
|
int fp_enroll_finger(struct fp_dev *dev, struct fp_print_data **print_data);
|
|
|
|
/* Verification */
|
|
enum fp_verify_result {
|
|
FP_VERIFY_NO_MATCH = 0,
|
|
FP_VERIFY_MATCH = 1,
|
|
FP_VERIFY_RETRY = FP_ENROLL_RETRY,
|
|
FP_VERIFY_RETRY_TOO_SHORT = FP_ENROLL_RETRY_TOO_SHORT,
|
|
FP_VERIFY_RETRY_CENTER_FINGER = FP_ENROLL_RETRY_CENTER_FINGER,
|
|
FP_VERIFY_RETRY_REMOVE_FINGER = FP_ENROLL_RETRY_REMOVE_FINGER,
|
|
};
|
|
|
|
int fp_verify_finger(struct fp_dev *dev, struct fp_print_data *enrolled_print);
|
|
|
|
/* Data handling */
|
|
int fp_print_data_load(struct fp_dev *dev, enum fp_finger finger,
|
|
struct fp_print_data **data);
|
|
int fp_print_data_from_dscv_print(struct fp_dscv_print *print,
|
|
struct fp_print_data **data);
|
|
int fp_print_data_save(struct fp_print_data *data, enum fp_finger finger);
|
|
void fp_print_data_free(struct fp_print_data *data);
|
|
size_t fp_print_data_get_data(struct fp_print_data *data, unsigned char **ret);
|
|
struct fp_print_data *fp_print_data_from_data(unsigned char *buf,
|
|
size_t buflen);
|
|
uint16_t fp_print_data_get_driver_id(struct fp_print_data *data);
|
|
uint32_t fp_print_data_get_devtype(struct fp_print_data *data);
|
|
|
|
/* Imaging devices */
|
|
int fp_imgdev_capture(struct fp_img_dev *imgdev, int unconditional,
|
|
struct fp_img **image);
|
|
int fp_imgdev_get_img_width(struct fp_img_dev *imgdev);
|
|
int fp_imgdev_get_img_height(struct fp_img_dev *imgdev);
|
|
|
|
/* Image handling */
|
|
int fp_img_get_height(struct fp_img *img);
|
|
int fp_img_get_width(struct fp_img *img);
|
|
unsigned char *fp_img_get_data(struct fp_img *img);
|
|
int fp_img_save_to_file(struct fp_img *img, char *path);
|
|
void fp_img_standardize(struct fp_img *img);
|
|
void fp_img_free(struct fp_img *img);
|
|
|
|
/* Library */
|
|
int fp_init(void);
|
|
|
|
#endif
|
|
|