twain.c 30.3 KB
Newer Older
1 2 3
/*  
 * TWAIN Plug-in
 * Copyright (C) 1999 Craig Setera
4
 * Craig Setera <setera@home.com>
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
 * 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.
 */

/* 
 * Revision history
 *  (02/07/99)  v0.1   First working version (internal)
 *  (02/09/99)  v0.2   First release to anyone other than myself
 *  (02/15/99)  v0.3   Added image dump and read support for debugging
 *  (03/31/99)  v0.5   Added support for multi-byte samples and paletted 
 *                     images.
 */
Tor Lillqvist's avatar
Tor Lillqvist committed
59 60
#include "config.h"

61 62 63 64 65 66 67
#include <glib.h>		/* Needed when compiling with gcc */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <windows.h>
Tor Lillqvist's avatar
Tor Lillqvist committed
68

69
#include "libgimp/gimp.h"
Tor Lillqvist's avatar
Tor Lillqvist committed
70 71
#include "libgimp/stdplugins-intl.h"

72 73 74 75 76 77 78 79 80 81 82
#include "tw_func.h"
#include "tw_util.h"

#ifdef _DEBUG
#include "tw_dump.h"
#endif /* _DEBUG */

/*
 * Plug-in Definitions
 */
#define PLUG_IN_NAME        "twain-acquire"
Marc Lehmann's avatar
Marc Lehmann committed
83 84
#define PLUG_IN_DESCRIPTION "Capture an image from a TWAIN datasource"
#define PLUG_IN_HELP        "This plug-in will capture an image from a TWAIN datasource"
85
#define PLUG_IN_AUTHOR      "Craig Setera (setera@home.com)"
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
#define PLUG_IN_COPYRIGHT   "Craig Setera"
#define PLUG_IN_VERSION     "v0.5 (03/31/1999)"

#ifdef _DEBUG
#define PLUG_IN_D_NAME        "twain-acquire-dump"
#define PLUG_IN_D_MENU_PATH   "<Toolbox>/File/Acquire/TWAIN (Dump)..."

#define PLUG_IN_R_NAME        "twain-acquire-read"
#define PLUG_IN_R_MENU_PATH   "<Toolbox>/File/Acquire/TWAIN (Read)..."
#endif /* _DEBUG */

/*
 * Application definitions
 */
#define APP_NAME "TWAIN"
#define MAX_IMAGES 1
#define SHOW_WINDOW 0
#define WM_TRANSFER_IMAGE (WM_USER + 100)

/*
 * Definition of the run states 
 */
#define RUN_STANDARD 0
#define RUN_DUMP 1
#define RUN_READDUMP 2

/* Global variables */
pTW_SESSION twSession = NULL;

static HWND        hwnd = NULL;
static HINSTANCE   hInst = NULL;
static char        *destBuf = NULL;
static int         twain_run_mode = RUN_STANDARD;

/* Forward declarations */
void preTransferCallback(void *);
int  beginTransferCallback(pTW_IMAGEINFO, void *);
int  dataTransferCallback(pTW_IMAGEINFO, pTW_IMAGEMEMXFER, void *);
int  endTransferCallback(int, int, void *);
void postTransferCallback(int, void *);

127 128 129 130 131 132 133 134
static void init  (void);
static void quit  (void);
static void query (void);
static void run   (const gchar      *name,
		   gint              nparams,
		   const GimpParam  *param,
		   gint             *nreturn_vals,
		   GimpParam       **return_vals);
135 136

/* This plug-in's functions */
137
GimpPlugInInfo PLUG_IN_INFO =
138 139 140 141 142 143 144
{
  NULL,    /* init_proc */
  NULL,    /* quit_proc */
  query,   /* query_proc */
  run,     /* run_proc */
};
	
145
extern void set_gimp_PLUG_IN_INFO_PTR(GimpPlugInInfo *);
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

LRESULT CALLBACK WndProc(HWND, UINT, WPARAM, LPARAM);

/* Data structure holding data between runs */
/* Currently unused... Eventually may be used
 * to track dialog data.
 */
typedef struct {
  gchar  sourceName[34];
  gfloat xResolution;
  gfloat yResolution;
  gint   xOffset;
  gint   yOffset;
  gint   width;
  gint   height;
  gint   imageType;
} TwainValues;

/* Default Twain values */
static TwainValues twainvals = 
{ 
  "",
  100.0, 100.0,
  0, 0,
  0, 0,
  TWPT_RGB
};

/* The standard callback functions */
TXFR_CB_FUNCS standardCbFuncs = {
  preTransferCallback,
  beginTransferCallback,
  dataTransferCallback,
  endTransferCallback,
  postTransferCallback };

/******************************************************************
 * Dump handling
 ******************************************************************/

#ifdef _DEBUG
/* The dumper callback functions */
TXFR_CB_FUNCS dumperCbFuncs = {
  dumpPreTransferCallback,
  dumpBeginTransferCallback,
  dumpDataTransferCallback,
  dumpEndTransferCallback,
  dumpPostTransferCallback };

static void
setRunMode(char *argv[])
{
  char *exeName = strrchr(argv[0], '\\') + 1;

  LogMessage("Executable name: %s\n", exeName);

  if (!_stricmp(exeName, "DTWAIN.EXE"))
    twain_run_mode = RUN_DUMP;

  if (!_stricmp(exeName, "RTWAIN.EXE"))
    twain_run_mode = RUN_READDUMP;
}
#endif /* _DEBUG */
	
/******************************************************************
 * Win32 entry point and setup...
 ******************************************************************/
	
/*
 * WinMain
 *
 * The standard gimp entry point won't quite cut it for
 * this plug-in.  This plug-in requires creation of a
 * standard Win32 window (hidden) in order to receive
 * and process window messages on behalf of the TWAIN
 * datasource.
 */
int APIENTRY 
WinMain(HINSTANCE hInstance,
	HINSTANCE hPrevInstance,
	LPSTR     lpCmdLine,
	int       nCmdShow)
{
		
  /* 
   * Normally, we would do all of the Windows-ish set up of
   * the window classes and stuff here in WinMain.  But,
   * the only time we really need the window and message
   * queues is during the plug-in run.  So, all of that will
   * be done during run().  This avoids all of the Windows
   * setup stuff for the query().  Stash the instance handle now
   * so it is available from the run() procedure.
   */
  hInst = hInstance;

#ifdef _DEBUG
  /* When in debug version, we allow different run modes...
   * make sure that it is correctly set.
   */
  setRunMode(__argv);
#endif /* _DEBUG */

  /*
   * Now, call gimp_main... This is what the MAIN() macro
   * would usually do.
   */
Hans Breuer's avatar
Hans Breuer committed
252
  return gimp_main(&PLUG_IN_INFO, __argc, __argv);
253
}
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272

/*
 * main
 *
 * allow to build as console app as well
 */
int main (int argc, char *argv[])
{
#ifdef _DEBUG
  /* When in debug version, we allow different run modes...
   * make sure that it is correctly set.
   */
  setRunMode(__argv);
#endif /* _DEBUG */

  /*
   * Now, call gimp_main... This is what the MAIN() macro
   * would usually do.
   */
Hans Breuer's avatar
Hans Breuer committed
273
  return gimp_main(&PLUG_IN_INFO, __argc, __argv);
274
}
275 276 277 278 279 280 281 282 283 284
	
/*
 * initTwainAppIdentity
 *
 * Initialize and return our application's identity for
 * the TWAIN runtime.
 */
static pTW_IDENTITY
getAppIdentity(void)
{
285
  pTW_IDENTITY appIdentity = g_new (TW_IDENTITY, 1);
286 287 288 289 290 291 292
		
  /* Set up the application identity */
  appIdentity->Id = 0;
  appIdentity->Version.MajorNum = 0;
  appIdentity->Version.MinorNum = 1;
  appIdentity->Version.Language = TWLG_USA;
  appIdentity->Version.Country = TWCY_USA;
Tor Lillqvist's avatar
Tor Lillqvist committed
293
  strcpy(appIdentity->Version.Info, "GIMP TWAIN 0.5");
294 295 296 297 298
  appIdentity->ProtocolMajor = TWON_PROTOCOLMAJOR;
  appIdentity->ProtocolMinor = TWON_PROTOCOLMINOR;
  appIdentity->SupportedGroups = DG_IMAGE;
  strcpy(appIdentity->Manufacturer, "Craig Setera");
  strcpy(appIdentity->ProductFamily, "GIMP");
Tor Lillqvist's avatar
Tor Lillqvist committed
299
  strcpy(appIdentity->ProductName, "GIMP for Win32");
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
		
  return appIdentity;
}
	
/*
 * initializeTwain
 *
 * Do the necessary TWAIN initialization.  This sets up
 * our TWAIN session information.  The session stuff is
 * something built by me on top of the standard TWAIN
 * datasource manager calls.
 */
void
initializeTwain(void)
{
  pTW_IDENTITY appIdentity;
		
  /* Get our application's identity */
  appIdentity = getAppIdentity();
		
  /* Create a new session object */
  twSession = newSession(appIdentity);
		
  /* Register our image transfer callback functions */
#ifdef _DEBUG
  if (twain_run_mode == RUN_DUMP)
    registerTransferCallbacks(twSession, &dumperCbFuncs, NULL);
  else
#endif /* _DEBUG */
    registerTransferCallbacks(twSession, &standardCbFuncs, NULL);
}
	
/*
 * InitApplication
 *
 * Initialize window data and register the window class
 */
BOOL 
InitApplication(HINSTANCE hInstance)
{
  WNDCLASS wc;
  BOOL retValue;
		
  /*
   * Fill in window class structure with parameters to describe
   * the main window.
   */
  wc.style = CS_HREDRAW | CS_VREDRAW;
  wc.lpfnWndProc = (WNDPROC) WndProc;
  wc.cbClsExtra = 0;
  wc.cbWndExtra = 0;
  wc.hInstance = hInstance;
  wc.hIcon = LoadIcon(NULL, IDI_APPLICATION);
  wc.hCursor = LoadCursor(NULL, IDC_ARROW);
  wc.hbrBackground = (HBRUSH) (COLOR_WINDOW + 1);
  wc.lpszClassName = APP_NAME;
  wc.lpszMenuName = NULL;
		
  /* Register the window class and stash success/failure code. */
  retValue = RegisterClass(&wc);
		
  /* Log error */
  if (!retValue)
    LogLastWinError();
		
  return retValue;
}
	
/*
 * InitInstance
 * 
 * Create the main window for the application.  Used to
 * interface with the TWAIN datasource.
 */
BOOL 
InitInstance(HINSTANCE hInstance, int nCmdShow)
{
  /* Create our window */
  hwnd = CreateWindow(APP_NAME, APP_NAME, WS_OVERLAPPEDWINDOW,
		      CW_USEDEFAULT, 0, CW_USEDEFAULT, 0,
		      NULL, NULL, hInstance, NULL);
		
  if (!hwnd) {
    return (FALSE);
  }
		
  ShowWindow(hwnd, nCmdShow);
  UpdateWindow(hwnd);
		
  return TRUE;
}
	
/*
 * twainWinMain
 *
 * This is the function that represents the code that
 * would normally reside in WinMain (see above).  This
 * function will get called during run() in order to set
 * up the windowing environment necessary for TWAIN to
 * operate.
 */
int
twainWinMain(void) 
{
		
  /* Initialize the twain information */
  initializeTwain();
		
  /* Perform instance initialization */
  if (!InitApplication(hInst))
    return (FALSE);
		
  /* Perform application initialization */
  if (!InitInstance(hInst, SHOW_WINDOW))
    return (FALSE);
		
  /* 
   * Call the main message processing loop...
   * This call will not return until the application
   * exits.
   */
  return twainMessageLoop(twSession);
}
	
/*
 * WndProc
 *
 * Process window message for the main window.
 */
LRESULT CALLBACK 
WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
  switch (message) {
			
  case WM_CREATE:
    /* Register our window handle with the TWAIN
     * support.
     */
    registerWindowHandle(twSession, hWnd);
			
    /* Schedule the image transfer by posting a message */
    PostMessage(hWnd, WM_TRANSFER_IMAGE, 0, 0);
    break;
			
  case WM_TRANSFER_IMAGE:
    /* Get an image */
#ifdef _DEBUG
    if (twain_run_mode == RUN_READDUMP)
      readDumpedImage(twSession);
    else
#endif /* _DEBUG */
      getImage(twSession);
    break;
			
  case WM_DESTROY:
    LogMessage("Exiting application\n");
    PostQuitMessage(0);
    break;
			
  default:
    return (DefWindowProc(hWnd, message, wParam, lParam));
  }
  return 0;
}
	
/******************************************************************
 * GIMP Plug-in entry points
 ******************************************************************/
	
/*
 * Plug-in Parameter definitions
 */
#define NUMBER_IN_ARGS 1
473
#define IN_ARGS { GIMP_PDB_INT32, "run_mode", "Interactive, non-interactive" }
474 475
#define NUMBER_OUT_ARGS 2
#define OUT_ARGS \
476 477
	{ GIMP_PDB_INT32, "image_count", "Number of acquired images" }, \
	{ GIMP_PDB_INT32ARRAY, "image_ids", "Array of acquired image identifiers" }
478 479 480 481 482 483 484 485 486

	
/*
 * query
 *
 * The plug-in is being queried.  Install our procedure for
 * acquiring.
 */
static void 
487
query (void)
488
{
489 490
  static GimpParamDef args[] = { IN_ARGS };
  static GimpParamDef return_vals[] = { OUT_ARGS };
491 492 493 494 495 496 497 498 499 500 501 502

#ifdef _DEBUG
  if (twain_run_mode == RUN_DUMP)
    /* the installation of the plugin */
    gimp_install_procedure(PLUG_IN_D_NAME,
			   PLUG_IN_DESCRIPTION,
			   PLUG_IN_HELP,
			   PLUG_IN_AUTHOR,
			   PLUG_IN_COPYRIGHT,
			   PLUG_IN_VERSION,
			   PLUG_IN_D_MENU_PATH,
			   NULL,
503
			   GIMP_PLUGIN,
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
			   NUMBER_IN_ARGS,
			   NUMBER_OUT_ARGS,
			   args,
			   return_vals);

  else if (twain_run_mode == RUN_READDUMP)
    /* the installation of the plugin */
    gimp_install_procedure(PLUG_IN_R_NAME,
			   PLUG_IN_DESCRIPTION,
			   PLUG_IN_HELP,
			   PLUG_IN_AUTHOR,
			   PLUG_IN_COPYRIGHT,
			   PLUG_IN_VERSION,
			   PLUG_IN_R_MENU_PATH,
			   NULL,
519
			   GIMP_PLUGIN,
520 521 522 523 524 525 526 527 528 529 530 531 532
			   NUMBER_IN_ARGS,
			   NUMBER_OUT_ARGS,
			   args,
			   return_vals);
  else
#endif /* _DEBUG */
    /* the installation of the plugin */
    gimp_install_procedure(PLUG_IN_NAME,
			   PLUG_IN_DESCRIPTION,
			   PLUG_IN_HELP,
			   PLUG_IN_AUTHOR,
			   PLUG_IN_COPYRIGHT,
			   PLUG_IN_VERSION,
Sven Neumann's avatar
Sven Neumann committed
533
			   N_("<Toolbox>/File/Acquire/TWAIN..."),
534
			   NULL,
535
			   GIMP_PLUGIN,
536 537 538 539 540 541 542 543
			   NUMBER_IN_ARGS,
			   NUMBER_OUT_ARGS,
			   args,
			   return_vals);
}
	
	
/* Return values storage */
544
static GimpParam values[3];
545 546 547 548 549 550 551 552

/*
 * run
 *
 * The plug-in is being requested to run.
 * Capture an image from a TWAIN datasource
 */
static void 
553 554 555 556 557
run (const gchar      *name,
     gint              nparams,
     const GimpParam  *param,
     gint             *nreturn_vals,
     GimpParam       **return_vals)
558
{
559
  GimpRunMode run_mode;
560 561 562 563

  /* Initialize the return values
   * Always return at least the status to the caller. 
   */
564 565
  values[0].type = GIMP_PDB_STATUS;
  values[0].data.d_status = GIMP_PDB_SUCCESS;
566 567 568
  *nreturn_vals = 1;
  *return_vals = values;

569 570
  INIT_I18N ();

571 572 573 574 575
  /* Before we get any further, verify that we have
   * TWAIN and that there is actually a datasource
   * to be used in doing the acquire.
   */
  if (!twainIsAvailable()) {
576
    values[0].data.d_status = GIMP_PDB_EXECUTION_ERROR;
577 578 579 580 581 582 583
    return;
  }

  /* Get the runmode from the in-parameters */
  run_mode = param[0].data.d_int32;
		
  /* Set up the rest of the return parameters */
584
  values[1].type = GIMP_PDB_INT32;
585
  values[1].data.d_int32 = 0;
586
  values[2].type = GIMP_PDB_INT32ARRAY;
587
  values[2].data.d_int32array = g_new (gint32, MAX_IMAGES);
588 589 590
		
  /* How are we running today? */
  switch (run_mode) {
591
  case GIMP_RUN_INTERACTIVE:
592 593 594 595 596 597
    /* Retrieve values from the last run...
     * Currently ignored
     */
    gimp_get_data(PLUG_IN_NAME, &twainvals);
    break;
			
598
  case GIMP_RUN_NONINTERACTIVE:
599 600 601
    /* Currently, we don't do non-interactive calls.
     * Bail if someone tries to call us non-interactively
     */
602
    values[0].data.d_status = GIMP_PDB_CALLING_ERROR;
603 604
    return;
			
605
  case GIMP_RUN_WITH_LAST_VALS:
606 607 608 609 610 611 612 613 614 615 616
    /* Retrieve values from the last run...
     * Currently ignored
     */
    gimp_get_data(PLUG_IN_NAME, &twainvals);
    break;
			
  default:
    break;
  } /* switch */
		
  /* Have we succeeded so far? */
617
  if (values[0].data.d_status == GIMP_PDB_SUCCESS)
618 619 620 621 622 623 624 625 626 627
    twainWinMain();
		
  /* Check to make sure we got at least one valid
   * image.
   */
  if (values[1].data.d_int32 > 0) {
    /* An image was captured from the TWAIN
     * datasource.  Do final Interactive
     * steps.
     */
628
    if (run_mode == GIMP_RUN_INTERACTIVE) {
629 630 631 632 633 634 635
      /* Store variable states for next run */
      gimp_set_data(PLUG_IN_NAME, &twainvals, sizeof (TwainValues));
    }
			
    /* Set return values */
    *nreturn_vals = 3;
  } else {
636
    values[0].data.d_status = GIMP_PDB_EXECUTION_ERROR;
637 638 639 640 641 642 643 644 645 646 647 648 649
  }
}
	
/***********************************************************************
 * Image transfer callback functions
 ***********************************************************************/
	
/* Data used to carry data between each of
 * the callback function calls.
 */
typedef struct {
  gint32 image_id;
  gint32 layer_id;
650 651
  GimpPixelRgn pixel_rgn;
  GimpDrawable *drawable;
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
  pTW_PALETTE8 paletteData;
  int totalPixels;
  int completedPixels;
} ClientDataStruct, *pClientDataStruct;

/*
 * preTransferCallback
 *
 * This callback function is called before any images
 * are transferred.  Set up the one time only stuff.
 */
void
preTransferCallback(void *clientData)
{
  /* Initialize our progress dialog */
Tor Lillqvist's avatar
Tor Lillqvist committed
667
  gimp_progress_init(_("Transferring TWAIN data"));
668 669 670 671 672 673 674 675 676 677 678 679 680 681
}

/*
 * beginTransferCallback
 *
 * The following function is called at the beginning
 * of each image transfer.
 */
int
beginTransferCallback(pTW_IMAGEINFO imageInfo, void *clientData)
{
  int done = 0;
  int imageType, layerType;

682
  pClientDataStruct theClientData = g_new (ClientDataStruct, 1);
683 684 685 686 687 688 689 690 691 692

#ifdef _DEBUG		
  logBegin(imageInfo, clientData);
#endif
		
  /* Decide on the image type */
  switch (imageInfo->PixelType) {
  case TWPT_BW:
  case TWPT_GRAY:
    /* Set up the image and layer types */
693 694
    imageType = GIMP_GRAY;
    layerType = GIMP_GRAY_IMAGE;
695 696 697 698
    break;
			
  case TWPT_RGB:
    /* Set up the image and layer types */
699 700
    imageType = GIMP_RGB;
    layerType = GIMP_RGB_IMAGE;
701 702 703 704
    break;

  case TWPT_PALETTE:
    /* Get the palette data */
705
    theClientData->paletteData = g_new (TW_PALETTE8, 1);
706 707 708 709 710 711 712 713 714
    twSession->twRC = callDSM(APP_IDENTITY(twSession), DS_IDENTITY(twSession),
			      DG_IMAGE, DAT_PALETTE8, MSG_GET,
			      (TW_MEMREF) theClientData->paletteData);
    if (twSession->twRC != TWRC_SUCCESS)
      return FALSE;

    switch (theClientData->paletteData->PaletteType) {
    case TWPA_RGB:
      /* Set up the image and layer types */
715 716
      imageType = GIMP_RGB;
      layerType = GIMP_RGB_IMAGE;
717 718 719 720
      break;

    case TWPA_GRAY:
      /* Set up the image and layer types */
721 722
      imageType = GIMP_GRAY;
      layerType = GIMP_GRAY_IMAGE;
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
      break;

    default:
      return FALSE;
    }
    break;

  default:
    /* We don't know how to deal with anything other than
     * the types listed above.  Bail for any other image
     * type.
     */
    return FALSE;
  }
		
  /* Create the GIMP image */
  theClientData->image_id = gimp_image_new(imageInfo->ImageWidth, 
					   imageInfo->ImageLength, imageType);
			
  /* Create a layer */
  theClientData->layer_id = gimp_layer_new(theClientData->image_id,
Tor Lillqvist's avatar
Tor Lillqvist committed
744
					   _("Background"),
745 746
					   imageInfo->ImageWidth, 
					   imageInfo->ImageLength,
747
					   layerType, 100, GIMP_NORMAL_MODE);
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
		
  /* Add the layer to the image */
  gimp_image_add_layer(theClientData->image_id, 
		       theClientData->layer_id, 0);
		
  /* Update the progress dialog */
  theClientData->totalPixels = imageInfo->ImageWidth * imageInfo->ImageLength;
  theClientData->completedPixels = 0;
  gimp_progress_update((double) 0);
		
  /* Get our drawable */
  theClientData->drawable = gimp_drawable_get(theClientData->layer_id);
		
  /* Initialize a pixel region for writing to the image */
  gimp_pixel_rgn_init(&(theClientData->pixel_rgn), theClientData->drawable, 
		      0, 0, imageInfo->ImageWidth, imageInfo->ImageLength,
		      TRUE, FALSE);
		
  /* Store our client data for the data transfer callbacks */
  if (clientData)
768
    g_free (clientData);
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
  setClientData(twSession, (void *) theClientData);
		
  /* Make sure to return TRUE to continue the image
   * transfer
   */
  return TRUE;
}
	
/*
 * bitTransferCallback
 *
 * The following function is called for each memory
 * block that is transferred from the data source if
 * the image type is Black/White.
 *
 * Black and white data is unpacked from bit data
 * into byte data and written into a gray scale GIMP
 * image.
 */
static char bitMasks[] = { 128, 64, 32, 16, 8, 4, 2, 1 };
static int 
bitTransferCallback(pTW_IMAGEINFO imageInfo,
		    pTW_IMAGEMEMXFER imageMemXfer,
		    void *clientData)
{
  int row, col, offset;
  char *srcBuf;
  int rows = imageMemXfer->Rows;
  int cols = imageMemXfer->Columns;
  pClientDataStruct theClientData = (pClientDataStruct) clientData;
		
  /* Allocate a buffer as necessary */
  if (!destBuf)
802
    destBuf = g_new (char, rows * cols);
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
		
  /* Unpack the image data from bits into bytes */
  srcBuf = (char *) imageMemXfer->Memory.TheMem;
  offset = 0;
  for (row = 0; row < rows; row++) {
    for (col = 0; col < cols; col++) {
      char byte = srcBuf[(row * imageMemXfer->BytesPerRow) + (col / 8)];
      destBuf[offset++] = ((byte & bitMasks[col % 8]) != 0) ? 255 : 0;
    }
  }
		
  /* Update the complete chunk */
  gimp_pixel_rgn_set_rect(&(theClientData->pixel_rgn), 
			  (guchar *) destBuf,
			  imageMemXfer->XOffset, imageMemXfer->YOffset,
			  cols, rows);
		
  /* Update the user on our progress */
  theClientData->completedPixels += (cols * rows);
  gimp_progress_update((double) theClientData->completedPixels / 
		       (double) theClientData->totalPixels);
		
  return TRUE;
}
	
/*
 * oneBytePerSampleTransferCallback
 *
 * The following function is called for each memory
 * block that is transferred from the data source if
 * the image type is Grayscale or RGB.  This transfer
 * mode is quicker than the modes that require translation
 * from a greater number of bits per sample down to the
 * 8 bits per sample understood by The GIMP.
 */
static int 
oneBytePerSampleTransferCallback(pTW_IMAGEINFO imageInfo,
		     pTW_IMAGEMEMXFER imageMemXfer,
		     void *clientData)
{
  int row;
  char *srcBuf;
  int bytesPerPixel = imageInfo->BitsPerPixel / 8;
  int rows = imageMemXfer->Rows;
  int cols = imageMemXfer->Columns;
  pClientDataStruct theClientData = (pClientDataStruct) clientData;
		
  /* Allocate a buffer as necessary */
  if (!destBuf)
852
    destBuf = g_new (char, rows * cols * bytesPerPixel);
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
		
  /* The bytes coming from the source may not be padded in
   * a way that The GIMP is terribly happy with.  It is
   * possible to transfer row by row, but that is particularly
   * expensive in terms of performance.  It is much cheaper
   * to rearrange the data and transfer it in one large chunk.
   * The next chunk of code rearranges the incoming data into
   * a non-padded chunk for The GIMP.
   */
  srcBuf = (char *) imageMemXfer->Memory.TheMem;
  for (row = 0; row < rows; row++) {
    /* Copy the current row */
    memcpy((destBuf + (row * bytesPerPixel * cols)),
	   (srcBuf + (row * imageMemXfer->BytesPerRow)),
	   (bytesPerPixel * cols));
  }
		
  /* Update the complete chunk */
  gimp_pixel_rgn_set_rect(&(theClientData->pixel_rgn), 
			  (guchar *) destBuf,
			  imageMemXfer->XOffset, imageMemXfer->YOffset,
			  cols, rows);
		
  /* Update the user on our progress */
  theClientData->completedPixels += (cols * rows);
  gimp_progress_update((double) theClientData->completedPixels / 
		       (double) theClientData->totalPixels);
		
  return TRUE;
}
	
/*
 * twoBytesPerSampleTransferCallback
 *
 * The following function is called for each memory
 * block that is transferred from the data source if
 * the image type is Grayscale or RGB.
 */ 
static int 
twoBytesPerSampleTransferCallback(pTW_IMAGEINFO imageInfo,
		     pTW_IMAGEMEMXFER imageMemXfer,
		     void *clientData)
{
  static float ratio = 0.00390625;
  int row, col, sample;
  char *srcBuf, *destByte;
  int rows = imageMemXfer->Rows;
  int cols = imageMemXfer->Columns;
  int bitsPerSample = imageInfo->BitsPerPixel / imageInfo->SamplesPerPixel;
  int bytesPerSample = bitsPerSample / 8;

  TW_UINT16 *samplePtr;

  pClientDataStruct theClientData = (pClientDataStruct) clientData;
		
  /* Allocate a buffer as necessary */
  if (!destBuf)
910
    destBuf = g_new (char, rows * cols * imageInfo->SamplesPerPixel);
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
		
  /* The bytes coming from the source may not be padded in
   * a way that The GIMP is terribly happy with.  It is
   * possible to transfer row by row, but that is particularly
   * expensive in terms of performance.  It is much cheaper
   * to rearrange the data and transfer it in one large chunk.
   * The next chunk of code rearranges the incoming data into
   * a non-padded chunk for The GIMP.  This function must also
   * reduce from multiple bytes per sample down to single byte
   * per sample.
   */
  /* Work through the rows */
  for (row = 0; row < rows; row++) {
    /* The start of this source row */
    samplePtr = (TW_UINT16 *) 
      ((char *) imageMemXfer->Memory.TheMem + (row * imageMemXfer->BytesPerRow));

    /* The start of this dest row */
    destByte = destBuf + (row * imageInfo->SamplesPerPixel * cols);

    /* Work through the columns */
    for (col = 0; col < cols; col++) {
      /* Finally, work through each of the samples */
      for (sample = 0; sample < imageInfo->SamplesPerPixel; sample++) {
				/* Get the value */
	TW_UINT16 value = *samplePtr;

				/* Move the sample pointer */
	samplePtr++;

				/* Place in the destination */
	*destByte = (char) ((float) value * (float) ratio);
	destByte++;
      }
    }
  }
		
  /* Send the complete chunk */
  gimp_pixel_rgn_set_rect(&(theClientData->pixel_rgn), 
			  (guchar *) destBuf,
			  imageMemXfer->XOffset, imageMemXfer->YOffset,
			  cols, rows);
		
  /* Update the user on our progress */
  theClientData->completedPixels += (cols * rows);
  gimp_progress_update((double) theClientData->completedPixels / 
		       (double) theClientData->totalPixels);
		
  return TRUE;
}
	
/*
 * palettedTransferCallback
 *
 * The following function is called for each memory
 * block that is transferred from the data source if
 * the image type is paletted.  This does not create
 * an indexed image type in The GIMP because for some
 * reason it does not allow creation of a specific
 * palette.  This function will create an RGB or Gray
 * image and use the palette to set the details of
 * the pixels.
 */ 
static int 
palettedTransferCallback(pTW_IMAGEINFO imageInfo,
			 pTW_IMAGEMEMXFER imageMemXfer,
			 void *clientData)
{
  int channelsPerEntry;
  int row, col;
  int rows = imageMemXfer->Rows;
  int cols = imageMemXfer->Columns;
  char *destPtr = NULL, *srcPtr = NULL;

  /* Get the client data */
  pClientDataStruct theClientData = (pClientDataStruct) clientData;
		
  /* Look up the palette entry size */
  channelsPerEntry = 
    (theClientData->paletteData->PaletteType == TWPA_RGB) ? 3 : 1;

  /* Allocate a buffer as necessary */
  if (!destBuf)
994
    destBuf = g_new (char, rows * cols * channelsPerEntry);
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105

  /* Work through the rows */
  destPtr = destBuf;
  for (row = 0; row < rows; row++) {
    srcPtr = (char *) ((char *) imageMemXfer->Memory.TheMem + 
		       (row * imageMemXfer->BytesPerRow));

    /* Work through the columns */
    for (col = 0; col < cols; col++) {
      /* Get the palette index */
      int index = (unsigned char) *srcPtr;
      srcPtr++;

      switch (theClientData->paletteData->PaletteType) {
      case TWPA_GRAY:
	*destPtr = theClientData->paletteData->Colors[index].Channel1;
	destPtr++;
	break;

      case TWPA_RGB:
	*destPtr = theClientData->paletteData->Colors[index].Channel1;
	destPtr++;
	*destPtr = theClientData->paletteData->Colors[index].Channel2;
	destPtr++;
	*destPtr = theClientData->paletteData->Colors[index].Channel3;
	destPtr++;
      }
    }
  }
		
  /* Send the complete chunk */
  gimp_pixel_rgn_set_rect(&(theClientData->pixel_rgn), 
			  (guchar *) destBuf,
			  imageMemXfer->XOffset, imageMemXfer->YOffset,
			  cols, rows);
		
  /* Update the user on our progress */
  theClientData->completedPixels += (cols * rows);
  gimp_progress_update((double) theClientData->completedPixels / 
		       (double) theClientData->totalPixels);
		
  return TRUE;
}
	
/*
 * dataTransferCallback
 *
 * The following function is called for each memory
 * block that is transferred from the data source.
 */
int 
dataTransferCallback(pTW_IMAGEINFO imageInfo,
		     pTW_IMAGEMEMXFER imageMemXfer,
		     void *clientData)
{
#ifdef _DEBUG
  logData(imageInfo, imageMemXfer, clientData);
#endif
		
  /* Choose the appropriate transfer handler */
  switch (imageInfo->PixelType) {
  case TWPT_PALETTE:
    return palettedTransferCallback(imageInfo, imageMemXfer, clientData);

  case TWPT_BW:
    return bitTransferCallback(imageInfo, imageMemXfer, clientData);
			
  case TWPT_GRAY:
  case TWPT_RGB:
    switch (imageInfo->BitsPerPixel / imageInfo->SamplesPerPixel) {
    case 8:
      return oneBytePerSampleTransferCallback(imageInfo, imageMemXfer, clientData);
				
    case 16:
      return twoBytesPerSampleTransferCallback(imageInfo, imageMemXfer, clientData);

    default:
      return FALSE;
    }
			
  default:
    return FALSE;
  }
}
	
/*
 * endTransferCallback
 *
 * The following function is called at the end of the
 * image transfer.  The caller will be handed
 * the image transfer completion state.  The
 * following values (defined in twain.h) are
 * possible:
 *
 * TWRC_XFERDONE
 *  The transfer completed successfully
 * TWRC_CANCEL
 *  The transfer was completed by the user
 * TWRC_FAILURE
 *  The transfer failed.
 */
int
endTransferCallback(int completionState, int pendingCount, void *clientData)
{
  pClientDataStruct theClientData = (pClientDataStruct) clientData;
		
  LogMessage("endTransferCallback: CompState = %d, pending = %d\n",
	     completionState, pendingCount);

  /* Clean up and detach from the drawable */
  if (destBuf) {
1106
    g_free (destBuf);
1107 1108 1109 1110 1111 1112 1113 1114
    destBuf = NULL;
  }
  gimp_drawable_flush(theClientData->drawable);
  gimp_drawable_detach(theClientData->drawable);

  /* Make sure to check our return code */
  if (completionState == TWRC_XFERDONE) {
    /* We have a completed image transfer */
1115
    values[2].type = GIMP_PDB_INT32ARRAY;	
1116 1117 1118 1119 1120
    values[2].data.d_int32array[values[1].data.d_int32++] =
      theClientData->image_id;
				
    /* Display the image */
    LogMessage("Displaying image %d\n", theClientData->image_id);
1121
    gimp_display_new (theClientData->image_id);
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
  } else {
    /* The transfer did not complete successfully */
    LogMessage("Deleting image\n");
    gimp_image_delete(theClientData->image_id);
  }
		
  /* Shut down if we have received all of the possible images */
  return (values[1].data.d_int32 < MAX_IMAGES);
}

/*
 * postTransferCallback
 *
 * This callback function will be called
 * after all possible images have been
 * transferred.
 */
void
postTransferCallback(int pendingCount, void *clientData)
{
  /* Shut things down. */
  if (pendingCount != 0)
    cancelPendingTransfers(twSession);

  /* This will close the datasource and datasource
   * manager.  Then the message queue will be shut
   * down and the run() procedure will finally be
   * able to finish.
   */
  disableDS(twSession);
  closeDS(twSession);
  closeDSM(twSession);
		
  /* Post a message to close up the application */
  PostQuitMessage(0);
}