Fredrik Lundh wrote:
>>I have started work on Eikazo, a new Sane frontend
>>(http://eikazo.berlios.de). It focuses on "mass scans", especially
>>with ADF scanners -- it is not intended to compete with XSane or
>>Kooka with their quite elaborate functions.
>>
>>Some Eikazo features:
>
> cool!
Thanks :)
>
> is the updated sane module in the PIL directory the latest and greatest?
> should I simply grab a copy of that for PIL 1.1.6 ?
Uhhh, no ;) There is some newer stuff available (attached to this
mail) While the version packed with Eikazo has better threading
support (very useful for Eikazo ;), I've worked meanwhile on another
patch for _sane.c, but this patch may need some discussion.
The changes are related to Sane integer and fixed number options
that have more than one element (i.e., that are arrays of numbers;
the most important usage are gamma curves implemented in a scanner's
firmware). Without this patch, such options are not readable (except
for the first array element) or settable by PIL's Sane module.
I made two changes:
1. Sane "array options" are now returned as lists of Python
integers resp. floats. If such an option is set, any Python
sequence type can be passed as the option's value (provided of
course that is has the correct length).
2. the length of such an "array option" is given in the Sane API
(http://www.sane-project.org/html/doc011.html) by the field
'size' of struct SANE_Option_Descriptor. The data of this struct
is mapped by SaneDev_get_options in _sane.c to an element of a
Python tuple.
SANE_Option_Descriptor.size gives the length of the data array in
_bytes_, i.e., not the number of array elements. The "offical
Sane way" to get the number of array elements in C is to
calculate SANE_Option_Descriptor.size/sizeof(SANE_Word) -- but
this division is not present in the current "offical" versions of
the Python Sane module. Instead, the length in bytes is simply
passed to the caller of SaneDev_get_options.
The attached version of _sane.c has this division, making it
easier and more reliable to get the "real" array length in
Python. Needing to divide the size value by the "magic constant"
4 in Python is IMHO a bit strange ;) Moreover, I am not sure, if
sizeof(SANE_Word) is 4 or 8 on 64 bit platforms...
On the other hand, this is an slight incompatibility to older
versions.
I don't believe that the size of a Sane option has been used so
far very much in real application, because "array options" were
not useable anyway, so the nummber of affected applications
should be close to zero -- but this is a guess: I don't know
every application that uses PIL and PIL's Sane module ;) On the
other hand, one can also detect the array size in Python from the
length of the list returned by SaneDev_get_option in the new
version of _sane.c, so there is no urgent need for the division
by sizeof(SANE_Word) -- it may just be more convenient in some
cases.
To sum up possible problems:
1. A very naive application that simply tries to access every
scanner option of type SANE_Int or SANE_Fixed without checking its
length will probably break. On the other hand, an application that
simply works with the first element of an array instead of the
entire array needs to be fixed anyway.
2. The change in SaneDev_get_options -- the division
SANE_Option_Descriptor.size/sizeof(SANE_Word) -- may break
applications that make this calculation for themselves in order to
avoid to access (up to now useless) array options.
Any comments, especially on the second change/problem?
Abel
/***********************************************************
(C) Copyright 2003 A.M. Kuchling. All Rights Reserved
(C) Copyright 2004 A.M. Kuchling, Ralph Heinkel All Rights Reserved
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of A.M. Kuchling and
Ralph Heinkel not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior permission.
A.M. KUCHLING, R.H. HEINKEL DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
******************************************************************/
/* SaneDev objects */
#include "Python.h"
#include "Imaging.h"
#include <sane/sane.h>
#include <sys/time.h>
static PyObject *ErrorObject;
typedef struct {
PyObject_HEAD
SANE_Handle h;
} SaneDevObject;
#ifdef WITH_THREAD
PyThreadState *_save;
#endif
/* Raise a SANE exception */
PyObject *
PySane_Error(SANE_Status st)
{
const char *string;
if (st==SANE_STATUS_GOOD) {Py_INCREF(Py_None); return (Py_None);}
string=sane_strstatus(st);
PyErr_SetString(ErrorObject, string);
return NULL;
}
staticforward PyTypeObject SaneDev_Type;
#define SaneDevObject_Check(v) ((v)->ob_type == &SaneDev_Type)
static SaneDevObject *
newSaneDevObject(void)
{
SaneDevObject *self;
self = PyObject_NEW(SaneDevObject, &SaneDev_Type);
if (self == NULL)
return NULL;
self->h=NULL;
return self;
}
/* SaneDev methods */
static void
SaneDev_dealloc(SaneDevObject *self)
{
if (self->h) sane_close(self->h);
self->h=NULL;
PyObject_DEL(self);
}
static PyObject *
SaneDev_close(SaneDevObject *self, PyObject *args)
{
if (!PyArg_ParseTuple(args, ""))
return NULL;
if (self->h) sane_close(self->h);
self->h=NULL;
Py_INCREF(Py_None);
return (Py_None);
}
static PyObject *
SaneDev_get_parameters(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
SANE_Parameters p;
char *format="unknown format";
if (!PyArg_ParseTuple(args, ""))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
Py_BEGIN_ALLOW_THREADS
st=sane_get_parameters(self->h, &p);
Py_END_ALLOW_THREADS
if (st) return PySane_Error(st);
switch (p.format)
{
case(SANE_FRAME_GRAY): format="gray"; break;
case(SANE_FRAME_RGB): format="color"; break;
case(SANE_FRAME_RED): format="red"; break;
case(SANE_FRAME_GREEN): format="green"; break;
case(SANE_FRAME_BLUE): format="blue"; break;
}
return Py_BuildValue("si(ii)ii", format, p.last_frame, p.pixels_per_line,
p.lines, p.depth, p.bytes_per_line);
}
static PyObject *
SaneDev_fileno(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
SANE_Int fd;
if (!PyArg_ParseTuple(args, ""))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
st=sane_get_select_fd(self->h, &fd);
if (st) return PySane_Error(st);
return PyInt_FromLong(fd);
}
static PyObject *
SaneDev_start(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
if (!PyArg_ParseTuple(args, ""))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
/* sane_start can take several seconds, if the user initiates
a new scan, while the scan head of a flatbed scanner moves
back to the start position after finishing a previous scan.
Hence it is worth to allow threads here.
*/
Py_BEGIN_ALLOW_THREADS
st=sane_start(self->h);
Py_END_ALLOW_THREADS
if (st) return PySane_Error(st);
Py_INCREF(Py_None);
return Py_None;
}
static PyObject *
SaneDev_cancel(SaneDevObject *self, PyObject *args)
{
if (!PyArg_ParseTuple(args, ""))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
sane_cancel(self->h);
Py_INCREF(Py_None);
return Py_None;
}
static PyObject *
SaneDev_get_options(SaneDevObject *self, PyObject *args)
{
const SANE_Option_Descriptor *d;
PyObject *list, *value;
int i=1;
if (!PyArg_ParseTuple(args, ""))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
if (!(list = PyList_New(0)))
return NULL;
do
{
d=sane_get_option_descriptor(self->h, i);
if (d!=NULL)
{
PyObject *constraint=NULL;
int j;
switch (d->constraint_type)
{
case(SANE_CONSTRAINT_NONE):
Py_INCREF(Py_None); constraint=Py_None; break;
case(SANE_CONSTRAINT_RANGE):
if (d->type == SANE_TYPE_INT)
constraint=Py_BuildValue("iii", d->constraint.range->min,
d->constraint.range->max,
d->constraint.range->quant);
else
constraint=Py_BuildValue("ddd",
SANE_UNFIX(d->constraint.range->min),
SANE_UNFIX(d->constraint.range->max),
SANE_UNFIX(d->constraint.range->quant));
break;
case(SANE_CONSTRAINT_WORD_LIST):
constraint=PyList_New(d->constraint.word_list[0]);
if (d->type == SANE_TYPE_INT)
for (j=1; j<=d->constraint.word_list[0]; j++)
PyList_SetItem(constraint, j-1,
PyInt_FromLong(d->constraint.word_list[j]));
else
for (j=1; j<=d->constraint.word_list[0]; j++)
PyList_SetItem(constraint, j-1,
PyFloat_FromDouble(SANE_UNFIX(d->constraint.word_list[j])));
break;
case(SANE_CONSTRAINT_STRING_LIST):
constraint=PyList_New(0);
for(j=0; d->constraint.string_list[j]!=NULL; j++)
PyList_Append(constraint,
PyString_FromString(d->constraint.string_list[j]));
break;
}
if (d->type != SANE_TYPE_STRING)
{
value=Py_BuildValue("isssiiiiO", i, d->name, d->title, d->desc,
d->type, d->unit, d->size/sizeof(SANE_Word),
d->cap, constraint);
}
else
{
value=Py_BuildValue("isssiiiiO", i, d->name, d->title, d->desc,
d->type, d->unit, d->size,
d->cap, constraint);
}
PyList_Append(list, value);
}
i++;
} while (d!=NULL);
return list;
}
static PyObject *
SaneDev_get_option(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
const SANE_Option_Descriptor *d;
PyObject *value=NULL;
int n, i, imax;
void *v;
if (!PyArg_ParseTuple(args, "i", &n))
{
return NULL;
}
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
d=sane_get_option_descriptor(self->h, n);
v=malloc(d->size+1);
if (v == NULL)
{
return PyErr_NoMemory();
}
st=sane_control_option(self->h, n, SANE_ACTION_GET_VALUE,
v, NULL);
if (st)
{
free(v);
return PySane_Error(st);
}
imax = d->size/sizeof(SANE_Word);
switch(d->type)
{
case(SANE_TYPE_BOOL):
case(SANE_TYPE_INT):
if (imax < 1)
/* pure paranoia */
{
PyErr_SetString(ErrorObject, "invalid option size");
free(v);
return NULL;
}
if (imax == 1)
{
value=Py_BuildValue("i", *( (SANE_Int*)v) );
}
else
{
value = PyList_New(imax);
if (value == NULL)
{
free(v);
return NULL;
}
for (i = 0; i < imax; i++)
{
PyObject *k;
k = PyInt_FromLong( ((SANE_Int*)v)[i]);
PyList_SET_ITEM(value, i, k);
}
}
break;
case(SANE_TYPE_FIXED):
if (imax < 1)
/* pure paranoia */
{
PyErr_SetString(ErrorObject, "invalid option size");
free(v);
return NULL;
}
if (imax==1)
{
value=Py_BuildValue("d", SANE_UNFIX((*((SANE_Fixed*)v))) );
}
else
{
value = PyList_New(d->size/sizeof(SANE_Word));
if (value == NULL)
{
free(v);
return NULL;
}
for (i = 0; imax; i++)
{
PyList_SET_ITEM(value, i,
PyFloat_FromDouble(SANE_UNFIX( ((SANE_Fixed*)v)[i] )));
}
}
break;
case(SANE_TYPE_STRING):
value=Py_BuildValue("s", v);
break;
case(SANE_TYPE_BUTTON):
case(SANE_TYPE_GROUP):
value=Py_BuildValue("O", Py_None);
break;
}
free(v);
return value;
}
static PyObject *
SaneDev_set_option(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
const SANE_Option_Descriptor *d;
SANE_Int i;
PyObject *value, *elem;
int n, j, jmax;
void *v;
if (!PyArg_ParseTuple(args, "iO", &n, &value))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
d=sane_get_option_descriptor(self->h, n);
v=malloc(d->size+1);
if (v == NULL)
{
return PyErr_NoMemory();
}
jmax = d->size / sizeof(SANE_Word);
switch(d->type)
{
case(SANE_TYPE_BOOL):
if (!PyInt_Check(value))
{
PyErr_SetString(PyExc_TypeError, "SANE_BOOL requires an integer");
free(v);
return NULL;
}
/* fall through */
case(SANE_TYPE_INT):
if (jmax < 1)
/* pure paranoia */
{
free(v);
PyErr_SetString(ErrorObject, "invalid option size");
return NULL;
}
if (jmax==1 && PyInt_Check(value))
{
*( (SANE_Int*)v) = PyInt_AsLong(value);
}
else if (PySequence_Check(value))
{
if (jmax != PySequence_Length(value))
{
PyErr_SetString(PyExc_ValueError, "invalid sequence length");
free(v);
return NULL;
}
for (j = 0; j <jmax; j++)
{
elem = PySequence_ITEM(value, j);
if (!PyInt_Check(elem))
{
PyErr_SetString(PyExc_TypeError, "SANE_INT requires an integer or a seqnece of integers");
free(v);
return NULL;
}
( (SANE_Int*)v)[j] = PyInt_AsLong(elem);
Py_DECREF(elem);
}
}
else
{
PyErr_SetString(PyExc_TypeError, "SANE_INT requires an integer or a seqnece of integers");
free(v);
return NULL;
}
break;
case(SANE_TYPE_FIXED):
if (jmax < 1)
/* pure paranoia */
{
free(v);
PyErr_SetString(ErrorObject, "invalid option size");
return NULL;
}
if (jmax && PyFloat_Check(value))
{
*( (SANE_Fixed*)v) = SANE_FIX(PyFloat_AsDouble(value));
}
else if (PySequence_Check(value))
{
if (jmax != PySequence_Length(value))
{
PyErr_SetString(PyExc_ValueError, "invalid sequence length");
free(v);
return NULL;
}
for (j = 0; j < jmax; j++)
{
elem = PySequence_ITEM(value, j);
if (!PyFloat_Check(elem))
{
PyErr_SetString(PyExc_TypeError, "SANE_FIXED requires a floating point number or a sequence of floating point numbers");
free(v);
return NULL;
}
( (SANE_Fixed*)v)[j] = SANE_FIX(PyFloat_AsDouble(elem));
Py_DECREF(elem);
}
}
else
{
PyErr_SetString(PyExc_TypeError, "SANE_FIXED requires a floating point number or a sequence of floating point numbers");
free(v);
return NULL;
}
break;
case(SANE_TYPE_STRING):
if (!PyString_Check(value))
{
PyErr_SetString(PyExc_TypeError, "SANE_STRING requires a string");
free(v);
return NULL;
}
strncpy(v, PyString_AsString(value), d->size-1);
((char*)v)[d->size-1] = 0;
break;
case(SANE_TYPE_BUTTON):
case(SANE_TYPE_GROUP):
break;
}
st=sane_control_option(self->h, n, SANE_ACTION_SET_VALUE,
v, &i);
if (st) {free(v); return PySane_Error(st);}
free(v);
return Py_BuildValue("i", i);
}
static PyObject *
SaneDev_set_auto_option(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
const SANE_Option_Descriptor *d;
SANE_Int i;
int n;
if (!PyArg_ParseTuple(args, "i", &n))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
d=sane_get_option_descriptor(self->h, n);
st=sane_control_option(self->h, n, SANE_ACTION_SET_AUTO,
NULL, &i);
if (st) {return PySane_Error(st);}
return Py_BuildValue("i", i);
}
#define READSIZE 32768
static PyObject *
SaneDev_snap(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
/* The buffer should be a multiple of 3 in size, so each sane_read
operation will return an integral number of RGB triples. */
SANE_Byte buffer[READSIZE]; /* XXX how big should the buffer be? */
SANE_Int len, lastlen;
Imaging im;
SANE_Parameters p;
int px, py, remain, cplen, bufpos, padbytes;
long L;
char errmsg[80];
union
{ char c[2];
INT16 i16;
}
endian;
PyObject *pyNoCancel = NULL;
int noCancel = 0;
endian.i16 = 1;
if (!PyArg_ParseTuple(args, "i|O", &L, &pyNoCancel))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
im=(Imaging)L;
if (pyNoCancel)
noCancel = PyObject_IsTrue(pyNoCancel);
st=SANE_STATUS_GOOD; px=py=0;
/* xxx not yet implemented
- handscanner support (i.e., unknown image length during start)
- generally: move the functionality from method snap in sane.py
down here -- I don't like this cross-dependency.
we need to call sane_get_parameters here, and we can create
the result Image object here.
*/
Py_UNBLOCK_THREADS
sane_get_parameters(self->h, &p);
if (p.format == SANE_FRAME_GRAY)
{
switch (p.depth)
{
case 1:
remain = p.bytes_per_line * im->ysize;
padbytes = p.bytes_per_line - (im->xsize+7)/8;
bufpos = 0;
lastlen = len = 0;
while (st!=SANE_STATUS_EOF && py < im->ysize)
{
while (len > 0 && py < im->ysize)
{
int i, j, k;
j = buffer[bufpos++];
k = 0x80;
for (i = 0; i < 8 && px < im->xsize; i++)
{
im->image8[py][px++] = (k&j) ? 0 : 0xFF;
k = k >> 1;
}
len--;
if (px >= im->xsize)
{
bufpos += padbytes;
len -= padbytes;
py++;
px = 0;
}
}
st=sane_read(self->h, buffer,
remain<READSIZE ? remain : READSIZE, &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
bufpos -= lastlen;
lastlen = len;
remain -= len;
/* skip possible pad bytes at the start of the buffer */
len -= bufpos;
}
break;
case 8:
remain = p.bytes_per_line * im->ysize;
padbytes = p.bytes_per_line - im->xsize;
bufpos = 0;
len = 0;
while (st!=SANE_STATUS_EOF && py < im->ysize)
{
while (len > 0 && py < im->ysize)
{
cplen = len;
if (px + cplen >= im->xsize)
cplen = im->xsize - px;
memcpy(&im->image8[py][px], &buffer[bufpos], cplen);
len -= cplen;
bufpos += cplen;
px += cplen;
if (px >= im->xsize)
{
px = 0;
py++;
bufpos += padbytes;
len -= padbytes;
}
}
bufpos = -len;
st=sane_read(self->h, buffer,
remain<READSIZE ? remain : READSIZE, &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
remain -= len;
len -= bufpos;
}
break;
case 16:
remain = p.bytes_per_line * im->ysize;
padbytes = p.bytes_per_line - 2 * im->xsize;
bufpos = endian.c[0];
lastlen = len = 0;
while (st!=SANE_STATUS_EOF && py < im->ysize)
{
while (len > 0 && py < im->ysize)
{
im->image8[py][px++] = buffer[bufpos];
bufpos += 2;
len -= 2;
if (px >= im->xsize)
{
bufpos += padbytes;
len -= padbytes;
py++;
px = 0;
}
}
st=sane_read(self->h, buffer,
remain<READSIZE ? remain : READSIZE, &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
remain -= len;
bufpos -= lastlen;
lastlen = len;
len -= bufpos;
}
break;
default:
/* other depths are not formally "illegal" according to the
Sane API, but it's agreed by Sane developers that other
depths than 1, 8, 16 should not be used
*/
sane_cancel(self->h);
Py_BLOCK_THREADS
snprintf(errmsg, 80, "unsupported pixel depth: %i", p.depth);
PyErr_SetString(ErrorObject, errmsg);
return NULL;
}
}
else if (p.format == SANE_FRAME_RGB)
{
int incr, color, pxs, pxmax, bit, val, mask;
switch (p.depth)
{
case 1:
remain = p.bytes_per_line * im->ysize;
padbytes = p.bytes_per_line - ((im->xsize+7)/8) * 3;
bufpos = 0;
len = 0;
lastlen = 0;
pxmax = 4 * im->xsize;
while (st!=SANE_STATUS_EOF && py < im->ysize)
{
pxs = px;
for (color = 0; color < 3; color++)
{
while (len <= 0 && st == SANE_STATUS_GOOD)
{
st=sane_read(self->h, buffer,
remain<READSIZE ? remain : READSIZE, &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
bufpos -= lastlen;
remain -= len;
lastlen = len;
/* skip possible pad bytes at the start of the buffer */
len -= bufpos;
}
if (st == SANE_STATUS_EOF) break;
pxs = px;
val = buffer[bufpos++];
len--;
mask = 0x80;
for (bit = 0; (bit < 8) && (px < pxmax); bit++)
{
((UINT8**)(im->image32))[py][px] = (val&mask) ? 0xFF : 0;
mask = mask >> 1;
px += 4;
}
pxs++;
px = pxs;
}
if (st == SANE_STATUS_EOF)
break;
for (bit = 0; bit < 8 && px < pxmax; bit++)
{
((UINT8**)(im->image32))[py][px] = 0;
px += 4;
}
px -= 3;
if (px >= pxmax)
{
bufpos += padbytes;
len -= padbytes;
py++;
px = 0;
}
}
break;
case 8:
case 16:
if (p.depth == 8)
{
padbytes = p.bytes_per_line - 3 * im->xsize;
bufpos = 0;
incr = 1;
}
else
{
padbytes = p.bytes_per_line - 6 * im->xsize;
bufpos = endian.c[0];
incr = 2;
}
remain = p.bytes_per_line * im->ysize;
len = 0;
lastlen = 0;
pxmax = 4 * im->xsize;
/* probably not very efficient. But we have to deal with these
possible conditions:
- we may have padding bytes at the end of a scan line
- the number of bytes read with sane_read may be smaller
than the number of pad bytes
- the buffer may become empty after setting any of the
red/green/blue pixel values
*/
while (st != SANE_STATUS_EOF && py < im->ysize)
{
for (color = 0; color < 3; color++)
{
while (len <= 0 && st == SANE_STATUS_GOOD)
{
bufpos -= lastlen;
if (remain == 0)
{
sane_cancel(self->h);
Py_BLOCK_THREADS
PyErr_SetString(ErrorObject, "internal _sane error: premature end of scan");
return NULL;
}
st = sane_read(self->h, buffer,
remain<(READSIZE) ? remain : (READSIZE), &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
lastlen = len;
remain -= len;
len -= bufpos;
}
if (st == SANE_STATUS_EOF) break;
((UINT8**)(im->image32))[py][px++] = buffer[bufpos];
bufpos += incr;
len -= incr;
}
if (st == SANE_STATUS_EOF) break;
((UINT8**)(im->image32))[py][px++] = 0;
if (px >= pxmax)
{
px = 0;
py++;
bufpos += padbytes;
len -= padbytes;
}
}
break;
default:
Py_BLOCK_THREADS
sane_cancel(self->h);
snprintf(errmsg, 80, "unsupported pixel depth: %i", p.depth);
PyErr_SetString(ErrorObject, errmsg);
return NULL;
}
}
else /* should be SANE_FRAME_RED, GREEN or BLUE */
{
int lastlen, pxa, pxmax, offset, incr, frame_count = 0;
/* at least the Sane test backend behaves a bit weird, if
it returns "premature EOF" for sane_read, i.e., if the
option "return value of sane_read" is set to SANE_STATUS_EOF.
In this case, the test backend does not advance to the next frame,
so p.last_frame will never be set...
So let's count the number of frames we try to acquire
*/
while (!p.last_frame && frame_count < 4)
{
frame_count++;
st = sane_get_parameters(self->h, &p);
if (st)
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
remain = p.bytes_per_line * im->ysize;
bufpos = 0;
len = 0;
lastlen = 0;
py = 0;
switch (p.format)
{
case SANE_FRAME_RED:
offset = 0;
break;
case SANE_FRAME_GREEN:
offset = 1;
break;
case SANE_FRAME_BLUE:
offset = 2;
break;
default:
sane_cancel(self->h);
Py_BLOCK_THREADS
snprintf(errmsg, 80, "unknown/invalid frame format: %i", p.format);
PyErr_SetString(ErrorObject, errmsg);
return NULL;
}
px = offset;
pxa = 3;
pxmax = im->xsize * 4;
switch (p.depth)
{
case 1:
padbytes = p.bytes_per_line - (im->xsize+7)/8;
st = SANE_STATUS_GOOD;
while (st != SANE_STATUS_EOF && py < im->ysize)
{
while (len > 0)
{
int bit, mask, val;
val = buffer[bufpos++]; len--;
mask = 0x80;
for (bit = 0; bit < 8 && px < pxmax; bit++)
{
((UINT8**)(im->image32))[py][px]
= val&mask ? 0xFF : 0;
((UINT8**)(im->image32))[py][pxa] = 0;
px += 4;
pxa += 4;
mask = mask >> 1;
}
if (px >= pxmax)
{
px = offset;
pxa = 3;
py++;
bufpos += padbytes;
len -= padbytes;
}
}
while (len <= 0 && st == SANE_STATUS_GOOD && remain > 0)
{
bufpos -= lastlen;
st = sane_read(self->h, buffer,
remain<(READSIZE) ? remain : (READSIZE), &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
remain -= len;
lastlen = len;
len -= bufpos;
}
}
break;
case 8:
case 16:
if (p.depth == 8)
{
padbytes = p.bytes_per_line - im->xsize;
incr = 1;
}
else
{
padbytes = p.bytes_per_line - 2 * im->xsize;
incr = 2;
bufpos = endian.c[0];
}
st = SANE_STATUS_GOOD;
while (st != SANE_STATUS_EOF && py < im->ysize)
{
while (len <= 0)
{
bufpos -= lastlen;
if (remain == 0)
{
sane_cancel(self->h);
Py_BLOCK_THREADS
PyErr_SetString(ErrorObject, "internal _sane error: premature end of scan");
return NULL;
}
st = sane_read(self->h, buffer,
remain<(READSIZE) ? remain : (READSIZE), &len);
if (st && (st!=SANE_STATUS_EOF))
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
if (st == SANE_STATUS_EOF)
break;
lastlen = len;
remain -= len;
if (bufpos >= len)
len = 0;
else
len -= bufpos;
}
if (st == SANE_STATUS_EOF)
break;
((UINT8**)(im->image32))[py][px] = buffer[bufpos];
((UINT8**)(im->image32))[py][pxa] = 0;
bufpos += incr;
len -= incr;
px += 4;
pxa += 4;
if (px >= pxmax)
{
px = offset;
pxa = 3;
py++;
bufpos += padbytes;
len -= padbytes;
}
}
break;
default:
sane_cancel(self->h);
Py_BLOCK_THREADS
snprintf(errmsg, 80, "unsupported pixel depth: %i", p.depth);
PyErr_SetString(ErrorObject, errmsg);
return NULL;
}
if (!p.last_frame)
{
/* all sane_read calls in the above loop may return
SANE_STATUS_GOOD, but the backend may need another sane_read
call which returns SANE_STATUS_EOF in order to start
a new frame.
*/
do {
st = sane_read(self->h, buffer, READSIZE, &len);
}
while (st == SANE_STATUS_GOOD);
if (st != SANE_STATUS_EOF)
{
Py_BLOCK_THREADS
sane_cancel(self->h);
return PySane_Error(st);
}
st = sane_start(self->h);
if (st)
{
Py_BLOCK_THREADS
return PySane_Error(st);
}
}
}
}
/* enforce SANE_STATUS_EOF. Can be necessary for ADF scans for some backends */
do {
st = sane_read(self->h, buffer, READSIZE, &len);
}
while (st == SANE_STATUS_GOOD);
if (st != SANE_STATUS_EOF)
{
sane_cancel(self->h);
Py_BLOCK_THREADS
return PySane_Error(st);
}
if (!noCancel)
sane_cancel(self->h);
Py_BLOCK_THREADS
Py_INCREF(Py_None);
return Py_None;
}
#ifdef WITH_NUMARRAY
#include "numarray/libnumarray.h"
/* this global variable is set to 1 in 'init_sane()' after successfully
importing the numarray module. */
int NUMARRAY_IMPORTED = 0;
static PyObject *
SaneDev_arr_snap(SaneDevObject *self, PyObject *args)
{
SANE_Status st;
SANE_Byte buffer[READSIZE];
SANE_Int len;
SANE_Parameters p;
PyArrayObject *pyArr = NULL;
NumarrayType arrType;
int line, line_index, buffer_index, remain_bytes_line, num_pad_bytes;
int cp_num_bytes, total_remain, bpp, arr_bytes_per_line;
int pixels_per_line = -1;
char errmsg[80];
if (!NUMARRAY_IMPORTED)
{
PyErr_SetString(ErrorObject, "numarray package not available");
return NULL;
}
if (!PyArg_ParseTuple(args, "|i", &pixels_per_line))
return NULL;
if (self->h==NULL)
{
PyErr_SetString(ErrorObject, "SaneDev object is closed");
return NULL;
}
sane_get_parameters(self->h, &p);
if (p.format != SANE_FRAME_GRAY)
{
sane_cancel(self->h);
snprintf(errmsg, 80, "numarray only supports gray-scale images");
PyErr_SetString(ErrorObject, errmsg);
return NULL;
}
if (p.depth == 8)
{
bpp=1; /* bytes-per-pixel */
arrType = tUInt8;
}
else if (p.depth == 16)
{
bpp=2; /* bytes-per-pixel */
arrType = tUInt16;
}
else
{
sane_cancel(self->h);
snprintf(errmsg, 80, "arrsnap: unsupported pixel depth: %i", p.depth);
PyErr_SetString(ErrorObject, errmsg);
return NULL;
}
if (pixels_per_line < 1)
/* The user can choose a smaller result array than the actual scan */
pixels_per_line = p.pixels_per_line;
else
if (pixels_per_line > p.pixels_per_line)
{
PyErr_SetString(ErrorObject,"given pixels_per_line too big");
return NULL;
}
/* important: NumArray have indices like (y, x) !! */
if (!(pyArr = NA_NewArray(NULL, arrType, 2, p.lines, pixels_per_line)))
{
PyErr_SetString(ErrorObject, "failed to create NumArray object");
return NULL;
}
arr_bytes_per_line = pixels_per_line * bpp;
st=SANE_STATUS_GOOD;
#ifdef WRITE_PGM
FILE *fp;
fp = fopen("sane_p5.pgm", "w");
fprintf(fp, "P5\n%d %d\n%d\n", p.pixels_per_line,
p.lines, (int) pow(2.0, (double) p.depth)-1);
#endif
line_index = line = 0;
remain_bytes_line = arr_bytes_per_line;
total_remain = p.bytes_per_line * p.lines;
num_pad_bytes = p.bytes_per_line - arr_bytes_per_line;
while (st!=SANE_STATUS_EOF)
{
Py_BEGIN_ALLOW_THREADS
st = sane_read(self->h, buffer,
READSIZE < total_remain ? READSIZE : total_remain, &len);
Py_END_ALLOW_THREADS
#ifdef WRITE_PGM
printf("p5_write: read %d of %d\n", len, READSIZE);
fwrite(buffer, 1, len, fp);
#endif
buffer_index = 0;
total_remain -= len;
while (len > 0)
{
/* copy at most the number of bytes that fit into (the rest of)
one line: */
cp_num_bytes = (len > remain_bytes_line ? remain_bytes_line : len);
remain_bytes_line -= cp_num_bytes;
len -= cp_num_bytes;
#ifdef DEBUG
printf("copying %d bytes from b_idx %d to d_idx %d\n",
cp_num_bytes, buffer_index,
line * arr_bytes_per_line + line_index);
printf("len is now %d\n", len);
#endif
memcpy(pyArr->data + line * arr_bytes_per_line + line_index,
buffer + buffer_index, cp_num_bytes);
buffer_index += cp_num_bytes;
if (remain_bytes_line ==0)
{
/* The line has been completed, so reinitialize remain_bytes_line
increase the line counter, and reset line_index */
#ifdef DEBUG
printf("line %d full, skipping %d bytes\n",line,num_pad_bytes);
#endif
remain_bytes_line = arr_bytes_per_line;
line++;
line_index = 0;
/* Skip the number of bytes in the input stream which
are not used: */
len -= num_pad_bytes;
buffer_index += num_pad_bytes;
}
else
line_index += cp_num_bytes;
}
}
#ifdef WRITE_PGM
fclose(fp);
printf("p5_write finished\n");
#endif
sane_cancel(self->h);
return (PyObject*) pyArr;
}
#endif /* WITH_NUMARRAY */
static PyMethodDef SaneDev_methods[] = {
{"get_parameters", (PyCFunction)SaneDev_get_parameters, 1},
{"get_options", (PyCFunction)SaneDev_get_options, 1},
{"get_option", (PyCFunction)SaneDev_get_option, 1},
{"set_option", (PyCFunction)SaneDev_set_option, 1},
{"set_auto_option", (PyCFunction)SaneDev_set_auto_option, 1},
{"start", (PyCFunction)SaneDev_start, 1},
{"cancel", (PyCFunction)SaneDev_cancel, 1},
{"snap", (PyCFunction)SaneDev_snap, 1},
#ifdef WITH_NUMARRAY
{"arr_snap", (PyCFunction)SaneDev_arr_snap, 1},
#endif /* WITH_NUMARRAY */
{"fileno", (PyCFunction)SaneDev_fileno, 1},
{"close", (PyCFunction)SaneDev_close, 1},
{NULL, NULL} /* sentinel */
};
static PyObject *
SaneDev_getattr(SaneDevObject *self, char *name)
{
return Py_FindMethod(SaneDev_methods, (PyObject *)self, name);
}
staticforward PyTypeObject SaneDev_Type = {
PyObject_HEAD_INIT(&PyType_Type)
0, /*ob_size*/
"SaneDev", /*tp_name*/
sizeof(SaneDevObject), /*tp_basicsize*/
0, /*tp_itemsize*/
/* methods */
(destructor)SaneDev_dealloc, /*tp_dealloc*/
0, /*tp_print*/
(getattrfunc)SaneDev_getattr, /*tp_getattr*/
0, /*tp_setattr*/
0, /*tp_compare*/
0, /*tp_repr*/
0, /*tp_as_number*/
0, /*tp_as_sequence*/
0, /*tp_as_mapping*/
0, /*tp_hash*/
};
/* --------------------------------------------------------------------- */
static PyObject *
PySane_init(PyObject *self, PyObject *args)
{
SANE_Status st;
SANE_Int version;
if (!PyArg_ParseTuple(args, ""))
return NULL;
/* XXX Authorization is not yet supported */
st=sane_init(&version, NULL);
if (st) return PySane_Error(st);
return Py_BuildValue("iiii", version, SANE_VERSION_MAJOR(version),
SANE_VERSION_MINOR(version), SANE_VERSION_BUILD(version));
}
static PyObject *
PySane_exit(PyObject *self, PyObject *args)
{
if (!PyArg_ParseTuple(args, ""))
return NULL;
sane_exit();
Py_INCREF(Py_None);
return Py_None;
}
static PyObject *
PySane_get_devices(PyObject *self, PyObject *args)
{
SANE_Device **devlist;
SANE_Device *dev;
SANE_Status st;
PyObject *list;
int local_only, i;
if (!PyArg_ParseTuple(args, "|i", &local_only))
{
return NULL;
}
st=sane_get_devices(&devlist, local_only);
if (st) return PySane_Error(st);
if (!(list = PyList_New(0)))
return NULL;
for(i=0; devlist[i]!=NULL; i++)
{
dev=devlist[i];
PyList_Append(list, Py_BuildValue("ssss", dev->name, dev->vendor,
dev->model, dev->type));
}
return list;
}
/* Function returning new SaneDev object */
static PyObject *
PySane_open(PyObject *self, PyObject *args)
{
SaneDevObject *rv;
SANE_Status st;
char *name;
if (!PyArg_ParseTuple(args, "s", &name))
return NULL;
rv = newSaneDevObject();
if ( rv == NULL )
return NULL;
st = sane_open(name, &(rv->h));
if (st)
{
Py_DECREF(rv);
return PySane_Error(st);
}
return (PyObject *)rv;
}
static PyObject *
PySane_OPTION_IS_ACTIVE(PyObject *self, PyObject *args)
{
SANE_Int cap;
long lg;
if (!PyArg_ParseTuple(args, "i", &lg))
return NULL;
cap=lg;
return PyInt_FromLong( SANE_OPTION_IS_ACTIVE(cap));
}
static PyObject *
PySane_OPTION_IS_SETTABLE(PyObject *self, PyObject *args)
{
SANE_Int cap;
long lg;
if (!PyArg_ParseTuple(args, "i", &lg))
return NULL;
cap=lg;
return PyInt_FromLong( SANE_OPTION_IS_SETTABLE(cap));
}
/* List of functions defined in the module */
static PyMethodDef PySane_methods[] = {
{"init", PySane_init, 1},
{"exit", PySane_exit, 1},
{"get_devices", PySane_get_devices, 1},
{"_open", PySane_open, 1},
{"OPTION_IS_ACTIVE", PySane_OPTION_IS_ACTIVE, 1},
{"OPTION_IS_SETTABLE", PySane_OPTION_IS_SETTABLE, 1},
{NULL, NULL} /* sentinel */
};
static void
insint(PyObject *d, char *name, int value)
{
PyObject *v = PyInt_FromLong((long) value);
if (!v || PyDict_SetItemString(d, name, v))
Py_FatalError("can't initialize sane module");
Py_DECREF(v);
}
void
init_sane(void)
{
PyObject *m, *d;
/* Create the module and add the functions */
m = Py_InitModule("_sane", PySane_methods);
/* Add some symbolic constants to the module */
d = PyModule_GetDict(m);
ErrorObject = PyString_FromString("_sane.error");
PyDict_SetItemString(d, "error", ErrorObject);
insint(d, "INFO_INEXACT", SANE_INFO_INEXACT);
insint(d, "INFO_RELOAD_OPTIONS", SANE_INFO_RELOAD_OPTIONS);
insint(d, "RELOAD_PARAMS", SANE_INFO_RELOAD_PARAMS);
insint(d, "FRAME_GRAY", SANE_FRAME_GRAY);
insint(d, "FRAME_RGB", SANE_FRAME_RGB);
insint(d, "FRAME_RED", SANE_FRAME_RED);
insint(d, "FRAME_GREEN", SANE_FRAME_GREEN);
insint(d, "FRAME_BLUE", SANE_FRAME_BLUE);
insint(d, "CONSTRAINT_NONE", SANE_CONSTRAINT_NONE);
insint(d, "CONSTRAINT_RANGE", SANE_CONSTRAINT_RANGE);
insint(d, "CONSTRAINT_WORD_LIST", SANE_CONSTRAINT_WORD_LIST);
insint(d, "CONSTRAINT_STRING_LIST", SANE_CONSTRAINT_STRING_LIST);
insint(d, "TYPE_BOOL", SANE_TYPE_BOOL);
insint(d, "TYPE_INT", SANE_TYPE_INT);
insint(d, "TYPE_FIXED", SANE_TYPE_FIXED);
insint(d, "TYPE_STRING", SANE_TYPE_STRING);
insint(d, "TYPE_BUTTON", SANE_TYPE_BUTTON);
insint(d, "TYPE_GROUP", SANE_TYPE_GROUP);
insint(d, "UNIT_NONE", SANE_UNIT_NONE);
insint(d, "UNIT_PIXEL", SANE_UNIT_PIXEL);
insint(d, "UNIT_BIT", SANE_UNIT_BIT);
insint(d, "UNIT_MM", SANE_UNIT_MM);
insint(d, "UNIT_DPI", SANE_UNIT_DPI);
insint(d, "UNIT_PERCENT", SANE_UNIT_PERCENT);
insint(d, "UNIT_MICROSECOND", SANE_UNIT_MICROSECOND);
insint(d, "CAP_SOFT_SELECT", SANE_CAP_SOFT_SELECT);
insint(d, "CAP_HARD_SELECT", SANE_CAP_HARD_SELECT);
insint(d, "CAP_SOFT_DETECT", SANE_CAP_SOFT_DETECT);
insint(d, "CAP_EMULATED", SANE_CAP_EMULATED);
insint(d, "CAP_AUTOMATIC", SANE_CAP_AUTOMATIC);
insint(d, "CAP_INACTIVE", SANE_CAP_INACTIVE);
insint(d, "CAP_ADVANCED", SANE_CAP_ADVANCED);
/* handy for checking array lengths: */
insint(d, "SANE_WORD_SIZE", sizeof(SANE_Word));
/* possible return values of set_option() */
insint(d, "INFO_INEXACT", SANE_INFO_INEXACT);
insint(d, "INFO_RELOAD_OPTIONS", SANE_INFO_RELOAD_OPTIONS);
insint(d, "INFO_RELOAD_PARAMS", SANE_INFO_RELOAD_PARAMS);
/* Check for errors */
if (PyErr_Occurred())
Py_FatalError("can't initialize module _sane");
#ifdef WITH_NUMARRAY
import_libnumarray();
if (PyErr_Occurred())
PyErr_Clear();
else
/* this global variable is declared just in front of the
arr_snap() function and should be set to 1 after
successfully importing the numarray module. */
NUMARRAY_IMPORTED = 1;
#endif /* WITH_NUMARRAY */
}
_______________________________________________
Image-SIG maillist - [email protected]
http://mail.python.org/mailman/listinfo/image-sig
