Logo Search packages:      
Sourcecode: sane-backends version File versions

u12.c

Go to the documentation of this file.
/** @file u12.c
 *  @brief SANE backend for USB scanner, based on Plusteks' ASIC P98003 and
 *         the GeneSys Logic GL640 parallel-port to USB bridge.
 *
 * Based on source aquired from Plustek<br>
 * Copyright (c) 2003-2004 Gerhard Jaeger <gerhard@gjaeger.de><br>
 *
 * History:
 * - 0.01 - initial version
 * - 0.02 - enabled other scan-modes
 *        - increased default gamma to 1.5
 *.
 * <hr>
 * This file is part of the SANE package.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 *
 * As a special exception, the authors of SANE give permission for
 * additional uses of the libraries contained in this release of SANE.
 *
 * The exception is that, if you link a SANE library with other files
 * to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License.  Your use of that executable is in no way restricted on
 * account of linking the SANE library code into it.
 *
 * This exception does not, however, invalidate any other reasons why
 * the executable file might be covered by the GNU General Public
 * License.
 *
 * If you submit changes to SANE to the maintainers to be included in
 * a subsequent release, you agree by submitting the changes that
 * those changes may be distributed with this exception intact.
 *
 * If you write modifications of your own for SANE, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.
 * <hr>
 */

#ifdef _AIX
# include "../include/lalloca.h"          /* MUST come first for AIX! */
#endif

#include "../include/sane/config.h"
#include "../include/lalloca.h"

#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <unistd.h>
#include <time.h>
#include <math.h>

#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif

#include <sys/types.h>
#include <sys/ioctl.h>

#include "../include/sane/sane.h"
#include "../include/sane/sanei.h"
#include "../include/sane/saneopts.h"

#define BACKEND_VERSION "0.02-9"
#define BACKEND_NAME    u12
#include "../include/sane/sanei_backend.h"
#include "../include/sane/sanei_config.h"
#include "../include/sane/sanei_thread.h"
#include "../include/sane/sanei_usb.h"

#define ALL_MODES

#include "u12-scanner.h"
#include "u12-hwdef.h"
#include "u12.h"

/*********************** the debug levels ************************************/

#define _DBG_FATAL       0
#define _DBG_ERROR       1
#define _DBG_WARNING     3
#define _DBG_INFO        5
#define _DBG_PROC        7
#define _DBG_SANE_INIT  10
#define _DBG_IO        128
#define _DBG_READ      255

/* uncomment this for testing... */
/*#define _FAKE_DEVICE
 */
/*****************************************************************************/

#define _SECTION        "[usb]"
#define _DEFAULT_DEVICE "auto"

/* including the "worker" code... */
#include "u12-io.c"
#include "u12-ccd.c"
#include "u12-hw.c"
#include "u12-motor.c"
#include "u12-image.c"
#include "u12-map.c"
#include "u12-shading.c"
#include "u12-tpa.c"
#include "u12-if.c"

/************************** global vars **************************************/

static int                 num_devices;
static U12_Device         *first_dev;
static U12_Scanner        *first_handle;
static const SANE_Device **devlist = 0;
static unsigned long       tsecs   = 0;
static SANE_Bool           cancelRead;

#ifdef ALL_MODES
static ModeParam mode_params[] =
{
      {0, 1,  COLOR_BW},
      {0, 8,  COLOR_256GRAY},
      {1, 8,  COLOR_TRUE24},
      {1, 16, COLOR_TRUE42}
};

static const SANE_String_Const mode_list[] =
{
      SANE_VALUE_SCAN_MODE_LINEART,
      SANE_VALUE_SCAN_MODE_GRAY,
      SANE_VALUE_SCAN_MODE_COLOR,
      SANE_I18N("Color 36"),
      NULL
};

static const SANE_String_Const src_list[] =
{
      SANE_I18N("Normal"),
      SANE_I18N("Transparency"),
      SANE_I18N("Negative"),
      NULL
};
#endif

static const SANE_Range percentage_range =
{
      -100 << SANE_FIXED_SCALE_SHIFT, /* minimum            */
       100 << SANE_FIXED_SCALE_SHIFT, /* maximum            */
         1 << SANE_FIXED_SCALE_SHIFT  /* quantization */
};

/* authorization stuff */
static SANE_Auth_Callback auth = NULL;

/****************************** the backend... *******************************/

#define _YN(x) (x?"yes":"no")

/**
 * function to display the configuration options for the current device
 * @param cnf - pointer to the configuration structure whose content should be
 *              displayed
 */
00181 static void show_cnf( pCnfDef cnf )
{
      DBG( _DBG_SANE_INIT,"Device configuration:\n" );
      DBG( _DBG_SANE_INIT,"device name  : >%s<\n",cnf->devName               );
      DBG( _DBG_SANE_INIT,"USB-ID       : >%s<\n",cnf->usbId                 );
      DBG( _DBG_SANE_INIT,"warmup       : %ds\n", cnf->adj.warmup            );
      DBG( _DBG_SANE_INIT,"lampOff      : %d\n",  cnf->adj.lampOff           );
      DBG( _DBG_SANE_INIT,"lampOffOnEnd : %s\n",  _YN(cnf->adj.lampOffOnEnd ));
      DBG( _DBG_SANE_INIT,"red Gamma    : %.2f\n",cnf->adj.rgamma            );
      DBG( _DBG_SANE_INIT,"green Gamma  : %.2f\n",cnf->adj.ggamma            );
      DBG( _DBG_SANE_INIT,"blue Gamma   : %.2f\n",cnf->adj.bgamma            );
      DBG( _DBG_SANE_INIT,"gray Gamma   : %.2f\n",cnf->adj.graygamma         );
      DBG( _DBG_SANE_INIT,"---------------------\n" );
}

/** Calls the device specific stop and close functions.
 * @param  dev - pointer to the device specific structure
 * @return The function always returns SANE_STATUS_GOOD
 */
00200 static SANE_Status drvClose( U12_Device *dev )
{
      if( dev->fd >= 0 ) {

          DBG( _DBG_INFO, "drvClose()\n" );

            if( 0 != tsecs ) {
                  DBG( _DBG_INFO, "TIME END 1: %lus\n", time(NULL)-tsecs);
            }

            /* don't check the return values, simply do it */
            u12if_stopScan( dev );
            u12if_close   ( dev );
      }
      dev->fd = -1;
      return SANE_STATUS_GOOD;
}

/** as the name says, close our pipes
 * @param scanner -
 * @return
 */
00222 static SANE_Status drvClosePipes( U12_Scanner *scanner )
{
      if( scanner->r_pipe >= 0 ) {

            DBG( _DBG_PROC, "drvClosePipes(r_pipe)\n" );
            close( scanner->r_pipe );
            scanner->r_pipe = -1;
      }
      if( scanner->w_pipe >= 0 ) {

            DBG( _DBG_PROC, "drvClosePipes(w_pipe)\n" );
            close( scanner->w_pipe );
            scanner->w_pipe = -1;
      }

      return SANE_STATUS_EOF;
}

#ifdef ALL_MODES
/** according to the mode and source we return the corresponding mode list
 */
00243 static pModeParam getModeList( U12_Scanner *scanner )
{
      pModeParam mp = mode_params;

      /* the transparency/negative mode supports only gray and color
       */
      if( 0 != scanner->val[OPT_EXT_MODE].w ) {
            mp = &mp[_TPAModeSupportMin];
      }

      return mp;
}
#endif

/** goes through a string list and returns the start-address of the string
 * that has been found, or NULL on error
 */
static const SANE_String_Const
00261 *search_string_list( const SANE_String_Const *list, SANE_String value )
{
      while( *list != NULL && strcmp(value, *list) != 0 )
            ++list;

      if( *list == NULL )
            return NULL;

      return list;
}

/**
 */
static void sig_chldhandler( int signo )
{
      DBG( _DBG_PROC, "(SIG) Child is down (signal=%d)\n", signo );
}

/** signal handler to kill the child process
 */
00281 static RETSIGTYPE reader_process_sigterm_handler( int signo )
{
      DBG( _DBG_PROC, "(SIG) reader_process: terminated by signal %d\n", signo );
      _exit( SANE_STATUS_GOOD );
}

static RETSIGTYPE usb_reader_process_sigterm_handler( int signo )
{
      DBG( _DBG_PROC, "(SIG) reader_process: terminated by signal %d\n", signo );
      cancelRead = SANE_TRUE;
}

static RETSIGTYPE sigalarm_handler( int signo )
{
      _VAR_NOT_USED( signo );
      DBG( _DBG_PROC, "ALARM!!!\n" );
}

/** executed as a child process
 * read the data from the driver and send them to the parent process
 */
00302 static int reader_process( void *args )
{
      int              line;
      unsigned char   *buf;
      unsigned long    data_length;
      struct SIGACTION act;
      sigset_t         ignore_set;
      SANE_Status      status;
      
      U12_Scanner *scanner = (U12_Scanner *)args;

      if( sanei_thread_is_forked()) {
            DBG( _DBG_PROC, "reader_process started (forked)\n" );
            close( scanner->r_pipe );
            scanner->r_pipe = -1;
      } else {
            DBG( _DBG_PROC, "reader_process started (as thread)\n" );
      }

      sigfillset ( &ignore_set );
      sigdelset  ( &ignore_set, SIGTERM );
#if defined (__APPLE__) && defined (__MACH__)
      sigdelset  ( &ignore_set, SIGUSR2 );
#endif
      sigprocmask( SIG_SETMASK, &ignore_set, 0 );

      cancelRead = SANE_FALSE;

      /* install the signal handler */
      memset( &act, 0, sizeof (act));
      sigemptyset(&(act.sa_mask));
      act.sa_flags = 0;

      act.sa_handler = reader_process_sigterm_handler;
      sigaction( SIGTERM, &act, 0 );

      act.sa_handler = usb_reader_process_sigterm_handler;
      sigaction( SIGUSR1, &act, 0 );

      data_length = scanner->params.lines * scanner->params.bytes_per_line;

      DBG( _DBG_PROC, "reader_process:"
                              "starting to READ data (%lu bytes)\n", data_length );
      DBG( _DBG_PROC, "buf = 0x%08lx\n", (unsigned long)scanner->buf );

      if( NULL == scanner->buf ) {
            DBG( _DBG_FATAL, "NULL Pointer !!!!\n" );
            return SANE_STATUS_IO_ERROR;
      }
      
      /* here we read all data from the scanner... */
      buf    = scanner->buf;
      status = u12if_prepare( scanner->hw );
      
      if( SANE_STATUS_GOOD == status ) {

            for( line = 0; line < scanner->params.lines; line++ ) {

                  status = u12if_readLine( scanner->hw, buf );
                  if( SANE_STATUS_GOOD != status ) {
                        break;
                  }

                  write( scanner->w_pipe, buf, scanner->params.bytes_per_line );
            buf += scanner->params.bytes_per_line;
            }
      }

      close( scanner->w_pipe );
      scanner->w_pipe = -1;

      /* on error, there's no need to clean up, as this is done by the parent */
      if( SANE_STATUS_GOOD != status ) {
            DBG( _DBG_ERROR, "read failed, status = %i\n", (int)status );
            return status;
      }

      DBG( _DBG_PROC, "reader_process: finished reading data\n" );
      return SANE_STATUS_GOOD;
}

/** stop the current scan process
 */
00385 static SANE_Status do_cancel( U12_Scanner *scanner, SANE_Bool closepipe )
{
      struct SIGACTION act;
      pid_t            res;

      DBG( _DBG_PROC,"do_cancel\n" );

      scanner->scanning = SANE_FALSE;

      if( scanner->reader_pid > 0 ) {

            DBG( _DBG_PROC, ">>>>>>>> killing reader_process <<<<<<<<\n" );

            cancelRead = SANE_TRUE;

          sigemptyset(&(act.sa_mask));
      act.sa_flags = 0;

            act.sa_handler = sigalarm_handler;
            sigaction( SIGALRM, &act, 0 );

            /* kill our child process and wait until done */
            sanei_thread_sendsig( scanner->reader_pid, SIGUSR1 );

            /* give'em 10 seconds 'til done...*/
            alarm(10);
            res = sanei_thread_waitpid( scanner->reader_pid, 0 );
            alarm(0);

            if( res != scanner->reader_pid ) {
                  DBG( _DBG_PROC,"sanei_thread_waitpid() failed !\n");
                  
                  /* do it the hard way...*/
#ifdef USE_PTHREAD
                  sanei_thread_kill( scanner->reader_pid );
#else
                  sanei_thread_sendsig( scanner->reader_pid, SIGKILL );
#endif
            }
            scanner->reader_pid = 0;
            DBG( _DBG_PROC, "reader_process killed\n");

            if( scanner->hw->fd >= 0 ) {
                  u12hw_CancelSequence( scanner->hw );
            }
#ifndef HAVE_SETITIMER
            u12hw_StartLampTimer( scanner->hw );
#endif
      }

      if( SANE_TRUE == closepipe ) {
            drvClosePipes( scanner );
      }

      drvClose( scanner->hw );

      if( tsecs != 0 ) {
            DBG( _DBG_INFO, "TIME END 2: %lus\n", time(NULL)-tsecs);
            tsecs = 0;
      }

      return SANE_STATUS_CANCELLED;
}

/** initialize the options for the backend according to the device we have
 */
00451 static SANE_Status init_options( U12_Scanner *s )
{
      int i;

      memset( s->opt, 0, sizeof(s->opt));

      for( i = 0; i < NUM_OPTIONS; ++i ) {
            s->opt[i].size = sizeof (SANE_Word);
            s->opt[i].cap = SANE_CAP_SOFT_SELECT | SANE_CAP_SOFT_DETECT;
    }

      s->opt[OPT_NUM_OPTS].name  = SANE_NAME_NUM_OPTIONS;
      s->opt[OPT_NUM_OPTS].title = SANE_TITLE_NUM_OPTIONS;
      s->opt[OPT_NUM_OPTS].desc  = SANE_DESC_NUM_OPTIONS;
      s->opt[OPT_NUM_OPTS].type  = SANE_TYPE_INT;
      s->opt[OPT_NUM_OPTS].unit  = SANE_UNIT_NONE;
      s->opt[OPT_NUM_OPTS].cap   = SANE_CAP_SOFT_DETECT;
      s->opt[OPT_NUM_OPTS].constraint_type = SANE_CONSTRAINT_NONE;
      s->val[OPT_NUM_OPTS].w     = NUM_OPTIONS;

      /* "Scan Mode" group: */
      s->opt[OPT_MODE_GROUP].name  = "scanmode-group";
      s->opt[OPT_MODE_GROUP].title = SANE_I18N("Scan Mode");
      s->opt[OPT_MODE_GROUP].desc  = "";
      s->opt[OPT_MODE_GROUP].type  = SANE_TYPE_GROUP;
      s->opt[OPT_MODE_GROUP].cap   = 0;

#ifdef ALL_MODES
      /* scan mode */
      s->opt[OPT_MODE].name  = SANE_NAME_SCAN_MODE;
      s->opt[OPT_MODE].title = SANE_TITLE_SCAN_MODE;
      s->opt[OPT_MODE].desc  = SANE_DESC_SCAN_MODE;
      s->opt[OPT_MODE].type  = SANE_TYPE_STRING;
      s->opt[OPT_MODE].size  = 32;
      s->opt[OPT_MODE].constraint_type = SANE_CONSTRAINT_STRING_LIST;
      s->opt[OPT_MODE].constraint.string_list = mode_list;
      s->val[OPT_MODE].w     = COLOR_TRUE24;

      /* scan source */
      s->opt[OPT_EXT_MODE].name  = SANE_NAME_SCAN_SOURCE;
      s->opt[OPT_EXT_MODE].title = SANE_TITLE_SCAN_SOURCE;
      s->opt[OPT_EXT_MODE].desc  = SANE_DESC_SCAN_SOURCE;
      s->opt[OPT_EXT_MODE].type  = SANE_TYPE_STRING;
      s->opt[OPT_EXT_MODE].size  = 32;
      s->opt[OPT_EXT_MODE].constraint_type = SANE_CONSTRAINT_STRING_LIST;
      s->opt[OPT_EXT_MODE].constraint.string_list = src_list;
      s->val[OPT_EXT_MODE].w = 0; /* Normal */
#endif
      /* brightness */
      s->opt[OPT_BRIGHTNESS].name  = SANE_NAME_BRIGHTNESS;
      s->opt[OPT_BRIGHTNESS].title = SANE_TITLE_BRIGHTNESS;
      s->opt[OPT_BRIGHTNESS].desc  = SANE_DESC_BRIGHTNESS;
      s->opt[OPT_BRIGHTNESS].type  = SANE_TYPE_FIXED;
      s->opt[OPT_BRIGHTNESS].unit  = SANE_UNIT_PERCENT;
      s->opt[OPT_BRIGHTNESS].constraint_type = SANE_CONSTRAINT_RANGE;
      s->opt[OPT_BRIGHTNESS].constraint.range = &percentage_range;
      s->val[OPT_BRIGHTNESS].w     = 0;

      /* contrast */
      s->opt[OPT_CONTRAST].name             = SANE_NAME_CONTRAST;
      s->opt[OPT_CONTRAST].title            = SANE_TITLE_CONTRAST;
      s->opt[OPT_CONTRAST].desc             = SANE_DESC_CONTRAST;
      s->opt[OPT_CONTRAST].type             = SANE_TYPE_FIXED;
      s->opt[OPT_CONTRAST].unit             = SANE_UNIT_PERCENT;
      s->opt[OPT_CONTRAST].constraint_type  =  SANE_CONSTRAINT_RANGE;
      s->opt[OPT_CONTRAST].constraint.range = &percentage_range;
      s->val[OPT_CONTRAST].w                = 0;

      /* resolution */
      s->opt[OPT_RESOLUTION].name  = SANE_NAME_SCAN_RESOLUTION;
      s->opt[OPT_RESOLUTION].title = SANE_TITLE_SCAN_RESOLUTION;
      s->opt[OPT_RESOLUTION].desc  = SANE_DESC_SCAN_RESOLUTION;
      s->opt[OPT_RESOLUTION].type  = SANE_TYPE_INT;
      s->opt[OPT_RESOLUTION].unit  = SANE_UNIT_DPI;

      s->opt[OPT_RESOLUTION].constraint_type  = SANE_CONSTRAINT_RANGE;
      s->opt[OPT_RESOLUTION].constraint.range = &s->hw->dpi_range;
      s->val[OPT_RESOLUTION].w = s->hw->dpi_range.min;

      /* custom-gamma table */
      s->opt[OPT_CUSTOM_GAMMA].name  = SANE_NAME_CUSTOM_GAMMA;
      s->opt[OPT_CUSTOM_GAMMA].title = SANE_TITLE_CUSTOM_GAMMA;
      s->opt[OPT_CUSTOM_GAMMA].desc  = SANE_DESC_CUSTOM_GAMMA;
      s->opt[OPT_CUSTOM_GAMMA].type  = SANE_TYPE_BOOL;
      s->val[OPT_CUSTOM_GAMMA].w     = SANE_FALSE;

      /* preview */
      s->opt[OPT_PREVIEW].name  = SANE_NAME_PREVIEW;
      s->opt[OPT_PREVIEW].title = SANE_TITLE_PREVIEW;
      s->opt[OPT_PREVIEW].desc  = SANE_DESC_PREVIEW;
      s->opt[OPT_PREVIEW].cap   = SANE_CAP_SOFT_DETECT | SANE_CAP_SOFT_SELECT;
      s->val[OPT_PREVIEW].w     = 0;

      /* "Geometry" group: */
      s->opt[OPT_GEOMETRY_GROUP].name  = "geometry-group";
      s->opt[OPT_GEOMETRY_GROUP].title = SANE_I18N("Geometry");
      s->opt[OPT_GEOMETRY_GROUP].desc  = "";
      s->opt[OPT_GEOMETRY_GROUP].type  = SANE_TYPE_GROUP;
      s->opt[OPT_GEOMETRY_GROUP].cap   = SANE_CAP_ADVANCED;

      /* top-left x */
      s->opt[OPT_TL_X].name  = SANE_NAME_SCAN_TL_X;
      s->opt[OPT_TL_X].title = SANE_TITLE_SCAN_TL_X;
      s->opt[OPT_TL_X].desc  = SANE_DESC_SCAN_TL_X;
      s->opt[OPT_TL_X].type  = SANE_TYPE_FIXED;
      s->opt[OPT_TL_X].unit  = SANE_UNIT_MM;
      s->opt[OPT_TL_X].constraint_type = SANE_CONSTRAINT_RANGE;
      s->opt[OPT_TL_X].constraint.range = &s->hw->x_range;
      s->val[OPT_TL_X].w = SANE_FIX(_DEFAULT_TLX);

      /* top-left y */
      s->opt[OPT_TL_Y].name  = SANE_NAME_SCAN_TL_Y;
      s->opt[OPT_TL_Y].title = SANE_TITLE_SCAN_TL_Y;
      s->opt[OPT_TL_Y].desc  = SANE_DESC_SCAN_TL_Y;
      s->opt[OPT_TL_Y].type  = SANE_TYPE_FIXED;
      s->opt[OPT_TL_Y].unit  = SANE_UNIT_MM;
      s->opt[OPT_TL_Y].constraint_type = SANE_CONSTRAINT_RANGE;
      s->opt[OPT_TL_Y].constraint.range = &s->hw->y_range;
      s->val[OPT_TL_Y].w = SANE_FIX(_DEFAULT_TLY);

      /* bottom-right x */
      s->opt[OPT_BR_X].name  = SANE_NAME_SCAN_BR_X;
      s->opt[OPT_BR_X].title = SANE_TITLE_SCAN_BR_X;
      s->opt[OPT_BR_X].desc  = SANE_DESC_SCAN_BR_X;
      s->opt[OPT_BR_X].type  = SANE_TYPE_FIXED;
      s->opt[OPT_BR_X].unit  = SANE_UNIT_MM;
      s->opt[OPT_BR_X].constraint_type = SANE_CONSTRAINT_RANGE;
      s->opt[OPT_BR_X].constraint.range = &s->hw->x_range;
      s->val[OPT_BR_X].w = SANE_FIX(_DEFAULT_BRX);

      /* bottom-right y */
      s->opt[OPT_BR_Y].name  = SANE_NAME_SCAN_BR_Y;
      s->opt[OPT_BR_Y].title = SANE_TITLE_SCAN_BR_Y;
      s->opt[OPT_BR_Y].desc  = SANE_DESC_SCAN_BR_Y;
      s->opt[OPT_BR_Y].type  = SANE_TYPE_FIXED;
      s->opt[OPT_BR_Y].unit  = SANE_UNIT_MM;
      s->opt[OPT_BR_Y].constraint_type = SANE_CONSTRAINT_RANGE;
      s->opt[OPT_BR_Y].constraint.range = &s->hw->y_range;
      s->val[OPT_BR_Y].w = SANE_FIX(_DEFAULT_BRY);

      /* "Enhancement" group: */
      s->opt[OPT_ENHANCEMENT_GROUP].title = SANE_I18N("Enhancement");   
      s->opt[OPT_ENHANCEMENT_GROUP].desc = "";
      s->opt[OPT_ENHANCEMENT_GROUP].type = SANE_TYPE_GROUP;
      s->opt[OPT_ENHANCEMENT_GROUP].cap = 0;
      s->opt[OPT_ENHANCEMENT_GROUP].constraint_type = SANE_CONSTRAINT_NONE;
      
      u12map_InitGammaSettings( s->hw );

      /* grayscale gamma vector */
      s->opt[OPT_GAMMA_VECTOR].name  = SANE_NAME_GAMMA_VECTOR;
      s->opt[OPT_GAMMA_VECTOR].title = SANE_TITLE_GAMMA_VECTOR;
      s->opt[OPT_GAMMA_VECTOR].desc  = SANE_DESC_GAMMA_VECTOR;
      s->opt[OPT_GAMMA_VECTOR].type  = SANE_TYPE_INT;
      s->opt[OPT_GAMMA_VECTOR].unit  = SANE_UNIT_NONE;
      s->opt[OPT_GAMMA_VECTOR].constraint_type = SANE_CONSTRAINT_RANGE;
      s->val[OPT_GAMMA_VECTOR].wa = &(s->hw->gamma_table[0][0]);
      s->opt[OPT_GAMMA_VECTOR].constraint.range = &(s->hw->gamma_range);
      s->opt[OPT_GAMMA_VECTOR].size = s->hw->gamma_length * sizeof(SANE_Word);

      /* red gamma vector */
      s->opt[OPT_GAMMA_VECTOR_R].name  = SANE_NAME_GAMMA_VECTOR_R;
      s->opt[OPT_GAMMA_VECTOR_R].title = SANE_TITLE_GAMMA_VECTOR_R;
      s->opt[OPT_GAMMA_VECTOR_R].desc  = SANE_DESC_GAMMA_VECTOR_R;
      s->opt[OPT_GAMMA_VECTOR_R].type  = SANE_TYPE_INT;
      s->opt[OPT_GAMMA_VECTOR_R].unit  = SANE_UNIT_NONE;
      s->opt[OPT_GAMMA_VECTOR_R].constraint_type = SANE_CONSTRAINT_RANGE;
      s->val[OPT_GAMMA_VECTOR_R].wa = &(s->hw->gamma_table[1][0]);
      s->opt[OPT_GAMMA_VECTOR_R].constraint.range = &(s->hw->gamma_range);
      s->opt[OPT_GAMMA_VECTOR_R].size = s->hw->gamma_length * sizeof(SANE_Word);

      /* green gamma vector */
      s->opt[OPT_GAMMA_VECTOR_G].name  = SANE_NAME_GAMMA_VECTOR_G;
      s->opt[OPT_GAMMA_VECTOR_G].title = SANE_TITLE_GAMMA_VECTOR_G;
      s->opt[OPT_GAMMA_VECTOR_G].desc  = SANE_DESC_GAMMA_VECTOR_G;
      s->opt[OPT_GAMMA_VECTOR_G].type  = SANE_TYPE_INT;
      s->opt[OPT_GAMMA_VECTOR_G].unit  = SANE_UNIT_NONE;
      s->opt[OPT_GAMMA_VECTOR_G].constraint_type = SANE_CONSTRAINT_RANGE;
      s->val[OPT_GAMMA_VECTOR_G].wa = &(s->hw->gamma_table[2][0]);
      s->opt[OPT_GAMMA_VECTOR_G].constraint.range = &(s->hw->gamma_range);
      s->opt[OPT_GAMMA_VECTOR_G].size = s->hw->gamma_length * sizeof(SANE_Word);

      /* blue gamma vector */
      s->opt[OPT_GAMMA_VECTOR_B].name  = SANE_NAME_GAMMA_VECTOR_B;
      s->opt[OPT_GAMMA_VECTOR_B].title = SANE_TITLE_GAMMA_VECTOR_B;
      s->opt[OPT_GAMMA_VECTOR_B].desc  = SANE_DESC_GAMMA_VECTOR_B;
      s->opt[OPT_GAMMA_VECTOR_B].type  = SANE_TYPE_INT;
      s->opt[OPT_GAMMA_VECTOR_B].unit  = SANE_UNIT_NONE;
      s->opt[OPT_GAMMA_VECTOR_B].constraint_type = SANE_CONSTRAINT_RANGE;
      s->val[OPT_GAMMA_VECTOR_B].wa = &(s->hw->gamma_table[3][0]);
      s->opt[OPT_GAMMA_VECTOR_B].constraint.range = &(s->hw->gamma_range);
      s->opt[OPT_GAMMA_VECTOR_B].size = s->hw->gamma_length * sizeof(SANE_Word);

      /* GAMMA stuff is disabled per default */ 
      s->opt[OPT_GAMMA_VECTOR].cap   |= SANE_CAP_INACTIVE;
      s->opt[OPT_GAMMA_VECTOR_R].cap |= SANE_CAP_INACTIVE;
      s->opt[OPT_GAMMA_VECTOR_G].cap |= SANE_CAP_INACTIVE;
      s->opt[OPT_GAMMA_VECTOR_B].cap |= SANE_CAP_INACTIVE;

#ifdef ALL_MODES
      /* disable extended mode list for devices without TPA */
      if( SANE_FALSE == s->hw->Tpa ) {
            s->opt[OPT_EXT_MODE].cap |= SANE_CAP_INACTIVE;
      }
#endif
      return SANE_STATUS_GOOD;
}

/** Function to retrieve the vendor and product id from a given string
 * @param src  - string, that should be investigated
 * @param dest - pointer to a string to receive the USB ID
 */
00663 static void decodeUsbIDs( char *src, char **dest )
{           
      const char *name; 
      char       *tmp = *dest;
      int         len = strlen(_SECTION);

      if( isspace(src[len])) {
            strncpy( tmp, &src[len+1], (strlen(src)-(len+1)));
            tmp[(strlen(src)-(len+1))] = '\0';
      }

      name = tmp;
      name = sanei_config_skip_whitespace( name );

      if( '\0' == name[0] ) {
            DBG( _DBG_SANE_INIT, "next device uses autodetection\n" );
      } else {
                  
            u_short pi = 0, vi = 0;

            if( *name ) {
      
                  name = sanei_config_get_string( name, &tmp );
                  if( tmp ) {
                  vi = strtol( tmp, 0, 0 );
                      free( tmp );
                  }
            }

            name = sanei_config_skip_whitespace( name );
            if( *name ) {
            
                  name = sanei_config_get_string( name, &tmp );
                  if( tmp ) {
                        pi = strtol( tmp, 0, 0 );
                        free( tmp );
                  }
            }

            /* create what we need to go through our device list...*/
            sprintf( *dest, "0x%04X-0x%04X", vi, pi );
            DBG( _DBG_SANE_INIT, "next device is a USB device (%s)\n", *dest );
      }
}

#define _INT   0
#define _FLOAT 1

/** function to decode an value and give it back to the caller.
 * @param src    -  pointer to the source string to check
 * @param opt    -  string that keeps the option name to check src for
 * @param what   - _FLOAT or _INT
 * @param result -  pointer to the var that should receive our result
 * @param def    - default value that result should be in case of any error
 * @return The function returns SANE_TRUE if the option has been found,
 *         if not, it returns SANE_FALSE
 */
00720 static SANE_Bool decodeVal( char *src, char *opt,
                                          int what, void *result, void *def )
{
      char       *tmp, *tmp2;
      const char *name;

      /* skip the option string */
      name = (const char*)&src[strlen("option")];

      /* get the name of the option */
      name = sanei_config_get_string( name, &tmp );

      if( tmp ) {

            /* on success, compare wiht the given one */
            if( 0 == strcmp( tmp, opt )) {
      
                  DBG( _DBG_SANE_INIT, "Decoding option >%s<\n", opt );

                  if( _INT == what ) {
                  
                        /* assign the default value for this option... */
                        *((int*)result) = *((int*)def);
      
                        if( *name ) {

                              /* get the configuration value and decode it */
                              name = sanei_config_get_string( name, &tmp2 );

                              if( tmp2 ) {
                                    *((int*)result) = strtol( tmp2, 0, 0 );
                              free( tmp2 );
                              }
                        }
                        free( tmp );      
                        return SANE_TRUE;
                        
                  } else if( _FLOAT == what ) {
                  
                        /* assign the default value for this option... */
                        *((double*)result) = *((double*)def);
      
                        if( *name ) {

                              /* get the configuration value and decode it */
                              name = sanei_config_get_string( name, &tmp2 );

                              if( tmp2 ) {
                                    *((double*)result) = strtod( tmp2, 0 );
                              free( tmp2 );
                              }
                        }
                        free( tmp );      
                        return SANE_TRUE;
                  }
            }     
            free( tmp );
      }
      
      return SANE_FALSE;
}

/** function to retrive the device name of a given string
 * @param src  -  string that keeps the option name to check src for
 * @param dest -  pointer to the string, that should receive the detected
 *                devicename
 * @return The function returns SANE_TRUE if the devicename has been found,
 *         if not, it returns SANE_FALSE
 */
00789 static SANE_Bool decodeDevName( char *src, char *dest )
{
      char       *tmp;  
      const char *name;

      if( 0 == strncmp( "device", src, 6 )) {

            name = (const char*)&src[strlen("device")];
            name = sanei_config_skip_whitespace( name );
      
            DBG( _DBG_SANE_INIT, "Decoding device name >%s<\n", name );
            
            if( *name ) {
                  name = sanei_config_get_string( name, &tmp );
                  if( tmp ) {
                        
                        strcpy( dest, tmp );
                  free( tmp );
                  return SANE_TRUE;
                }
            }     
      }
      
      return SANE_FALSE;
}

/** attach a device to the backend
 */
00817 static SANE_Status attach( const char *dev_name,
                           pCnfDef cnf, U12_Device **devp )
{
      int         result;
      int         handle;
      U12_Device *dev;

      DBG( _DBG_SANE_INIT, "attach (%s, %p, %p)\n",
                                            dev_name, (void *)cnf, (void *)devp);

      /* already attached ?*/
      for( dev = first_dev; dev; dev = dev->next ) {

            if( 0 == strcmp( dev->sane.name, dev_name )) {
                  if( devp )
                  *devp = dev;

            return SANE_STATUS_GOOD;
        }
    }

      /* allocate some memory for the device */
      dev = malloc( sizeof (*dev));
      if( NULL == dev )
      return SANE_STATUS_NO_MEM;

      /* assign all the stuff we need fo this device... */
      memset(dev, 0, sizeof (*dev));
      
      dev->fd          = -1;
      dev->name        = strdup(dev_name);    /* hold it double to avoid  */
      dev->sane.name   = dev->name;           /* compiler warnings        */
      dev->sane.vendor = "Plustek";
      dev->sane.model  = "U12/1212U";
      dev->sane.type   = "USB flatbed scanner";
      dev->initialized = SANE_FALSE;         

      memcpy( &dev->adj, &cnf->adj, sizeof(AdjDef));
      show_cnf( cnf );

      strncpy( dev->usbId, cnf->usbId, _MAX_ID_LEN );
      
      /* go ahead and open the scanner device */
      handle = u12if_open( dev );
      if( handle < 0 ) {
            DBG( _DBG_ERROR,"open failed: %d\n", handle );
            return SANE_STATUS_IO_ERROR;
      }

      /* okay, so assign the handle... */
      dev->fd = handle;

      /* now check what we have */
      result = u12if_getCaps( dev );
      if( result < 0 ) {
            DBG( _DBG_ERROR, "u12if_getCaps() failed(%d)\n", result);
            u12if_close( dev );
            return SANE_STATUS_IO_ERROR;
    }

      /* save the info we got from the driver */
      DBG( _DBG_INFO, "Scanner information:\n" );
      DBG( _DBG_INFO, "Vendor : %s\n",      dev->sane.vendor  );
      DBG( _DBG_INFO, "Model  : %s\n",      dev->sane.model   );
      DBG( _DBG_INFO, "Flags  : 0x%08lx\n", dev->caps.flag  );

      if( SANE_STATUS_GOOD != u12if_SetupBuffer( dev )) {
            DBG( _DBG_ERROR, "u12if_SetupBuffer() failed\n" );
            u12if_close( dev );
            return SANE_STATUS_NO_MEM;
      }

      drvClose( dev );
      DBG( _DBG_SANE_INIT, "attach: model = >%s<\n", dev->sane.model );

      ++num_devices;
      dev->next = first_dev;
      first_dev = dev;

      if( devp )
            *devp = dev;

      return SANE_STATUS_GOOD;
}

/** function to preset a configuration structure
 * @param cnf - pointer to the structure that should be initialized
 */
00905 static void init_config_struct( pCnfDef cnf )
{
      memset( cnf, 0, sizeof(CnfDef));

      cnf->adj.warmup       = -1;
      cnf->adj.lampOff      = -1;
      cnf->adj.lampOffOnEnd = -1;

      cnf->adj.graygamma = 1.0;
      cnf->adj.rgamma    = 1.0;
      cnf->adj.ggamma    = 1.0;
      cnf->adj.bgamma    = 1.0;
}

/** intialize the backend
 */
00921 SANE_Status sane_init( SANE_Int *version_code, SANE_Auth_Callback authorize )
{
      char     str[PATH_MAX] = _DEFAULT_DEVICE;
    CnfDef   config;
      size_t   len;
      FILE    *fp;

      DBG_INIT();

      sanei_usb_init();
      sanei_thread_init();

      DBG( _DBG_INFO, "U12 backend V"
                      BACKEND_VERSION", part of "PACKAGE " " VERSION "\n");

      /* do some presettings... */
      auth         = authorize;
      first_dev    = NULL;
      first_handle = NULL;
      num_devices  = 0;

      /* initialize the configuration structure */                
      init_config_struct( &config );

      if( version_code != NULL )
            *version_code = SANE_VERSION_CODE(V_MAJOR, V_MINOR, 0);

      fp = sanei_config_open( U12_CONFIG_FILE );

      /* default to _DEFAULT_DEVICE instead of insisting on config file */
      if( NULL == fp ) {
            return attach( _DEFAULT_DEVICE, &config, 0 );
      }

      while( sanei_config_read( str, sizeof(str), fp)) {
            
            DBG( _DBG_SANE_INIT, ">%s<\n", str );
            if( str[0] == '#')            /* ignore line comments */
            continue;
                  
            len = strlen(str);
            if( 0 == len )
            continue;                   /* ignore empty lines */

            /* check for options */
            if( 0 == strncmp(str, "option", 6)) {
            
                  int    ival;
                  double dval;
            
                  ival = -1;
                  decodeVal( str, "warmup",    _INT, &config.adj.warmup,      &ival);
                  decodeVal( str, "lampOff",   _INT, &config.adj.lampOff,     &ival);
                  decodeVal( str, "lOffOnEnd", _INT, &config.adj.lampOffOnEnd,&ival);
                  
                  ival = 0;

                  dval = 1.5;
                  decodeVal( str, "grayGamma",  _FLOAT, &config.adj.graygamma,&dval);
                  decodeVal( str, "redGamma",   _FLOAT, &config.adj.rgamma, &dval );
                  decodeVal( str, "greenGamma", _FLOAT, &config.adj.ggamma, &dval );
                  decodeVal( str, "blueGamma",  _FLOAT, &config.adj.bgamma, &dval );
                  continue;

            /* check for sections: */
            } else if( 0 == strncmp( str, _SECTION, strlen(_SECTION))) {
            
                char *tmp;
            
                /* new section, try and attach previous device */
                if( config.devName[0] != '\0' ) {
                        attach( config.devName, &config, 0 );
                  } else {
                        if( first_dev != NULL ) {
                              DBG( _DBG_WARNING, "section contains no device name,"
                                                 " ignored!\n" );
                         }
                  }
            
                  /* re-initialize the configuration structure */
                  init_config_struct( &config );
            
                  tmp = config.usbId;
                  decodeUsbIDs( str, &tmp );
            
                  DBG( _DBG_SANE_INIT, "... next device\n" );
                  continue;                     

            } else if( SANE_TRUE == decodeDevName( str, config.devName )) {
                  continue;
            }
            
            /* ignore other stuff... */
            DBG( _DBG_SANE_INIT, "ignoring >%s<\n", str );
      }
      fclose( fp );

    /* try to attach the last device in the config file... */
      if( config.devName[0] != '\0' )
            attach( config.devName, &config, 0 );

      return SANE_STATUS_GOOD;
}

/** cleanup the backend...
 */
01027 void sane_exit( void )
{
      U12_Device *dev, *next;

      DBG( _DBG_SANE_INIT, "sane_exit\n" );

      for( dev = first_dev; dev; ) {

            next = dev->next;

            u12if_shutdown( dev );

            /*
             * we're doin' this to avoid compiler warnings as dev->sane.name
             * is defined as const char*
             */
            if( dev->sane.name )
                  free( dev->name );

        if( dev->res_list )
                  free( dev->res_list );

            free( dev );
            dev = next;
      }

      if( devlist )
            free( devlist );

      devlist      = NULL;
      auth         = NULL;
      first_dev    = NULL;
      first_handle = NULL;
}

/** return a list of all devices
 */
SANE_Status
01065 sane_get_devices(const SANE_Device ***device_list,    SANE_Bool local_only )
{
      int         i;
      U12_Device *dev;

      DBG(_DBG_SANE_INIT, "sane_get_devices (%p, %ld)\n",
                          (void *)device_list, (long) local_only);

      /* already called, so cleanup */
      if( devlist )
            free( devlist );

      devlist = malloc((num_devices + 1) * sizeof (devlist[0]));
      if ( NULL == devlist )
            return SANE_STATUS_NO_MEM;

      i = 0;
      for( dev = first_dev; i < num_devices; dev = dev->next )
            devlist[i++] = &dev->sane;
      devlist[i++] = 0;

      *device_list = devlist;
      return SANE_STATUS_GOOD;
}

/** open the sane device
 */
01092 SANE_Status sane_open( SANE_String_Const devicename, SANE_Handle* handle )
{
      SANE_Status  status;
      U12_Device  *dev;
      U12_Scanner *s;
      CnfDef       config;

      DBG( _DBG_SANE_INIT, "sane_open - %s\n", devicename );

      if( devicename[0] ) {
      for( dev = first_dev; dev; dev = dev->next ) {
                  if( strcmp( dev->sane.name, devicename ) == 0 )
                        break;
            }

            if( !dev ) {

                  memset( &config, 0, sizeof(CnfDef));
                  
                  status = attach( devicename, &config, &dev );
                  if( SANE_STATUS_GOOD != status )
                        return status;
            }
      } else {
            /* empty devicename -> use first device */
            dev = first_dev;
      }

      if( !dev )
      return SANE_STATUS_INVAL;

      s = malloc (sizeof (*s));
      if( NULL == s )
      return SANE_STATUS_NO_MEM;

      memset(s, 0, sizeof (*s));
      s->r_pipe   = -1;
      s->w_pipe   = -1;
      s->hw       = dev;
      s->scanning = SANE_FALSE;

      init_options( s );

      /* insert newly opened handle into list of open handles: */
      s->next      = first_handle;
      first_handle = s;

      *handle = s;
      
      return SANE_STATUS_GOOD;
}

/**
 */
01146 void sane_close( SANE_Handle handle )
{
      U12_Scanner *prev, *s;

      DBG( _DBG_SANE_INIT, "sane_close\n" );

      /* remove handle from list of open handles: */
      prev = 0;

      for( s = first_handle; s; s = s->next ) {
            if( s == handle )
                  break;
            prev = s;
      }

      if( !s ) {
            DBG( _DBG_ERROR, "close: invalid handle %p\n", handle);
            return;
      }

      drvClosePipes( s );

      if( NULL != s->buf )
            free(s->buf);

      if( NULL != s->hw->bufs.b1.pReadBuf )
            free( s->hw->bufs.b1.pReadBuf );

      if( NULL != s->hw->shade.pHilight )
            free( s->hw->shade.pHilight );

      if( NULL != s->hw->scaleBuf )
            free( s->hw->scaleBuf );

      drvClose( s->hw );

      if (prev)
      prev->next = s->next;
      else
            first_handle = s->next;

      free(s);
}

/** return or set the parameter values, also do some checks
 */
01192 SANE_Status sane_control_option( SANE_Handle handle, SANE_Int option,
                                 SANE_Action action, void *value,
                                 SANE_Int * info)
{
      U12_Scanner             *s = (U12_Scanner *)handle;
      SANE_Status              status;
      const SANE_String_Const *optval;
#ifdef ALL_MODES
      pModeParam               mp;
      int                      idx;
#endif
      int                      scanmode;
      
      if ( s->scanning )
            return SANE_STATUS_DEVICE_BUSY;

      if((option < 0) || (option >= NUM_OPTIONS))
      return SANE_STATUS_INVAL;

      if( NULL != info )
            *info = 0;

      switch( action ) {

            case SANE_ACTION_GET_VALUE:
                  switch (option) {
                  case OPT_PREVIEW:
                  case OPT_NUM_OPTS:
                  case OPT_RESOLUTION:
                  case OPT_TL_X:
                  case OPT_TL_Y:
                  case OPT_BR_X:
                  case OPT_BR_Y:
                  case OPT_CUSTOM_GAMMA:
                    *(SANE_Word *)value = s->val[option].w;
                    break;

                  case OPT_CONTRAST:
                  case OPT_BRIGHTNESS:
                        *(SANE_Word *)value =
                                                (s->val[option].w << SANE_FIXED_SCALE_SHIFT);
                        break;

#ifdef ALL_MODES
                  case OPT_MODE:
                  case OPT_EXT_MODE:
                        strcpy ((char *) value,
                                s->opt[option].constraint.string_list[s->val[option].w]);
                        break;
#endif

                  /* word array options: */
                  case OPT_GAMMA_VECTOR:
                  case OPT_GAMMA_VECTOR_R:
                  case OPT_GAMMA_VECTOR_G:
                  case OPT_GAMMA_VECTOR_B:
                        memcpy( value, s->val[option].wa, s->opt[option].size );
                        break;

                  default:
                        return SANE_STATUS_INVAL;
            }
            break;

      case SANE_ACTION_SET_VALUE:
            status = sanei_constrain_value( s->opt + option, value, info );
                if( SANE_STATUS_GOOD != status )
                      return status;

            optval = NULL;
            if( SANE_CONSTRAINT_STRING_LIST == s->opt[option].constraint_type ) {

                  optval = search_string_list( s->opt[option].constraint.string_list,
                                                         (char *) value);
                  if( NULL == optval )
                        return SANE_STATUS_INVAL;
                }

            switch (option) {

                  case OPT_RESOLUTION: {
                      int n;
                  int min_d = s->hw->res_list[s->hw->res_list_size - 1];
                          int v     = *(SANE_Word *)value;
                  int best  = v;

                              for( n = 0; n < s->hw->res_list_size; n++ ) {
                                    int d = abs(v - s->hw->res_list[n]);

                                    if( d < min_d ) {
                                          min_d = d;
                                          best  = s->hw->res_list[n];
                                    }
                              }

                              s->val[option].w = (SANE_Word)best;

                              if( v != best )
                                    *(SANE_Word *)value = best;

                              if( NULL != info ) {
                                    if( v != best )
                                          *info |= SANE_INFO_INEXACT;
                                    *info |= SANE_INFO_RELOAD_PARAMS;
                              }
                              break;
                        }

                        case OPT_PREVIEW:
                  case OPT_TL_X:
                  case OPT_TL_Y:
                  case OPT_BR_X:
                      case OPT_BR_Y:
                        s->val[option].w = *(SANE_Word *)value;
                        if( NULL != info )
                              *info |= SANE_INFO_RELOAD_PARAMS;
                        break;
                        
                        case OPT_CUSTOM_GAMMA:
                        s->val[option].w = *(SANE_Word *)value;
                        if( NULL != info )
                              *info |= SANE_INFO_RELOAD_PARAMS | SANE_INFO_RELOAD_OPTIONS;

#ifdef ALL_MODES
                              mp = getModeList( s );
                              scanmode = mp[s->val[OPT_MODE].w].scanmode;
#else
                              scanmode = COLOR_TRUE24;
#endif

                            s->opt[OPT_GAMMA_VECTOR].cap   |= SANE_CAP_INACTIVE;
                            s->opt[OPT_GAMMA_VECTOR_R].cap |= SANE_CAP_INACTIVE;
                            s->opt[OPT_GAMMA_VECTOR_G].cap |= SANE_CAP_INACTIVE;
                            s->opt[OPT_GAMMA_VECTOR_B].cap |= SANE_CAP_INACTIVE;

                        if( SANE_TRUE == s->val[option].w ) {
                        
                              if( scanmode == COLOR_256GRAY ) {
                                        s->opt[OPT_GAMMA_VECTOR].cap &= ~SANE_CAP_INACTIVE;
                                    } else {
                                        s->opt[OPT_GAMMA_VECTOR_R].cap &= ~SANE_CAP_INACTIVE;
                                        s->opt[OPT_GAMMA_VECTOR_G].cap &= ~SANE_CAP_INACTIVE;
                                        s->opt[OPT_GAMMA_VECTOR_B].cap &= ~SANE_CAP_INACTIVE;
                                    }           
                                                            
                        } else {
      
                                    u12map_InitGammaSettings( s->hw );
                        
                              if( scanmode == COLOR_256GRAY ) {
                                        s->opt[OPT_GAMMA_VECTOR].cap |= SANE_CAP_INACTIVE;
                                    } else {                                  
                                        s->opt[OPT_GAMMA_VECTOR_R].cap |= SANE_CAP_INACTIVE;
                                        s->opt[OPT_GAMMA_VECTOR_G].cap |= SANE_CAP_INACTIVE;
                                        s->opt[OPT_GAMMA_VECTOR_B].cap |= SANE_CAP_INACTIVE;
                                    }                                   
                        }
                        break;

                  case OPT_CONTRAST:
                      case OPT_BRIGHTNESS:
                        s->val[option].w =
                                          ((*(SANE_Word *)value) >> SANE_FIXED_SCALE_SHIFT);
                        break;

#ifdef ALL_MODES
                  case OPT_MODE: 
                    idx = (optval - mode_list);
                              mp  = getModeList( s );
                              
                              s->opt[OPT_CONTRAST].cap     &= ~SANE_CAP_INACTIVE;
                              s->opt[OPT_CUSTOM_GAMMA].cap &= ~SANE_CAP_INACTIVE;

                        if( mp[idx].scanmode == COLOR_BW ) {
                              s->opt[OPT_CONTRAST].cap     |= SANE_CAP_INACTIVE;
                              s->opt[OPT_CUSTOM_GAMMA].cap |= SANE_CAP_INACTIVE;
                        }     
                        
                        s->opt[OPT_GAMMA_VECTOR].cap   |= SANE_CAP_INACTIVE;
                        s->opt[OPT_GAMMA_VECTOR_R].cap |= SANE_CAP_INACTIVE;
                        s->opt[OPT_GAMMA_VECTOR_G].cap |= SANE_CAP_INACTIVE;
                        s->opt[OPT_GAMMA_VECTOR_B].cap |= SANE_CAP_INACTIVE;
                              
                              if( s->val[OPT_CUSTOM_GAMMA].w &&
                              !(s->opt[OPT_CUSTOM_GAMMA].cap & SANE_CAP_INACTIVE)) {
                              
                              if( mp[idx].scanmode == COLOR_256GRAY ) {
                                        s->opt[OPT_GAMMA_VECTOR].cap   &= ~SANE_CAP_INACTIVE;
                                    } else {
                                    s->opt[OPT_GAMMA_VECTOR_R].cap &= ~SANE_CAP_INACTIVE;
                                    s->opt[OPT_GAMMA_VECTOR_G].cap &= ~SANE_CAP_INACTIVE;
                                    s->opt[OPT_GAMMA_VECTOR_B].cap &= ~SANE_CAP_INACTIVE;
                                    }
                              }

                        if( NULL != info )
                              *info |= SANE_INFO_RELOAD_OPTIONS | SANE_INFO_RELOAD_PARAMS;

                        s->val[option].w = optval - s->opt[option].constraint.string_list;
                            break;

                  case OPT_EXT_MODE: {
                        s->val[option].w = optval - s->opt[option].constraint.string_list;

                        /*
                         * change the area and mode_list when changing the source
                             */
                        if( s->val[option].w == 0 ) {

                              s->hw->dpi_range.min = _DEF_DPI;

                              s->hw->x_range.max = SANE_FIX(s->hw->max_x);
                              s->hw->y_range.max = SANE_FIX(s->hw->max_y);
                              s->val[OPT_TL_X].w = SANE_FIX(_DEFAULT_TLX);
                                  s->val[OPT_TL_Y].w = SANE_FIX(_DEFAULT_TLY);
                              s->val[OPT_BR_X].w = SANE_FIX(_DEFAULT_BRX);
                              s->val[OPT_BR_Y].w = SANE_FIX(_DEFAULT_BRY);

                                  s->opt[OPT_MODE].constraint.string_list = mode_list;
                              s->val[OPT_MODE].w = COLOR_TRUE24;

                            } else {

                                  s->hw->dpi_range.min = _TPAMinDpi;

                              if( s->val[option].w == 1 ) {
                                    s->hw->x_range.max = SANE_FIX(_TP_X);
                                    s->hw->y_range.max = SANE_FIX(_TP_Y);
                                    s->val[OPT_TL_X].w = SANE_FIX(_DEFAULT_TP_TLX);
                                    s->val[OPT_TL_Y].w = SANE_FIX(_DEFAULT_TP_TLY);
                                    s->val[OPT_BR_X].w = SANE_FIX(_DEFAULT_TP_BRX);
                                        s->val[OPT_BR_Y].w = SANE_FIX(_DEFAULT_TP_BRY);

                                    } else {
                                          s->hw->x_range.max = SANE_FIX(_NEG_X);
                                    s->hw->y_range.max = SANE_FIX(_NEG_Y);
                                          s->val[OPT_TL_X].w = SANE_FIX(_DEFAULT_NEG_TLX);
                                          s->val[OPT_TL_Y].w = SANE_FIX(_DEFAULT_NEG_TLY);
                                          s->val[OPT_BR_X].w = SANE_FIX(_DEFAULT_NEG_BRX);
                                          s->val[OPT_BR_Y].w = SANE_FIX(_DEFAULT_NEG_BRY);
                              }
                              s->opt[OPT_MODE].constraint.string_list =
                                                                  &mode_list[_TPAModeSupportMin];
                                    s->val[OPT_MODE].w = 0;       /* COLOR_24 is the default */
                        }

                            s->opt[OPT_CONTRAST].cap &= ~SANE_CAP_INACTIVE;

                        if( NULL != info )
                              *info |= SANE_INFO_RELOAD_OPTIONS | SANE_INFO_RELOAD_PARAMS;
                        break;
                  }
#endif
                        case OPT_GAMMA_VECTOR:
                        case OPT_GAMMA_VECTOR_R:
                        case OPT_GAMMA_VECTOR_G:
                        case OPT_GAMMA_VECTOR_B:
                              memcpy( s->val[option].wa, value, s->opt[option].size );
                              u12map_CheckGammaSettings(s->hw);
                              if( NULL != info )
                                    *info |= SANE_INFO_RELOAD_PARAMS;
                              break;

                      default:
                            return SANE_STATUS_INVAL;
                  }
                  break;

            default:
                  return SANE_STATUS_INVAL;
      }

      return SANE_STATUS_GOOD;
}

/** according to the option number, return a pointer to a descriptor
 */
const SANE_Option_Descriptor *
01470 sane_get_option_descriptor( SANE_Handle handle, SANE_Int option )
{
      U12_Scanner *s = (U12_Scanner *)handle;

      if((option < 0) || (option >= NUM_OPTIONS))
            return NULL;

      return &(s->opt[option]);
}

/** return the current parameter settings
 */
01482 SANE_Status sane_get_parameters( SANE_Handle handle, SANE_Parameters *params )
{
      int          ndpi;
#ifdef ALL_MODES
      pModeParam   mp;
#endif
      U12_Scanner *s = (U12_Scanner *)handle;

      /* if we're called from within, calc best guess
     * do the same, if sane_get_parameters() is called
     * by a frontend before sane_start() is called
     */
    if((NULL == params) || (s->scanning != SANE_TRUE)) {

#ifdef ALL_MODES
            mp = getModeList( s );
#endif
            memset( &s->params, 0, sizeof (SANE_Parameters));

            ndpi = s->val[OPT_RESOLUTION].w;

          s->params.pixels_per_line =     SANE_UNFIX(s->val[OPT_BR_X].w -
                                                       s->val[OPT_TL_X].w) / _MM_PER_INCH * ndpi;

      s->params.lines = SANE_UNFIX( s->val[OPT_BR_Y].w -
                                                       s->val[OPT_TL_Y].w) / _MM_PER_INCH * ndpi;

            /* pixels_per_line seems to be 8 * n.  */
            /* s->params.pixels_per_line = s->params.pixels_per_line & ~7; debug only */

          s->params.last_frame = SANE_TRUE;
#ifdef ALL_MODES
            s->params.depth = mp[s->val[OPT_MODE].w].depth;
#else
            s->params.depth = 8;
            s->params.format = SANE_FRAME_RGB;
            s->params.bytes_per_line = 3 * s->params.pixels_per_line;
#endif

#ifdef ALL_MODES
            if( mp[s->val[OPT_MODE].w].color ) {
                  s->params.format = SANE_FRAME_RGB;
                  s->params.bytes_per_line = 3 * s->params.pixels_per_line;
            } else {
                  s->params.format = SANE_FRAME_GRAY;
                  if (s->params.depth == 1)
                        s->params.bytes_per_line = (s->params.pixels_per_line + 7) / 8;
                  else
                        s->params.bytes_per_line = s->params.pixels_per_line *
                                                                                       s->params.depth / 8;
            }
#endif

        /* if sane_get_parameters() was called before sane_start() */
          /* pass new values to the caller                           */
      if ((NULL != params) && (s->scanning != SANE_TRUE))
            *params = s->params;
      } else
            *params = s->params;

      return SANE_STATUS_GOOD;
}

/** initiate the scan process
 */
01547 SANE_Status sane_start( SANE_Handle handle )
{
      U12_Scanner *s = (U12_Scanner *)handle;
      U12_Device  *dev;
#ifdef ALL_MODES
      ModeParam   *mp;
#endif
      int         result;
      int         ndpi;
      int         left, top;
      int         width, height;
      int         scanmode;
      int         fds[2];
      double      dpi_x, dpi_y;
      ImgDef      image;
      SANE_Status status;
      SANE_Word   tmp;

      DBG( _DBG_SANE_INIT, "sane_start\n" );
      if( s->scanning ) {
            return SANE_STATUS_DEVICE_BUSY;
      }

      status = sane_get_parameters (handle, NULL);
      if (status != SANE_STATUS_GOOD) {
            DBG( _DBG_ERROR, "sane_get_parameters failed\n" );
            return status;
      }

      dev = s->hw;

      /* open the driver and get some information about the scanner
       */
      dev->fd = u12if_open( dev );
      if( dev->fd < 0 ) {
            DBG( _DBG_ERROR,"sane_start: open failed: %d\n", errno );

            if( errno == EBUSY )
                  return SANE_STATUS_DEVICE_BUSY;

            return SANE_STATUS_IO_ERROR;
      }

      tsecs = 0;

      result = u12if_getCaps( dev );
      if( result < 0 ) {
            DBG( _DBG_ERROR, "u12if_getCaps() failed(%d)\n", result);
            u12if_close( dev );
            return SANE_STATUS_IO_ERROR;
    }
      
      /* All ready to go.  Set image def and see what the scanner
       * says for crop info.
       */
      ndpi = s->val[OPT_RESOLUTION].w;

      /* exchange the values as we can't deal with negative heights and so on...*/
      tmp = s->val[OPT_TL_X].w;
      if( tmp > s->val[OPT_BR_X].w ) {
            DBG( _DBG_INFO, "exchanging BR-X - TL-X\n" );
            s->val[OPT_TL_X].w = s->val[OPT_BR_X].w;
            s->val[OPT_BR_X].w = tmp;
      }

      tmp = s->val[OPT_TL_Y].w;
      if( tmp > s->val[OPT_BR_Y].w ) {
            DBG( _DBG_INFO, "exchanging BR-Y - TL-Y\n" );
            s->val[OPT_TL_Y].w = s->val[OPT_BR_Y].w;
      s->val[OPT_BR_Y].w = tmp;
      }

      /* position and extent are always relative to 300 dpi */
      dpi_x = (double)dev->dpi_max_x;
      dpi_y = (double)dev->dpi_max_y;

      left   = (int)(SANE_UNFIX(s->val[OPT_TL_X].w)* dpi_x/
                                           (_MM_PER_INCH*(dpi_x/_MEASURE_BASE)));
      top    = (int)(SANE_UNFIX(s->val[OPT_TL_Y].w)*dpi_y/
                                           (_MM_PER_INCH*(dpi_y/_MEASURE_BASE)));
      width  = (int)(SANE_UNFIX(s->val[OPT_BR_X].w - s->val[OPT_TL_X].w) *
                                  dpi_x / (_MM_PER_INCH *(dpi_x/_MEASURE_BASE)));
      height = (int)(SANE_UNFIX(s->val[OPT_BR_Y].w - s->val[OPT_TL_Y].w) *
                                  dpi_y / (_MM_PER_INCH *(dpi_y/_MEASURE_BASE)));

      if((width == 0) || (height == 0)) {
            DBG( _DBG_ERROR, "invalid width or height!\n" );
            return SANE_STATUS_INVAL;
      }

      /* adjust mode list according to the model we use and the source we have
       */
#ifdef ALL_MODES
      mp = getModeList( s );
      scanmode = mp[s->val[OPT_MODE].w].scanmode;
#else
      scanmode = COLOR_TRUE24;
#endif
      DBG( _DBG_INFO, "scanmode = %u\n", scanmode );

      /* clear it out just in case */
      memset (&image, 0, sizeof(ImgDef));

      /* this is what we want */
      image.xyDpi.x   = ndpi;
      image.xyDpi.y   = ndpi;
      image.crArea.x  = left;  /* offset from left edge to area you want to scan */
      image.crArea.y  = top;   /* offset from top edge to area you want to scan  */
      image.crArea.cx = width; /* always relative to 300 dpi */
      image.crArea.cy = height;
      image.wDataType = scanmode;

#ifdef ALL_MODES
      switch( s->val[OPT_EXT_MODE].w ) {
            case 1: image.dwFlag |= _SCANDEF_Transparency; break;
            case 2: image.dwFlag |= _SCANDEF_Negative;     break;
            default: break;
      }
#endif

#if 0
      if( s->val[OPT_PREVIEW].w )
            image.dwFlag |= _SCANDEF_PREVIEW;
#endif
    /* set adjustments for brightness and contrast */
      dev->DataInf.siBrightness = s->val[OPT_BRIGHTNESS].w;
      dev->DataInf.siContrast   = s->val[OPT_CONTRAST].w;

      DBG( _DBG_SANE_INIT, "brightness %i, contrast %i\n",
                           dev->DataInf.siBrightness, dev->DataInf.siContrast );

      result = u12image_SetupScanSettings( dev, &image );
      if( SANE_STATUS_GOOD != result ) {
            DBG( _DBG_ERROR, "u12image_SetupScanSettings() failed(%d)\n", result );
            u12if_close( dev );
            return SANE_STATUS_IO_ERROR;
      }

      s->params.pixels_per_line = dev->DataInf.dwAppPixelsPerLine;
      s->params.bytes_per_line  = dev->DataInf.dwAppBytesPerLine;
      s->params.lines           = dev->DataInf.dwAppLinesPerArea;

      DBG( _DBG_INFO, "* PixelPerLine = %u\n", s->params.pixels_per_line );
      DBG( _DBG_INFO, "* BytesPerLine = %u\n", s->params.bytes_per_line  );
      DBG( _DBG_INFO, "* Lines        = %u\n", s->params.lines  );

      /* reset our timer...*/
      tsecs = 0;

      s->buf = realloc( s->buf, (s->params.lines) * s->params.bytes_per_line );
      if( NULL == s->buf ) {
            DBG( _DBG_ERROR, "realloc failed\n" );
            u12if_close( dev );
            return SANE_STATUS_NO_MEM;
      }

      result = u12if_startScan( dev );
      if( SANE_STATUS_GOOD != result ) {
            DBG( _DBG_ERROR, "u12if_startScan() failed(%d)\n", result );
            u12if_close( dev );
            return SANE_STATUS_IO_ERROR;
    }

      s->scanning = SANE_TRUE;

      tsecs = (unsigned long)time(NULL);
      DBG( _DBG_INFO, "TIME START\n" );

      /*
       * everything prepared, so start the child process and a pipe to communicate
       * pipe --> fds[0]=read-fd, fds[1]=write-fd
       */
      if( pipe(fds) < 0 ) {
            DBG( _DBG_ERROR, "ERROR: could not create pipe\n" );
          s->scanning = SANE_FALSE;
            u12if_close( dev );
            return SANE_STATUS_IO_ERROR;
      }

      /* create reader routine as new process */
      s->bytes_read = 0;
      s->r_pipe     = fds[0];
      s->w_pipe     = fds[1];
      s->reader_pid = sanei_thread_begin( reader_process, s );
      
      cancelRead = SANE_FALSE;
      
      if( s->reader_pid < 0 ) {
            DBG( _DBG_ERROR, "ERROR: could not start reader task\n" );
          s->scanning = SANE_FALSE;
            u12if_close( dev );
            return SANE_STATUS_IO_ERROR;
      }

      signal( SIGCHLD, sig_chldhandler );
      if( sanei_thread_is_forked()) {
            close( s->w_pipe );
            s->w_pipe = -1;
      }
            
      DBG( _DBG_SANE_INIT, "sane_start done\n" );
      return SANE_STATUS_GOOD;
}

/** function to read the data from our child process
 */
01753 SANE_Status sane_read( SANE_Handle handle, SANE_Byte *data,
                       SANE_Int max_length, SANE_Int *length )
{
      U12_Scanner *s = (U12_Scanner*)handle;
      ssize_t      nread;

      *length = 0;

      /* here we read all data from the driver... */
      nread = read( s->r_pipe, data, max_length );
      DBG( _DBG_READ, "sane_read - read %ld bytes\n", (long)nread );
      if (!(s->scanning)) {
            return do_cancel( s, SANE_TRUE );
      }

      if( nread < 0 ) {

            if( EAGAIN == errno ) {

            /* if we already had red the picture, so it's okay and stop */
                  if( s->bytes_read ==
                        (unsigned long)(s->params.lines * s->params.bytes_per_line)) {
                        sanei_thread_waitpid( s->reader_pid, 0 );
                        s->reader_pid = -1;
                        drvClose( s->hw );
                        return drvClosePipes(s);
                  }

                  /* else force the frontend to try again*/
                  return SANE_STATUS_GOOD;

            } else {
                  DBG( _DBG_ERROR, "ERROR: errno=%d\n", errno );
                  do_cancel( s, SANE_TRUE );
                  return SANE_STATUS_IO_ERROR;
            }
      }

      *length        = nread;
      s->bytes_read += nread;

    /* nothing red means that we're finished OR we had a problem...*/
      if( 0 == nread ) {

            drvClose( s->hw );
            s->exit_code = sanei_thread_get_status( s->reader_pid );

            if( SANE_STATUS_GOOD != s->exit_code ) {
                  drvClosePipes(s);
                  return s->exit_code;
            }
            s->reader_pid = -1;
            return drvClosePipes(s);
      }

      return SANE_STATUS_GOOD;
}

/** cancel the scanning process
 */
01813 void sane_cancel( SANE_Handle handle )
{
      U12_Scanner *s = (U12_Scanner *)handle;

      DBG( _DBG_SANE_INIT, "sane_cancel\n" );

      if( s->scanning )
            do_cancel( s, SANE_FALSE );
}

/** set the pipe to blocking/non blocking mode
 */
01825 SANE_Status sane_set_io_mode( SANE_Handle handle, SANE_Bool non_blocking )
{
      U12_Scanner *s = (U12_Scanner *)handle;

      DBG( _DBG_SANE_INIT, "sane_set_io_mode: non_blocking=%d\n", non_blocking );

      if ( !s->scanning ) {
            DBG( _DBG_ERROR, "ERROR: not scanning !\n" );
            return SANE_STATUS_INVAL;
      }

      if( -1 == s->r_pipe ) {
            DBG( _DBG_ERROR, "ERROR: not supported !\n" );
            return SANE_STATUS_UNSUPPORTED;
      }
      
      if( fcntl (s->r_pipe, F_SETFL, non_blocking ? O_NONBLOCK : 0) < 0) {
            DBG( _DBG_ERROR, "ERROR: canīt set to non-blocking mode !\n" );
            return SANE_STATUS_IO_ERROR;
      }

      DBG( _DBG_SANE_INIT, "sane_set_io_mode done\n" );
      return SANE_STATUS_GOOD;
}

/** return the descriptor if available
 */
01852 SANE_Status sane_get_select_fd( SANE_Handle handle, SANE_Int * fd )
{
      U12_Scanner *s = (U12_Scanner *)handle;

      DBG( _DBG_SANE_INIT, "sane_get_select_fd\n" );

      if( !s->scanning ) {
            DBG( _DBG_ERROR, "ERROR: not scanning !\n" );
            return SANE_STATUS_INVAL;
      }

      *fd = s->r_pipe;

      DBG( _DBG_SANE_INIT, "sane_get_select_fd done\n" );
      return SANE_STATUS_GOOD;
}

/* END U12.C ................................................................*/

Generated by  Doxygen 1.6.0   Back to index