capi.h

Go to the documentation of this file.

#ifndef __LIBINSANE_CAPI_H
#define __LIBINSANE_CAPI_H
 
#include <stdlib.h>
 
#include "error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct lis_device_descriptor {
    char *dev_id;
 
    char *vendor; 
    char *model; 
    char *type; 
};
 
 
enum lis_value_type {
    LIS_TYPE_BOOL = 0, 
    LIS_TYPE_INTEGER, 
    LIS_TYPE_DOUBLE, 
    LIS_TYPE_STRING, 
    LIS_TYPE_IMAGE_FORMAT 
};
 
 
enum lis_img_format {
    LIS_IMG_FORMAT_RAW_RGB_24 = 0,
 
    LIS_IMG_FORMAT_GRAYSCALE_8,
    LIS_IMG_FORMAT_BW_1,
    LIS_IMG_FORMAT_BMP,
    LIS_IMG_FORMAT_CIFF,
    LIS_IMG_FORMAT_EXIF,
    LIS_IMG_FORMAT_FLASHPIX,
    LIS_IMG_FORMAT_GIF,
    LIS_IMG_FORMAT_JPEG,
    LIS_IMG_FORMAT_PNG,
    LIS_IMG_FORMAT_ICO,
    LIS_IMG_FORMAT_JPEG2K,
    LIS_IMG_FORMAT_JPEG2KX,
    LIS_IMG_FORMAT_MEMORYBMP, // Windows BMP without header
    LIS_IMG_FORMAT_PHOTOCD,
    LIS_IMG_FORMAT_PICT,
    LIS_IMG_FORMAT_TIFF,
};
 
 
enum lis_unit {
    LIS_UNIT_NONE = 0,
    LIS_UNIT_PIXEL,
    LIS_UNIT_BIT,
    LIS_UNIT_MM,
    LIS_UNIT_DPI,
    LIS_UNIT_PERCENT,
    LIS_UNIT_MICROSECOND,
};
 
 
union lis_value {
    int boolean;
    int integer;
    double dbl;
    const char *string;
    enum lis_img_format format;
};
 
 
 
struct lis_value_range {
    union lis_value min;
    union lis_value max;
    union lis_value interval;
};
 
 
struct lis_value_list {
    int nb_values;
    union lis_value *values;
};
 
 
struct lis_option_descriptor {
    const char *name; 
    const char *title; 
    const char *desc; 
#define LIS_CAP_EMULATED (1<<0) 
#define LIS_CAP_AUTOMATIC (1<<1) 
#define LIS_CAP_HW_SELECT (1<<2) 
#define LIS_CAP_SW_SELECT (1<<3) 
    /* TODO(Jflesch): Sane provides SANE_CAP_SOFT_DETECT ? oO */
#define LIS_CAP_INACTIVE (1<<4)
 
#define LIS_OPT_IS_READABLE(opt_desc) (!((opt_desc)->capabilities & LIS_CAP_INACTIVE))
#define LIS_OPT_IS_WRITABLE(opt_desc) ((opt_desc)->capabilities & LIS_CAP_SW_SELECT)
 
    int capabilities;
 
    struct {
        enum lis_value_type type; 
        enum lis_unit unit; 
    } value;
 
    struct {
        enum {
            LIS_CONSTRAINT_NONE, 
            LIS_CONSTRAINT_RANGE, 
            LIS_CONSTRAINT_LIST, 
        } type; 
        union {
            struct lis_value_range range;
 
            struct lis_value_list list;
        } possible;
    } constraint;
 
    struct {
        enum lis_error (*get_value)(struct lis_option_descriptor *self,
                union lis_value *value);
 
#define LIS_SET_FLAG_INEXACT (1<<0) 
#define LIS_SET_FLAG_MUST_RELOAD_OPTIONS (1<<1) 
#define LIS_SET_FLAG_MUST_RELOAD_PARAMS (1<<2) 
        enum lis_error (*set_value)(struct lis_option_descriptor *self,
                union lis_value value, int *set_flags);
    } fn; 
};
 
struct lis_scan_parameters {
    enum lis_img_format format;
 
    int width;
 
    int height;
 
    size_t image_size;
};
 
 
struct lis_scan_session {
    enum lis_error (*get_scan_parameters)(
        struct lis_scan_session *self,
        struct lis_scan_parameters *parameters
    );
 
    int (*end_of_feed)(struct lis_scan_session *session);
 
    int (*end_of_page)(struct lis_scan_session *session);
 
    enum lis_error (*scan_read)(
        struct lis_scan_session *session, void *out_buffer,
        size_t *buffer_size
    );
 
    void (*cancel)(struct lis_scan_session *session);
};
 
 
enum lis_item_type {
    LIS_ITEM_DEVICE, 
    LIS_ITEM_FLATBED, 
    LIS_ITEM_ADF, 
    LIS_ITEM_UNIDENTIFIED = -1, 
};
 
 
struct lis_item {
    const char *name; 
    enum lis_item_type type;
 
    enum lis_error (*get_children)(struct lis_item *self, struct lis_item ***children);
 
    enum lis_error (*get_options)(
        struct lis_item *self, struct lis_option_descriptor ***descs
    );
 
    enum lis_error (*scan_start)(struct lis_item *self, struct lis_scan_session **session);
 
    void (*close)(struct lis_item *self);
};
 
 
enum lis_device_locations {
    LIS_DEVICE_LOCATIONS_ANY = 0, 
    LIS_DEVICE_LOCATIONS_LOCAL_ONLY,
};
 
 
struct lis_api {
    const char *base_name; 
    void (*cleanup)(struct lis_api *impl);
 
    enum lis_error (*list_devices)(
        struct lis_api *impl, enum lis_device_locations locs,
        struct lis_device_descriptor ***dev_infos
    );
 
    enum lis_error (*get_device)(
        struct lis_api *impl, const char *dev_id, struct lis_item **item
    );
};
 
#ifdef __cplusplus
}
#endif
 
#endif