depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
libfprint/libfprint/fprint.h

144 lines
4.8 KiB
C
Raw Normal View History

Initial driver registration mechanism Also added the basis of the upekts driver, which is the first I'll implement.
2007-10-08 15:46:42 +00:00
/*
* 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__
Print discovery 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.
2007-10-31 13:12:04 +00:00
#include <stdint.h>
Basic device discovery infrastructure
2007-10-08 15:55:50 +00:00
/* structs that applications are not allowed to peek into */
struct fp_dscv_dev;
Print discovery 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.
2007-10-31 13:12:04 +00:00
struct fp_dscv_print;
open/close device functions
2007-10-08 16:01:08 +00:00
struct fp_dev;
Expose driver info to library users
2007-10-08 16:05:58 +00:00
struct fp_driver;
Initial fingerprint data representation ideas
2007-10-08 17:24:29 +00:00
struct fp_print_data;
Initial implementation for image device access and capture Also added new example: img_capture
2007-10-26 23:06:53 +00:00
struct fp_img;
Basic device discovery infrastructure
2007-10-08 15:55:50 +00:00
storage: add save/load functionality Prints can now be saved to disk (but you currently must classify which finger they are) and you can load them later. Added 2 simple example programs to demonstrate this.
2007-10-16 13:23:30 +00:00
/* 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,
};
Print discovery 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.
2007-10-31 13:12:04 +00:00
/* 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);
Basic device discovery infrastructure
2007-10-08 15:55:50 +00:00
/* Device discovery */
struct fp_dscv_dev **fp_discover_devs(void);
void fp_dscv_devs_free(struct fp_dscv_dev **devs);
Basic image driver foundations The basic model is that image drivers declare a fp_img_driver structure rather than a fp_driver struct. fp_img_driver will contain primitive imaging operations such as 'scan finger and return image'. The imgdev layer will generically implement the primitive fp_driver operations, and the imgdev layer will fix up the enroll/verify/etc pointers at driver registration time. Removed const from all fp_driver declarations, as these are now modified dynamically in the case of imaging drivers.
2007-10-23 22:24:21 +00:00
struct fp_driver *fp_dscv_dev_get_driver(struct fp_dscv_dev *dev);
Flesh out driver_id/devtype API Add accessor functions to the various structures
2007-10-30 22:24:31 +00:00
uint32_t fp_dscv_dev_get_devtype(struct fp_dscv_dev *dev);
Print discovery 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.
2007-10-31 13:12:04 +00:00
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);
Flesh out driver_id/devtype API Add accessor functions to the various structures
2007-10-30 22:24:31 +00:00
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));
}
Basic device discovery infrastructure
2007-10-08 15:55:50 +00:00
Print discovery 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.
2007-10-31 13:12:04 +00:00
/* 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);
open/close device functions
2007-10-08 16:01:08 +00:00
/* Device handling */
struct fp_dev *fp_dev_open(struct fp_dscv_dev *ddev);
void fp_dev_close(struct fp_dev *dev);
Basic image driver foundations The basic model is that image drivers declare a fp_img_driver structure rather than a fp_driver struct. fp_img_driver will contain primitive imaging operations such as 'scan finger and return image'. The imgdev layer will generically implement the primitive fp_driver operations, and the imgdev layer will fix up the enroll/verify/etc pointers at driver registration time. Removed const from all fp_driver declarations, as these are now modified dynamically in the case of imaging drivers.
2007-10-23 22:24:21 +00:00
struct fp_driver *fp_dev_get_driver(struct fp_dev *dev);
Enrolment infrastructure
2007-10-08 18:53:50 +00:00
int fp_dev_get_nr_enroll_stages(struct fp_dev *dev);
Flesh out driver_id/devtype API Add accessor functions to the various structures
2007-10-30 22:24:31 +00:00
uint32_t fp_dev_get_devtype(struct fp_dev *dev);
Print discovery 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.
2007-10-31 13:12:04 +00:00
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);
open/close device functions
2007-10-08 16:01:08 +00:00
remove imgdev abstraction from public API Make it easier for application developers, don't have to care about this level of abstraction which we're intending to make superfluous to them.
2007-11-02 17:04:19 +00:00
int fp_dev_supports_imaging(struct fp_dev *dev);
int fp_dev_img_capture(struct fp_dev *dev, int unconditional,
struct fp_img **image);
int fp_dev_get_img_width(struct fp_dev *dev);
int fp_dev_get_img_height(struct fp_dev *dev);
Enrollment: improved error reporting Convert enrollment function to return a signed integer, which is negative on error or corresponds into fp_enroll_result otherwise. Now we can treat a 'FAIL' condition differently from an actual error: fail means that enrollment didn't complete because the data was nonsense or whatever (e.g. scanned a different finger for each stage?). Updated upekts accordingly.
2007-10-13 23:45:49 +00:00
/* Enrollment */
enum fp_enroll_result {
Enrollment tweaks upekts will need to know when the first enrollment stage is attempted for the first time, so add an __enroll_stage counter which actually indicates the next stage to enroll. -1 is a special value and it means 0 is next *and* it is the initial attemt. Added more debug output to the enroll handler. Added new fp_enroll_status codes for too short or uncentered scans. Changed the print_data allocator to consider the device rather than the driver, this feels more natural. Added missing return value. Make fp_enroll_status codes start at 1. 0 can now be used as a special/temporary value by the drivers. Also check that we aren't exceeding the number of enroll stages. Also add a missing exit() call to the verify example and update for the above.
2007-10-12 14:27:23 +00:00
FP_ENROLL_COMPLETE = 1,
Enrolment infrastructure
2007-10-08 18:53:50 +00:00
FP_ENROLL_FAIL,
FP_ENROLL_PASS,
Enrollment: improved error reporting Convert enrollment function to return a signed integer, which is negative on error or corresponds into fp_enroll_result otherwise. Now we can treat a 'FAIL' condition differently from an actual error: fail means that enrollment didn't complete because the data was nonsense or whatever (e.g. scanned a different finger for each stage?). Updated upekts accordingly.
2007-10-13 23:45:49 +00:00
FP_ENROLL_RETRY = 100,
Enrollment tweaks upekts will need to know when the first enrollment stage is attempted for the first time, so add an __enroll_stage counter which actually indicates the next stage to enroll. -1 is a special value and it means 0 is next *and* it is the initial attemt. Added more debug output to the enroll handler. Added new fp_enroll_status codes for too short or uncentered scans. Changed the print_data allocator to consider the device rather than the driver, this feels more natural. Added missing return value. Make fp_enroll_status codes start at 1. 0 can now be used as a special/temporary value by the drivers. Also check that we aren't exceeding the number of enroll stages. Also add a missing exit() call to the verify example and update for the above.
2007-10-12 14:27:23 +00:00
FP_ENROLL_RETRY_TOO_SHORT,
FP_ENROLL_RETRY_CENTER_FINGER,
Enrollment: improved error reporting Convert enrollment function to return a signed integer, which is negative on error or corresponds into fp_enroll_result otherwise. Now we can treat a 'FAIL' condition differently from an actual error: fail means that enrollment didn't complete because the data was nonsense or whatever (e.g. scanned a different finger for each stage?). Updated upekts accordingly.
2007-10-13 23:45:49 +00:00
FP_ENROLL_RETRY_REMOVE_FINGER,
Enrolment infrastructure
2007-10-08 18:53:50 +00:00
};
Enrollment: improved error reporting Convert enrollment function to return a signed integer, which is negative on error or corresponds into fp_enroll_result otherwise. Now we can treat a 'FAIL' condition differently from an actual error: fail means that enrollment didn't complete because the data was nonsense or whatever (e.g. scanned a different finger for each stage?). Updated upekts accordingly.
2007-10-13 23:45:49 +00:00
int fp_enroll_finger(struct fp_dev *dev, struct fp_print_data **print_data);
Enrolment infrastructure
2007-10-08 18:53:50 +00:00
Verification infrastructure Similar model to enrollment.
2007-10-13 23:58:45 +00:00
/* 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);
Initial fingerprint data representation ideas
2007-10-08 17:24:29 +00:00
/* Data handling */
storage: add save/load functionality Prints can now be saved to disk (but you currently must classify which finger they are) and you can load them later. Added 2 simple example programs to demonstrate this.
2007-10-16 13:23:30 +00:00
int fp_print_data_load(struct fp_dev *dev, enum fp_finger finger,
Print discovery 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.
2007-10-31 13:12:04 +00:00
struct fp_print_data **data);
int fp_print_data_from_dscv_print(struct fp_dscv_print *print,
storage: add save/load functionality Prints can now be saved to disk (but you currently must classify which finger they are) and you can load them later. Added 2 simple example programs to demonstrate this.
2007-10-16 13:23:30 +00:00
struct fp_print_data **data);
int fp_print_data_save(struct fp_print_data *data, enum fp_finger finger);
Initial fingerprint data representation ideas
2007-10-08 17:24:29 +00:00
void fp_print_data_free(struct fp_print_data *data);
Improve print_data structure and on-disk format 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.
2007-10-28 22:02:04 +00:00
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);
Flesh out driver_id/devtype API Add accessor functions to the various structures
2007-10-30 22:24:31 +00:00
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);
Initial fingerprint data representation ideas
2007-10-08 17:24:29 +00:00
Initial implementation for image device access and capture Also added new example: img_capture
2007-10-26 23:06:53 +00:00
/* 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);
Image standardization Initially supports flipping and colour inversion
2007-10-27 11:07:11 +00:00
void fp_img_standardize(struct fp_img *img);
Add API for freeing images
2007-10-27 14:16:54 +00:00
void fp_img_free(struct fp_img *img);
Initial implementation for image device access and capture Also added new example: img_capture
2007-10-26 23:06:53 +00:00
Initial fingerprint data representation ideas
2007-10-08 17:24:29 +00:00
/* Library */
Initial driver registration mechanism Also added the basis of the upekts driver, which is the first I'll implement.
2007-10-08 15:46:42 +00:00
int fp_init(void);
#endif
Reference in a new issue Copy permalink