gimp/plug-ins/twain
Michael Natterer ecb0b58439 Changed the semantics of GIMP_EXTENSION and (to some extent) of
2003-06-19  Michael Natterer  <mitch@gimp.org>

	Changed the semantics of GIMP_EXTENSION and (to some extent)
	of GIMP_PLUGIN:

	The old meaning of EXTENSION was "I live in the toolbox" and
	PLUGIN meant "I take RUN-MODE,IMAGE,DRAWABLE args (but only if I
	am invoked interactively)". This is completely useless, since
	living in the toolbox means having "<Toolbox>" in the menu_path
	and taking RUN-MODE,IMAGE,DRAWABLE means just that, regardless of
	what type of procedure we are.

	The new meaning of GIMP_PLUGIN is just "I am an ordinary procedure,
	I am invoked, do my job and finish", while GIMP_EXTENSION means
	"I will install temporary procedures and I will keep running to
	keep them available".

	(A GIMP_EXTENSION *must* call gimp_extension_ack() now to tell the
	core that it's ready to run, or the core will block waiting for
	the message !!!).

	* configure.in: bumped version number to 1.3.16.

	* libgimpbase/gimpprotocol.h: increased protocol version number so
	old extensions will refuse to load.

	* app/gui/plug-in-commands.c (plug_in_run_cmd_callback): don't
	blindly pass RUN-MODE,IMAGE,DRAWABLE to GIMP_PLUGIN procedures but
	look at their parameters and pass them either RUN-MODE, or
	RUN-MODE,IMAGE, or RUN-MODE,IMAGE,DRAWABLE.

	* app/pdb/procedural_db.c: cleaned up, better error reporting,
	replaced an impossible error message by g_return_if_fail()

	* app/plug-in/plug-in-message.c (plug_in_handle_proc_install):
	better error messages.

	* app/plug-in/plug-in-params.c: allocate parameter arrays using
	g_new0() so we don't have to worry about uninitialized stuff
	later.

	* app/plug-in/plug-in-run.c (plug_in_run): wait for
	gimp_extension_ack() installation confirmation for ALL extensions,
	not just for automatically started ones.

	* app/plug-in/plug-ins.c: cleanup.

	* libgimp/gimp.[ch]: cleaned up and API-documented massively. Made
	all magic values given in the GPConfig message static and added
	accessor functions for them. Added gimp_tile_width()/height().
	Added new function gimp_extension_enable() which turns on
	asynchronous processing of temp_proc run requests without having
	to enter an endless gimp_extension_process() loop. Moved all
	private functions to the end of the file. Added tons of
	g_return_if_fail() all over the place.  Call gimp_run_procedure2()
	from gimp_run_procedure() instead of duplicating the
	code. Indentation, spacing, stuff...

	* libgimp/gimptile.[ch]: removed gimp_tile_width()/height().

	* libgimp/gimpdrawable.c
	* libgimp/gimppixelrgn.c
	* libgimp/gimptile.c: use the gimp_tile_width()/height() accessor
	functions.

	* libgimp/gimp.def: added gimp_extension_enable.

	* libgimp/gimpmenu.c: removed evil code which connected to
	_readchannel manually and use gimp_extension_enable() for watching
	temp_procs.

	* plug-ins/helpbrowser/helpbrowser.c: removed the same evil code
	here and call gimp_extension_enable(). Call gimp_extension_ack()
	to let the core know that the temp_proc is installed.

	* plug-ins/script-fu/script-fu.c: made all procedures except the
	permanently running "extension_script_fu" ordinary GIMP_PLUGIN
	procedures.

	* plug-ins/common/curve_bend.c
	* plug-ins/common/plugindetails.c
	* plug-ins/common/screenshot.c
	* plug-ins/common/uniteditor.c
	* plug-ins/common/winclipboard.c
	* plug-ins/dbbrowser/dbbrowser.c
	* plug-ins/gfli/gfli.c
	* plug-ins/twain/twain.c
	* plug-ins/webbrowser/webbrowser.c
	* plug-ins/winsnap/winsnap.c: made them all ordinary GIMP_PLUGIN
	procedures and renamed them from "extension_*" to "plug_in_*".
	Random cleanups.

	* app/widgets/gimphelp.c
	* plug-ins/maze/maze_face.c: call "plug_in_web_browser" now.
2003-06-19 17:12:00 +00:00
..
.cvsignore Shut up CVS. 2003-06-02 13:21:09 +00:00
Makefile.am Handle twain and winsnap subdirs normally. 2003-05-31 22:23:55 +00:00
README PLUGIN_MAINTAINERS plug-ins/twain/* Changed Craig Setera'a email address 2000-05-11 19:27:26 +00:00
tw_dump.c PLUGIN_MAINTAINERS plug-ins/twain/* Changed Craig Setera'a email address 2000-05-11 19:27:26 +00:00
tw_dump.h PLUGIN_MAINTAINERS plug-ins/twain/* Changed Craig Setera'a email address 2000-05-11 19:27:26 +00:00
tw_func.c PLUGIN_MAINTAINERS plug-ins/twain/* Changed Craig Setera'a email address 2000-05-11 19:27:26 +00:00
tw_func.h Turned C++ style comments into C style ones. 2000-09-26 22:54:33 +00:00
tw_sess.c PLUGIN_MAINTAINERS plug-ins/twain/* Changed Craig Setera'a email address 2000-05-11 19:27:26 +00:00
tw_util.c PLUGIN_MAINTAINERS plug-ins/twain/* Changed Craig Setera'a email address 2000-05-11 19:27:26 +00:00
tw_util.h Turned C++ style comments into C style ones. 2000-09-26 22:54:33 +00:00
twain.c Changed the semantics of GIMP_EXTENSION and (to some extent) of 2003-06-19 17:12:00 +00:00
twain.h Turned C++ style comments into C style ones. 2000-09-26 22:54:33 +00:00

README

TWAIN Plug-in
Copyright (C) 1999 Craig Setera
Craig Setera <setera@home.com>
03/31/1999

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.

Based on (at least) the following plug-ins:
Screenshot
GIF
Randomize

Any suggestions, bug-reports or patches are welcome.
 
This plug-in interfaces to the TWAIN support library in order
to capture images from TWAIN devices directly into GIMP images.
The plug-in is capable of acquiring the following type of
images:
 - B/W (1 bit images translated to grayscale B/W)
 - Grayscale up to 16 bits per pixel
 - RGB up to 16 bits per sample (24, 30, 36, etc.)
 - Paletted images (both Gray and RGB)

Prerequisites:
 This plug-in will not compile on anything other than a Win32
 platform.  Although the TWAIN documentation implies that there
 is TWAIN support available on Macintosh, I neither have a 
 Macintosh nor the interest in porting this.  If anyone else
 has an interest, consult www.twain.org for more information on
 interfacing to TWAIN.

Known problems:

 - Multiple image transfers will hang the plug-in.  The current
   configuration compiles with a maximum of single image transfers.

Debugging:
 There are two different versions of the program included, a standard
 version and a version built for debugging.  The debugging version is
 a special version capable of capturing the TWAIN datasource data to
 a file for later processing.  This feature can be used to create a data
 dump that can be sent to me if for some reason the plug-in fails for
 your TWAIN datasource.  The function of the plug-in is controlled by
 the name of the executable file.  The plug-in should be placed in your
 plug-ins directory and named as follows:

twain.exe - This is the standard (non-debugging) version.  This file will
  not behave differently if renamed.  This version is intended to be used
  unless your TWAIN datasource has some problem.

gtwain.exe - This is the debugging version of the program shipped along.
  If this program is used as named, it will behave the same as "twain.exe"
  except that the file C:\twain.log will be written.  This file is a text
  file with very little information available for debugging.

dtwain.exe - Renaming "gtwain.exe" to "dtwain.exe" in your plug-ins directory
  will change the behavior of the plug-in.  The menu option will be registered
  as "TWAIN Acquire (Dump)..." and will cause the TWAIN acquire operation to
  be dumped to the file "C:\twaincap.bin".  This file contains all of the data
  necessary to recreate the capture on another system (such as my machine).  The
  image will not be displayed, as it might cause the plug-in to crash making
  the data useless.  Instead, a message will be displayed that the image
  information was dumped to a file.

rtwain.exe - Renaming "gtwain.exe" to "rtwain.exe" in your plug-ins directory
  will change the behavior of the plug-in.  The menu option will be registered
  as "TWAIN Acquire (Read)..." and will cause the TWAIN acquire operation to
  read a previously dumped (using dtwain.exe) TWAIN acquire from 
  "C:\twaincap.bin".

If you find that you are unable to capture data from you datasource (the plug-in
crashes or the image is wrong), please capture data using the following steps:

1) Copy gtwain.exe to your plug-ins directory as "dtwain.exe".
2) Run The GIMP.
3) Choose Xtns->TWAIN Acquire (Dump)...
4) Choose the datasource settings that are causing problems.
5) Choose a *SMALL* sample image.
6) Zip up "C:\twaincap.bin" and "C:\twain.log" and send them to me.