294f9ad447
Drivers now have an ID number. These will be assigned by me and documented on the wiki. 0 cannot be used. Drivers now define a devtype for each device they initialise. This is to cope with the situation where a driver can support varying devices where their print data is incompatible (i.e. image scaling is totally changed). This doesn't apply to any existing supported devices. Print data no longer includes driver name, and includes driver ID instead. Paths to saved print data now include driver ID and devtype, and no longer include driver name. APIs exposed for converting a print_data into a blob which can then be loaded back again later. Useful for systems who don't want to use my simple storage system (which is only aimed at a single user). File format is now defined and will be documented on the wiki. The header is larger as we can no longer rely on directory paths in all scenarios. Print data compat check now checks devtype and driver ID.
113 lines
3.4 KiB
C
113 lines
3.4 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__
|
|
|
|
/* structs that applications are not allowed to peek into */
|
|
struct fp_dscv_dev;
|
|
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,
|
|
};
|
|
|
|
/* 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);
|
|
|
|
/* 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);
|
|
|
|
/* Drivers */
|
|
const char *fp_driver_get_name(struct fp_driver *drv);
|
|
const char *fp_driver_get_full_name(struct fp_driver *drv);
|
|
|
|
/* 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_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);
|
|
|
|
/* 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
|
|
|