ANSI-INCITS-434-2007.pdf

american national standard developed by for information technology tenprint capture using bioapi ansi incits 434-2007 ansi incits 434-2007 copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- ansi incits 434-2007 american national standard for information technology tenprint capture using bioapi secretariat information technology industry council approved december 10, 2007 american national standards institute, inc. copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- approval of an american national standard requires review by ansi that the requirements for due process, consensus, and other criteria for approval have been met by the standards developer. consensus is established when, in the judgement of the ansi board of standards review, substantial agreement has been reached by directly and materially affected interests. substantial agreement means much more than a simple majority, but not necessarily unanimity. consensus requires that all views and objections be considered, and that a concerted effort be made towards their resolution. the use of american national standards is completely voluntary; their existence does not in any respect preclude anyone, whether he has approved the standards or not, from manufacturing, marketing, purchasing, or using products, processes, or procedures not conforming to the standards. the american national standards institute does not develop standards and will in no circumstances give an interpretation of any american national standard. moreover, no person shall have the right or authority to issue an interpretation of an american national standard in the name of the american national standards institute. requests for interpretations should be addressed to the secretariat or sponsor whose name appears on the title page of this standard. caution notice: this american national standard may be revised or withdrawn at any time. the procedures of the american national standards institute require that action be taken periodically to reaffirm, revise, or withdraw this standard. purchasers of american national standards may receive current information on all standards by calling or writing the american national standards institute. american national standard published by american national standards institute, inc. 25 west 43rd street, new york, ny 10036 copyright 2007 by information technology industry council (iti) all rights reserved. no part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without prior written permission of iti, 1250 eye street nw, washington, dc 20005. printed in the united states of america caution: the developers of this standard have requested that holders of patents that may be required for the implementation of the standard disclose such patents to the publisher. however, neither the developers nor the publisher have undertaken a patent search in order to identify which, if any, patents may apply to this standard. as of the date of publication of this standard and following calls for the identification of patents that may be required for the implementation of the standard, no such claims have been made. no further patent search is conducted by the de- veloper or publisher in respect to any standard it processes. no representation is made or implied that licenses are not required to avoid infringement in the use of this standard. copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- table of contents foreword . iii introduction . v 1. scope1 2. conformance .1 3. normative references.1 4. terms and definitions.2 4.1 capture control block (ccb).2 4.2 capture output block (cob).2 4.3 rolled prints2 4.4 slap prints.2 4.5 tenprint capture2 5. requirements.2 6. bioapi function calls.3 6.1 bioapi_controlunit() 3 6.1.1 usage3 6.1.2 prototype.3 6.1.3 parameters3 6.1.4 additional error return codes.4 6.2 bioapi_capture()4 6.2.1 usage4 6.2.2 prototype.4 6.2.3 parameters4 6.2.4 additional error return codes.5 6.3 bioapi_queryunits() 5 6.3.1 usage5 6.3.2 prototype.5 6.3.3 parameters5 6.3.4 bioapi_unit_schema6 7. capture control blocks (ccb).7 8. record types and fields .8 8.1 control and required fields8 8.2 image height and width9 8.3 image data9 8.4 amputated or bandaged fingers10 8.4.1 type 4 records.10 8.4.2 type 14 records.10 8.5 capture resolution.10 8.6 image compression.10 8.7 selecting images to be captured11 8.8 calculation of finger segment position.11 8.9 image quality.11 i copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- 8.9.1 setting quality thresholds 11 8.10 bits per pixel.11 8.11 date printed11 8.12 image capture equipment.12 9. returned bir.12 9.1 bir header.12 9.2 bdb format.12 10. error codes .13 10.1 unable to parse13 10.2 roll capture not supported13 10.3 slap capture not supported13 10.4 slap segmentation not supported.13 10.5 fingerprint extraction not supported.13 10.6 quality algorithm not supported.13 10.7 compression algorithm not supported13 10.8 segmentation algorithm not supported.13 10.9 image resolution not supported.13 10.10 type 4 records not supported14 10.11 type 14 records not supported14 10.12 finger position not supported.14 annex a: example capture control blocks (ccb) for acquisition of images (informative)15 a.1 three slaps (fanc tot)15 a.1.1 type-1 record.15 a.1.2 type-2 record (idc 0)15 a.1.3 type-14 record (idc 1)15 a.1.4 type-14 record (idc 2)15 a.1.5 type-14 record (idc 3)16 a.2 ten plain impressions (no tot).16 a.2.1 type-1 record.16 a.2.2 type-2 record (idc 0)17 a.2.3 type-4 record (idc 1)17 a.2.4 type-4 record (idc 2)17 a.2.5 type-4 record (idc 3)18 a.2.6 type-4 record (idc 4)18 a.2.7 type-4 record (idc 5)18 a.2.8 type-4 record (idc 6)19 a.2.9 type-4 record (idc 7)19 a.2.10 type-4 record (idc 8)19 a.2.11 type-4 record (idc 9)20 a.2.12 type-4 record (idc 10)20 annex b: bioapi calling sequence example (informative).21 ii copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- foreword(this foreword is not part of american national standard ansi incits 434-2007.) incits (the international committee for information technology standards) is the ansi recognized standards development organization for information technology within the united states of america. members of incits are drawn from govern- ment, corporations, academia and other organizations with a material interest in the work of incits and its technical committees. incits does not restrict membership and attracts participants in its technical work from 13 different countries, and oper- ates under the rules of the american national standards institute. in the field of biometrics, incits has established the technical committee m1. standards developed by this technical committee have reached consensus throughout the development process and have been thoroughly reviewed through several public review processes. this document was submitted to incits m1-biometrics by m1.2. this standard contains two informative annexes, both of which are not considered part of the standard. requests for interpretation, suggestions for improvement or addenda, or defect re- ports are welcome. they should be sent to international committee for information technology standards (incits), iti, 1250 eye street, nw, suite 200, washington, dc 20005. this standard was processed and approved for submittal to ansi by incits. com- mittee approval of this standard does not necessarily imply that all committee mem- bers voted for its approval. at the time it approved this standard, incits had the following members: karen higginbottom, chair jennifer garner, secretary organization represented name of representative adobe systems, inc. leslie bixel steve ziles (alt.) aim global, inc. dan mullen charles biss (alt.) apple computer, inc. david michael electronic industries alliance . edward mikoski, jr. david thompson (alt.) emc corporation gary robinson farance, inc. frank farance timothy schoechle (alt.) gs1 us frank sharkey james chronowski (alt.) mary wilson (alt.) hewlett-packard company. karen higginbottom steve mills (alt.) scott jameson (alt.) ibm corporation . ronald f. silletti robert weir (alt.) sandy block (alt.) richard schwerdtfeger (alt.) ieee . judith gorman terry decourcelle (alt.) bill ash (alt.) jodi haasz (alt.) bob labelle (alt.) iii copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- organization representedname of representative intel .philip wennblom dave thewlis (alt.) jesse walker (alt.) grace wei (alt.) lexmark internationaldon wright dwight lewis (alt.) paul menard (alt.) microsoft corporationjim hughes don stanwyck (alt.) isabelle valet-harper (alt.) national institute of standards however, there are a number of areas where options exist or in which implementation details are left to the vendor or application. this standard is needed to further constrain the use of the bioapi standard in the tenprint capture context and to provide additional guidance that will improve both usability and interoperability. vii copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- american national standard ansi incits 434-2007 american national standard for information technology tenprint capture using bioapi 1. scope this standard specifies requirements for the use of iso/iec 19784-1, bioapi specification (also known as bioapi 2.0), a software interface standard, for the purpose of performing a tenprint capture operation. this includes one or more of the following: 1. identification of bioapi functions to be utilized and the order (if any) in which they are to be called 2. specification of values for function parameters 3. definition of gui (graphical user interface) events (for use with an application controlled gui) 4. user interface specifications for use with a bsp (biometric service provider) controlled gui 5. sample calling sequences and example inputs/outputs 2. conformance biometric service providers (bsps) that claim conformance to this standard shall satisfy the normative requirements as described in clauses 5 through 9. 3. normative references the following standards contain provisions which, through reference in this text, constitute provisions of this american national standard. all standards are subject to revision, and parties to agreements based on this american national standard are encouraged to investigate the possibility of applying the most recent editions of the standards indicated below. 1. ansi/nist-itl 1-2007, data format for the interchange of fingerprint, facial, 6.1.3 parameters 6.1.3.1 bsphandle (input) the handle of the attached bsp. 6.1.3.2 unitid (input) id of the bioapi unit. 6.1.3.3 controlcode (input) indicates the purpose of this function to differentiate it from other bioapi_controlunit() calls. the value of “1” shall be used to indicate that a ccb is being set. 6.1.3.4 inputdata (input) pointer to a bioapi_data structure. this structure shall contain the address and length of the ccb. 3 copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- ansi incits 434-2007 6.1.3.5 outputdata (output) no output is needed. the buffer address will be null and length set to “0” within the bioapi_data structure. usage of the outputdata parameter to return diagnostic data about the ccb should be considered. 6.1.4 additional error return codes error codes should be used to indicate errors detected in the ccb passed in the inputdata parameter. see clause 10. 6.2 bioapi_capture() 6.2.1 usage this function shall trigger a bsp to perform fingerprint image captures and to create a new ccb. the fingers captured and the processing done on the fingers shall be controlled by inclusion of empty fields in the current ccb, which was specified in the bioapi_controlunit() call. 6.2.2 prototype bioapi_return bioapi bioapi_capture (bioapi_handle bsphandle, bioapi_bir_purpose purpose, bioapi_bir_subtype subtype, bioapi_bir_biometric_data_format *outputformat, bioapi_bir_handle *capturedbir, int32_t timeout, bioapi_bir_handle *auditdata); 6.2.3 parameters 6.2.3.1 bsphandle (input) the handle of the attached bsp. 6.2.3.2 purpose (input) a value indicating the purpose of the biometric data capture. for the purposes of tenprint capture, the value bioapi_purpose_enroll shall be used. 6.2.3.3 subtype (input/optional) specifies which subtype to capture. this parameter does not have the flexibility to describe the range of possible finger image sets that might be captured. a value of bioapi_no_subtype_available (0x00) shall be used to indicate that the bsp is to select the subtypes using the current ccb. 6.2.3.4 outputformat (input/optional) specifies which bdb (biometric data block) format to use for the returned capturedbir. format owner and format type shall be set to 0x001b and 0x8013 respectively to designate that the 4 copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- ansi incits 434-2007 bir (biometric information record) shall consist of a cob. alternatively a null pointer shall be used to indicate that output format selection will be handled by the bsp. 6.2.3.5 capturedbir (output) a handle to a bir containing captured data, the cob. see clause 9 for a specification of this bir. 6.2.3.6 timeout (input) specifies the timeout value (in milliseconds) for the capture operation. if this timeout is reached, the function returns an error, and no results. this value can be any positive number. a -1 value means the bsps default timeout value will be used. 6.2.3.7auditdata (output/optional) a handle value of bioapi_unsupported_bir_handle shall be used to indicate that auditdata is not available. 6.2.4 additional error return codes bioapi includes codes such as bioapierr_unable_to_capture to indicate that the bsp could not collect the data that it is meant to. additional error codes specific to tenprint capture are specified in clause 10. 6.3 bioapi_queryunits() 6.3.1 usage applications will use this function to determine if the device attached to the bsp conforms to this standard and if so, to discover what specific capabilities are supported by the attached tenprint capture device (unit). 6.3.2 prototype bioapi_return bioapi bioapi_queryunits (const bioapi_uuid *bspuuid, bioapi_unit_schema *unitschemaarray, uint32_t *numberofelements); 6.3.3 parameters 6.3.3.1 bspuuid (input) the unique identifier for the (tenprint) bsp to which the unit (tenprint scanning device) is attached and for which the unit information is to be returned. 6.3.3.2 unitschemaarray (output) a pointer to the address of the array of elements of type bioapi_unit_schema containing the unit schema information. specific elements of interest are defined in 6.3.4, below. 5 copyright american national standards institute provided by ihs under license with ansi licensee=ihs employees/1111111001, user=japan, ihs not for resale, 02/16/2008 04:13:54 mstno reproduction or networking permitted without license from ihs -,-,- ansi incits 434-2007 6.3.3.3 numberofelements (output) a pointer to the number of elements in the array. 6.3.4 bioapi_unit_schema this schema is defined in clause 7.55 of the base standard (bioapi specification). there are three elements of this structure that are of particular interest for the purpose of tenprint c