#pragma once

/* ======================================================================== *\

  Copyright (C) 2007 TWAIN Working Group: Adobe Systems Incorporated,

  AnyDoc Software Inc., Eastman Kodak Company, Fujitsu Computer Products

  of America, JFL Peripheral Solutions Inc., Ricoh Corporation, and

  Xerox Corporation.  All rights reserved.

  Copyright (C) 1991, 1992 TWAIN Working Group: Aldus, Caere, Eastman-Kodak,

  Hewlett-Packard and Logitech Corporations.  All rights reserved.

  Copyright (C) 1997 TWAIN Working Group: Bell+Howell, Canon, DocuMagix,

  Fujitsu, Genoa Technology, Hewlett-Packard, Kofax Imaging Products, and

  Ricoh Corporation.  All rights reserved.

  Copyright © 1998 TWAIN Working Group: Adobe Systems Incorporated,

  Canon Information Systems, Eastman Kodak Company,

  Fujitsu Computer Products of America, Genoa Technology,

  Hewlett-Packard Company, Intel Corporation, Kofax Image Products,

  JFL Peripheral Solutions Inc., Ricoh Corporation, and Xerox Corporation.

  All rights reserved.

  Copyright © 2000 TWAIN Working Group: Adobe Systems Incorporated,

  Canon Information Systems, Digimarc Corporation, Eastman Kodak Company,

  Fujitsu Computer Products of America, Hewlett-Packard Company,

  JFL Peripheral Solutions Inc., Ricoh Corporation, and Xerox Corporation.

  All rights reserved.

  TWAIN.h -  This is the definitive include file for applications and

          data sources written to the TWAIN specification.

          It defines constants, data structures, messages etc.

          for the public interface to TWAIN.

  Revision History:

    version 1.0, March 6, 1992.  TWAIN 1.0.

    version 1.1, January 1993.   Tech Notes 1.1

    version 1.5, June 1993.      Specification Update 1.5

                                 Change DC to TW

                                 Change filename from DC.H to TWAIN.H

    version 1.5, July 1993.      Remove spaces from country identifiers

    version 1.7, July 1997       Added Capabilities and data structure for

                                 document imaging and digital cameras.

                                 KHL.

    version 1.7, July 1997       Inserted Borland compatibile structure packing

                                 directives provided by Mentor.  JMH

    version 1.7, Aug 1997        Expanded file tabs to spaces.

                                 NOTE: future authors should be sure to have

                                 their editors set to automatically expand tabs

                                 to spaces (original tab setting was 4 spaces).

    version 1.7, Sept 1997       Added job control values

                                 Added return codes

    version 1.7, Sept 1997       changed definition of pRGBRESPONSE to

                                 pTW_RGBRESPONSE

    version 1.7  Aug 1998        Added missing TWEI_BARCODEROTATION values

                                 TWBCOR_ types JMH

    version 1.8  August 1998     Added new types and definitions required

                                 for 1.8 Specification JMH

    version 1.8  January 1999    Changed search mode from SRCH_ to TWBD_ as

                                 in 1.8 Specification, added TWBT_MAXICODE JMH

    version 1.8  January 1999    Removed undocumented duplicate AUTO<cap> JMH

    version 1.8  March 1999      Removed undocumented 1.8 caps:

                                 CAP_FILESYSTEM

                                 CAP_PAPERBINDING

                                 CAP_PASSTHRU

                                 CAP_POWERDOWNTIME

                                 ICAP_AUTODISCARDBLANKPAGES

                               * CAP_PAGEMULTIPLEACQUIRE - is

CAP_REACQUIREALLOWED,

                               requires spec change.  JMH

                                 Added Mac structure packing modifications JMH

    version 1.9  March 2000  Added new types and definations required

                             for 1.9 Specification MLM

    version 1.9  March 2000  Added ICAP_JPEGQUALITY, TWJQ_ values,

                                 updated TWON_PROTOCOLMINOR for Release v1.9 MN

    version 1.91 August 2007     Added new types and definitions required

                                 for 1.91 Specification MLM

    version 2.0  Sept 2007       Added new types and definitions required

                                 for 2.0 Specification FHH

    version 2.0  Mar 2008        Depreciated ICAP_PIXELTYPEs TWPT_SRGB64,

TWPT_BGR,

                                 TWPT_CIELAB, TWPT_CIELUV, and TWPT_YCBCR  JMW

    version 2.0  Mar 2008        Added missing new 2.0 CAP_ definitions JMW

    version 2.0  Dec 2008        Updated TW_INFO structure for 64bit JMW

    version 2.1  Mar 2009        Added new types and definitions required

                                 for 2.1 Specification JMW

\* ======================================================================== */

#ifndef TWAIN

#define TWAIN

/****************************************************************************

 * TWAIN Version                                                            *

 ****************************************************************************/

#define TWON_PROTOCOLMINOR 1 /* Changed for Version 2.1            */

#define TWON_PROTOCOLMAJOR 2

/****************************************************************************

 * Platform Dependent Definitions and Typedefs                              *

 ****************************************************************************/

#ifdef LINUX

#include <wchar.h>

#endif

/* Microsoft C/C++ Compiler */

#if defined(_WIN32) || defined(WIN64) || defined(_WINDOWS)

#define TWH_CMP_MSC

#if defined(_WIN64) || defined(WIN64)

#define TWH_64BIT

#elif defined(_WIN32) || defined(_WIN32)

#define TWH_32BIT

#endif

/* Apple Compiler (which is GNU now) */

#elif defined(__APPLE__)

#define TWH_CMP_XCODE

#define TWH_32BIT

/* GNU C/C++ Compiler */

#elif defined(__GNUC__)

#define TWH_CMP_GNU

#if defined(__alpha__) || defined(__ia64__) || defined(__ppc64__) ||           \

    defined(__s390x__) || defined(__x86_64__)

#define TWH_64BIT

#else

#define TWH_32BIT

#endif

/* Borland C/C++ Compiler */

#elif defined(__BORLAND__)

#define TWH_CMP_BORLAND

#define TWH_32BIT

/* Unrecognized */

#else

#error Unrecognized compiler

#endif

/* Win32 and Win64 systems */

#if defined(TWH_CMP_MSC) | defined(TWH_CMP_BORLAND)

#include <windows.h>

typedef HANDLE TW_HANDLE;

typedef LPVOID TW_MEMREF;

typedef UINT_PTR TW_UINTPTR;

/* MacOS/X... */

#elif defined(TWH_CMP_XCODE)

#include <Cocoa/Cocoa.h>

#define PASCAL pascal

#define FAR

typedef Handle TW_HANDLE;

typedef char *TW_MEMREF;

#ifdef TWH_32BIT

// 32 bit GNU

typedef unsigned long TW_UINTPTR;

#else

// 64 bit GNU

typedef unsigned long long TW_UINTPTR;

#endif

/* Everything else... */

#else

#define PASCAL

#define FAR

typedef void *TW_HANDLE;

typedef void *TW_MEMREF;

typedef unsigned char BYTE;

#ifdef TWH_32BIT

// 32 bit GNU

typedef unsigned long TW_UINTPTR;

#else

// 64 bit GNU

typedef unsigned long long TW_UINTPTR;

#endif

#endif

/* Set the packing: this occurs before any structures are defined */

#ifdef TWH_CMP_MSC

#pragma pack(push, before_twain)

#pragma pack(2)

#elif defined(TWH_CMP_GNU)

#pragma pack(push, before_twain)

#pragma pack(2)

#elif defined(TWH_CMP_BORLAND)

#pragma option -a2

#elif defined(TWH_CMP_XCODE)

#if PRAGMA_STRUCT_ALIGN

#pragma options align = mac68k

#elif PRAGMA_STRUCT_PACKPUSH

#pragma pack(push, 2)

#elif PRAGMA_STRUCT_PACK

#pragma pack(2)

#endif

#endif

/****************************************************************************

 * Type Definitions                                                         *

 ****************************************************************************/

/* String types. These include room for the strings and a NULL char,     *

 * or, on the Mac, a length byte followed by the string.                 *

 * TW_STR255 must hold less than 256 chars so length fits in first byte. */

typedef char TW_STR32[34], FAR *pTW_STR32;

typedef char TW_STR64[66], FAR *pTW_STR64;

typedef char TW_STR128[130], FAR *pTW_STR128;

typedef char TW_STR255[256], FAR *pTW_STR255;

/* Numeric types. */

typedef char TW_INT8, FAR *pTW_INT8;

typedef short TW_INT16, FAR *pTW_INT16;

typedef long TW_INT32, FAR *pTW_INT32;

typedef unsigned char TW_UINT8, FAR *pTW_UINT8;

typedef unsigned short TW_UINT16, FAR *pTW_UINT16;

typedef unsigned long TW_UINT32, FAR *pTW_UINT32;

typedef unsigned short TW_BOOL, FAR *pTW_BOOL;

/****************************************************************************

 * Structure Definitions                                                    *

 ****************************************************************************/

/* Fixed point structure type. */

typedef struct {

  TW_INT16 Whole; /* maintains the sign */

  TW_UINT16 Frac;

} TW_FIX32, FAR *pTW_FIX32;

/* No DAT.  Defines a frame rectangle in ICAP_UNITS coordinates. */

typedef struct {

  TW_FIX32 Left;

  TW_FIX32 Top;

  TW_FIX32 Right;

  TW_FIX32 Bottom;

} TW_FRAME, FAR *pTW_FRAME;

/* No DAT needed. */

typedef struct {

  TW_FIX32 StartIn;

  TW_FIX32 BreakIn;

  TW_FIX32 EndIn;

  TW_FIX32 StartOut;

  TW_FIX32 BreakOut;

  TW_FIX32 EndOut;

  TW_FIX32 Gamma;

  TW_FIX32 SampleCount; /* if =0 use the gamma */

} TW_DECODEFUNCTION, FAR *pTW_DECODEFUNCTION;

/* No DAT needed. */

typedef struct {

  TW_DECODEFUNCTION Decode[3];

  TW_FIX32 Mix[3][3];

} TW_TRANSFORMSTAGE, FAR *pTW_TRANSFORMSTAGE;

/* TWON_ARRAY. Container for array of values (a simplified TW_ENUMERATION) */

typedef struct {

  TW_UINT16 ItemType;

  TW_UINT32 NumItems;   /* How many items in ItemList           */

  TW_UINT8 ItemList[1]; /* Array of ItemType values starts here */

} TW_ARRAY, FAR *pTW_ARRAY;

/* DAT_AUDIOINFO, information about audio data */

typedef struct {

  TW_STR255 Name;     /* name of audio data */

  TW_UINT32 Reserved; /* reserved space */

} TW_AUDIOINFO, FAR *pTW_AUDIOINFO;

/* TW_CALLBACK, used to register callbacks Added 2.0 */

typedef struct {

  TW_MEMREF CallBackProc;

  TW_UINT32 RefCon;

  TW_INT16 Message;

} TW_CALLBACK, FAR *pTW_CALLBACK;

/* DAT_CAPABILITY. Used by application to get/set capability from/in a data

 * source. */

typedef struct {

  TW_UINT16 Cap;     /* id of capability to set or get, e.g. CAP_BRIGHTNESS */

  TW_UINT16 ConType; /* TWON_ONEVALUE, _RANGE, _ENUMERATION or _ARRAY   */

  TW_HANDLE hContainer; /* Handle to container of type Dat              */

} TW_CAPABILITY, FAR *pTW_CAPABILITY;

/* No DAT needed. */

typedef struct {

  TW_FIX32 X;

  TW_FIX32 Y;

  TW_FIX32 Z;

} TW_CIEPOINT, FAR *pTW_CIEPOINT;

/* DAT_CIECOLOR. */

typedef struct {

  TW_UINT16 ColorSpace;

  TW_INT16 LowEndian;

  TW_INT16 DeviceDependent;

  TW_INT32 VersionNumber;

  TW_TRANSFORMSTAGE StageABC;

  TW_TRANSFORMSTAGE StageLMN;

  TW_CIEPOINT WhitePoint;

  TW_CIEPOINT BlackPoint;

  TW_CIEPOINT WhitePaper;

  TW_CIEPOINT BlackInk;

  TW_FIX32 Samples[1];

} TW_CIECOLOR, FAR *pTW_CIECOLOR;

typedef struct {

  TW_UINT32 InfoLength; /* Length of Information in bytes.  */

  TW_HANDLE hData;      /* Place holder for data, DS Allocates */

} TW_CUSTOMDSDATA, FAR *pTW_CUSTOMDSDATA;

/* DAT_DEVICEEVENT, information about events */

typedef struct {

  TW_UINT32 Event;      /* One of the TWDE_xxxx values. */

  TW_STR255 DeviceName; /* The name of the device that generated the event */

  TW_UINT32 BatteryMinutes;         /* Battery Minutes Remaining    */

  TW_INT16 BatteryPercentage;       /* Battery Percentage Remaining */

  TW_INT32 PowerSupply;             /* Power Supply                 */

  TW_FIX32 XResolution;             /* Resolution                   */

  TW_FIX32 YResolution;             /* Resolution                   */

  TW_UINT32 FlashUsed2;             /* Flash Used2                  */

  TW_UINT32 AutomaticCapture;       /* Automatic Capture            */

  TW_UINT32 TimeBeforeFirstCapture; /* Automatic Capture            */

  TW_UINT32 TimeBetweenCaptures;    /* Automatic Capture            */

} TW_DEVICEEVENT, FAR *pTW_DEVICEEVENT;

/* No DAT needed. */

typedef struct {

  TW_UINT8 Index;    /* Value used to index into the color table. */

  TW_UINT8 Channel1; /* First  tri-stimulus value (e.g Red)       */

  TW_UINT8 Channel2; /* Second tri-stimulus value (e.g Green)     */

  TW_UINT8 Channel3; /* Third  tri-stimulus value (e.g Blue)      */

} TW_ELEMENT8, FAR *pTW_ELEMENT8;

/* TWON_ENUMERATION. Container for a collection of values. */

typedef struct {

  TW_UINT16 ItemType;

  TW_UINT32 NumItems;     /* How many items in ItemList                 */

  TW_UINT32 CurrentIndex; /* Current value is in ItemList[CurrentIndex] */

  TW_UINT32 DefaultIndex; /* Powerup value is in ItemList[DefaultIndex] */

  TW_UINT8 ItemList[1];   /* Array of ItemType values starts here       */

} TW_ENUMERATION, FAR *pTW_ENUMERATION;

/* DAT_EVENT. For passing events down from the application to the DS. */

typedef struct {

  TW_MEMREF pEvent;    /* Windows pMSG or Mac pEvent.                 */

  TW_UINT16 TWMessage; /* TW msg from data source, e.g. MSG_XFERREADY */

} TW_EVENT, FAR *pTW_EVENT;

typedef struct {

  TW_UINT16 InfoID;

  TW_UINT16 ItemType;

  TW_UINT16 NumItems;

  union {

    TW_UINT16 CondCode; /* Depreciated, use ReturnCode. TWAIN 2.0 and older. */

    TW_UINT16 ReturnCode; /* TWAIN 2.1 and newer */

  };

  TW_UINTPTR Item;

} TW_INFO, FAR *pTW_INFO;

typedef struct {

  TW_UINT32 NumInfos;

  TW_INFO Info[1];

} TW_EXTIMAGEINFO, FAR *pTW_EXTIMAGEINFO;

/* DAT_FILESYSTEM, information about TWAIN file system */

typedef struct {

  /* DG_CONTROL / DAT_FILESYSTEM / MSG_xxxx fields     */

  TW_STR255 InputName;  /* The name of the input or source file */

  TW_STR255 OutputName; /* The result of an operation or the name of a

                           destination file */

  TW_MEMREF

  Context; /* Source specific data used to remember state information */

  /* DG_CONTROL / DAT_FILESYSTEM / MSG_DELETE field    */

  int Recursive; /* recursively delete all sub-directories */

  /* DG_CONTROL / DAT_FILESYSTEM / MSG_GETINFO fields  */

  TW_INT32 FileType;         /* One of the TWFY_xxxx values */

  TW_UINT32 Size;            /* Size of current FileType */

  TW_STR32 CreateTimeDate;   /* creation date of the file */

  TW_STR32 ModifiedTimeDate; /* last date the file was modified */

  TW_UINT32 FreeSpace;       /* bytes of free space on the current device */

  TW_INT32 NewImageSize;   /* estimate of the amount of space a new image would

                              take up */

  TW_UINT32 NumberOfFiles; /* number of files, depends on FileType */

  TW_UINT32 NumberOfSnippets; /* number of audio snippets */

  TW_UINT32 DeviceGroupMask;  /* used to group cameras (ex: front/rear bitonal,

                                 front/rear grayscale...) */

  char Reserved[508];         /**/

} TW_FILESYSTEM, FAR *pTW_FILESYSTEM;

/* DAT_GRAYRESPONSE */

typedef struct {

  TW_ELEMENT8 Response[1];

} TW_GRAYRESPONSE, FAR *pTW_GRAYRESPONSE;

/* No DAT needed.  Describes version of software currently running. */

typedef struct {

  TW_UINT16 MajorNum; /* Major revision number of the software. */

  TW_UINT16 MinorNum; /* Incremental revision number of the software. */

  TW_UINT16 Language; /* e.g. TWLG_SWISSFRENCH */

  TW_UINT16 Country;  /* e.g. TWCY_SWITZERLAND */

  TW_STR32 Info;      /* e.g. "1.0b3 Beta release" */

} TW_VERSION, FAR *pTW_VERSION;

/* DAT_IDENTITY. Identifies the program/library/code resource. */

typedef struct {

  TW_UINT32 Id;       /* Unique number.  In Windows, application hWnd      */

  TW_VERSION Version; /* Identifies the piece of code              */

  TW_UINT16

  ProtocolMajor; /* Application and DS must set to TWON_PROTOCOLMAJOR */

  TW_UINT16

  ProtocolMinor; /* Application and DS must set to TWON_PROTOCOLMINOR */

  TW_UINT32 SupportedGroups; /* Bit field OR combination of DG_ constants */

  TW_STR32 Manufacturer;     /* Manufacturer name, e.g. "Hewlett-Packard" */

  TW_STR32 ProductFamily;    /* Product family name, e.g. "ScanJet"       */

  TW_STR32 ProductName;      /* Product name, e.g. "ScanJet Plus"         */

} TW_IDENTITY, FAR *pTW_IDENTITY;

/* DAT_IMAGEINFO. Application gets detailed image info from DS with this. */

typedef struct {

  TW_FIX32 XResolution;      /* Resolution in the horizontal             */

  TW_FIX32 YResolution;      /* Resolution in the vertical               */

  TW_INT32 ImageWidth;       /* Columns in the image, -1 if unknown by DS*/

  TW_INT32 ImageLength;      /* Rows in the image, -1 if unknown by DS   */

  TW_INT16 SamplesPerPixel;  /* Number of samples per pixel, 3 for RGB   */

  TW_INT16 BitsPerSample[8]; /* Number of bits for each sample           */

  TW_INT16 BitsPerPixel;     /* Number of bits for each padded pixel     */

  TW_BOOL Planar;            /* True if Planar, False if chunky          */

  TW_INT16 PixelType;        /* How to interp data; photo interp (TWPT_) */

  TW_UINT16 Compression;     /* How the data is compressed (TWCP_xxxx)   */

} TW_IMAGEINFO, FAR *pTW_IMAGEINFO;

/* DAT_IMAGELAYOUT. Provides image layout information in current units. */

typedef struct {

  TW_FRAME Frame; /* Frame coords within larger document */

  TW_UINT32 DocumentNumber;

  TW_UINT32 PageNumber;  /* Reset when you go to next document  */

  TW_UINT32 FrameNumber; /* Reset when you go to next page      */

} TW_IMAGELAYOUT, FAR *pTW_IMAGELAYOUT;

/* No DAT needed.  Used to manage memory buffers. */

typedef struct {

  TW_UINT32 Flags;  /* Any combination of the TWMF_ constants.           */

  TW_UINT32 Length; /* Number of bytes stored in buffer TheMem.          */

  TW_MEMREF TheMem; /* Pointer or handle to the allocated memory buffer. */

} TW_MEMORY, FAR *pTW_MEMORY;

/* DAT_IMAGEMEMXFER. Used to pass image data (e.g. in strips) from DS to

 * application.*/

typedef struct {

  TW_UINT16 Compression;  /* How the data is compressed                */

  TW_UINT32 BytesPerRow;  /* Number of bytes in a row of data          */

  TW_UINT32 Columns;      /* How many columns                          */

  TW_UINT32 Rows;         /* How many rows                             */

  TW_UINT32 XOffset;      /* How far from the side of the image        */

  TW_UINT32 YOffset;      /* How far from the top of the image         */

  TW_UINT32 BytesWritten; /* How many bytes written in Memory          */

  TW_MEMORY Memory;       /* Mem struct used to pass actual image data */

} TW_IMAGEMEMXFER, FAR *pTW_IMAGEMEMXFER;

/* Changed in 1.1: QuantTable, HuffmanDC, HuffmanAC TW_MEMREF -> TW_MEMORY  */

/* DAT_JPEGCOMPRESSION. Based on JPEG Draft International Std, ver 10918-1. */

typedef struct {

  TW_UINT16 ColorSpace;       /* One of the TWPT_xxxx values                */

  TW_UINT32 SubSampling;      /* Two word "array" for subsampling values    */

  TW_UINT16 NumComponents;    /* Number of color components in image        */

  TW_UINT16 RestartFrequency; /* Frequency of restart marker codes in MDU's */

  TW_UINT16 QuantMap[4];      /* Mapping of components to QuantTables       */

  TW_MEMORY QuantTable[4];    /* Quantization tables                        */

  TW_UINT16 HuffmanMap[4];    /* Mapping of components to Huffman tables    */

  TW_MEMORY HuffmanDC[2];     /* DC Huffman tables                          */

  TW_MEMORY HuffmanAC[2];     /* AC Huffman tables                          */

} TW_JPEGCOMPRESSION, FAR *pTW_JPEGCOMPRESSION;

/* TWON_ONEVALUE. Container for one value. */

typedef struct {

  TW_UINT16 ItemType;

  TW_UINT32 Item;

} TW_ONEVALUE, FAR *pTW_ONEVALUE;

/* DAT_PALETTE8. Color palette when TWPT_PALETTE pixels xfer'd in mem buf. */

typedef struct {

  TW_UINT16 NumColors;     /* Number of colors in the color table.  */

  TW_UINT16 PaletteType;   /* TWPA_xxxx, specifies type of palette. */

  TW_ELEMENT8 Colors[256]; /* Array of palette values starts here.  */

} TW_PALETTE8, FAR *pTW_PALETTE8;

/* DAT_PASSTHRU, device dependant data to pass through Data Source */

typedef struct {

  TW_MEMREF pCommand;     /* Pointer to Command buffer */

  TW_UINT32 CommandBytes; /* Number of bytes in Command buffer */

  TW_INT32 Direction;  /* One of the TWDR_xxxx values.  Defines the direction of

                          data flow */

  TW_MEMREF pData;     /* Pointer to Data buffer */

  TW_UINT32 DataBytes; /* Number of bytes in Data buffer */

  TW_UINT32 DataBytesXfered; /* Number of bytes successfully transferred */

} TW_PASSTHRU, FAR *pTW_PASSTHRU;

/* DAT_PENDINGXFERS. Used with MSG_ENDXFER to indicate additional data. */

typedef struct {

  TW_UINT16 Count;

  union {

    TW_UINT32 EOJ;

    TW_UINT32 Reserved;

  };

} TW_PENDINGXFERS, FAR *pTW_PENDINGXFERS;

/* TWON_RANGE. Container for a range of values. */

typedef struct {

  TW_UINT16 ItemType;

  TW_UINT32 MinValue;     /* Starting value in the range.           */

  TW_UINT32 MaxValue;     /* Final value in the range.              */

  TW_UINT32 StepSize;     /* Increment from MinValue to MaxValue.   */

  TW_UINT32 DefaultValue; /* Power-up value.                        */

  TW_UINT32 CurrentValue; /* The value that is currently in effect. */

} TW_RANGE, FAR *pTW_RANGE;

/* DAT_RGBRESPONSE */

typedef struct {

  TW_ELEMENT8 Response[1];

} TW_RGBRESPONSE, FAR *pTW_RGBRESPONSE;

/* DAT_SETUPFILEXFER. Sets up DS to application data transfer via a file. */

typedef struct {

  TW_STR255 FileName;

  TW_UINT16 Format; /* Any TWFF_ constant */

  TW_INT16 VRefNum; /* Used for Mac only  */

} TW_SETUPFILEXFER, FAR *pTW_SETUPFILEXFER;

/* DAT_SETUPMEMXFER. Sets up DS to application data transfer via a memory

 * buffer. */

typedef struct {

  TW_UINT32 MinBufSize;

  TW_UINT32 MaxBufSize;

  TW_UINT32 Preferred;

} TW_SETUPMEMXFER, FAR *pTW_SETUPMEMXFER;

/* DAT_STATUS. Application gets detailed status info from a data source with

 * this. */

typedef struct {

  TW_UINT16 ConditionCode; /* Any TWCC_ constant     */

  union {

    TW_UINT16 Data;     /* output (TWAIN 2.1 and newer) This field contains

                           additional data. */

    TW_UINT16 Reserved; /* output (TWAIN 2.0 and older) */

  };

} TW_STATUS, FAR *pTW_STATUS;

/* DAT_STATUSUTF8. Application gets detailed UTF8 status info from a data source

 * with this.  Added 2.1 */

typedef struct {

  TW_STATUS Status; /* input  TW_STATUS data received from a previous call to

                       DG_CONTROL / DAT_STATUS / MSG_GET. */

  TW_UINT32 Size;   /* output Total number of bytes in the UTF8string, plus the

                       terminating NUL byte.  This is not the same as the total

                       number of characters in the string. */

  TW_HANDLE

  UTF8string; /* output TW_HANDLE to a UTF-8 encoded localized string (based

                 on TW_IDENTITY.Language or CAP_LANGUAGE).  The Source

                 allocates it, the Application frees it. */

} TW_STATUSUTF8, FAR *pTW_STATUSUTF8;

/* DAT_USERINTERFACE. Coordinates UI between application and data source. */

typedef struct {

  TW_BOOL ShowUI;    /* TRUE if DS should bring up its UI           */

  TW_BOOL ModalUI;   /* For Mac only - true if the DS's UI is modal */

  TW_HANDLE hParent; /* For windows only - Application window handle        */

} TW_USERINTERFACE, FAR *pTW_USERINTERFACE;

/****************************************************************************

 * Generic Constants                                                        *

 ****************************************************************************/

#define TWON_ARRAY 3       /* indicates TW_ARRAY container       */

#define TWON_ENUMERATION 4 /* indicates TW_ENUMERATION container */

#define TWON_ONEVALUE 5    /* indicates TW_ONEVALUE container    */

#define TWON_RANGE 6       /* indicates TW_RANGE container       */

#define TWON_ICONID 962   /* res Id of icon used in USERSELECT lbox */

#define TWON_DSMID 461    /* res Id of the DSM version num resource */

#define TWON_DSMCODEID 63 /* res Id of the Mac SM Code resource     */

#define TWON_DONTCARE8 0xff

#define TWON_DONTCARE16 0xffff

#define TWON_DONTCARE32 0xffffffff

/* Flags used in TW_MEMORY structure. */

#define TWMF_APPOWNS 0x1

#define TWMF_DSMOWNS 0x2

#define TWMF_DSOWNS 0x4

#define TWMF_POINTER 0x8

#define TWMF_HANDLE 0x10

/* There are four containers used for capabilities negotiation:

 *    TWON_ONEVALUE, TWON_RANGE, TWON_ENUMERATION, TWON_ARRAY

 * In each container structure ItemType can be TWTY_INT8, TWTY_INT16, etc.

 * The kind of data stored in the container can be determined by doing

 * DCItemSize[ItemType] where the following is defined in TWAIN glue code:

 *          DCItemSize[]= { sizeof(TW_INT8),

 *                          sizeof(TW_INT16),

 *                          etc.

 *                          sizeof(TW_UINT32) };

 *

 */

#define TWTY_INT8 0x0000  /* Means Item is a TW_INT8   */

#define TWTY_INT16 0x0001 /* Means Item is a TW_INT16  */

#define TWTY_INT32 0x0002 /* Means Item is a TW_INT32  */

#define TWTY_UINT8 0x0003  /* Means Item is a TW_UINT8  */

#define TWTY_UINT16 0x0004 /* Means Item is a TW_UINT16 */

#define TWTY_UINT32 0x0005 /* Means Item is a TW_UINT32 */

#define TWTY_BOOL 0x0006 /* Means Item is a TW_BOOL   */

#define TWTY_FIX32 0x0007 /* Means Item is a TW_FIX32  */

#define TWTY_FRAME 0x0008 /* Means Item is a TW_FRAME  */

#define TWTY_STR32 0x0009  /* Means Item is a TW_STR32  */

#define TWTY_STR64 0x000a  /* Means Item is a TW_STR64  */

#define TWTY_STR128 0x000b /* Means Item is a TW_STR128 */

#define TWTY_STR255 0x000c /* Means Item is a TW_STR255 */

#define TWTY_HANDLE 0x000f /* Means Item is a TW_HANDLE */

/****************************************************************************

 * Capability Constants                                                     *

 ****************************************************************************/

/* CAP_ALARMS values (AL_ means alarms) Added 1.8  */

#define TWAL_ALARM 0

#define TWAL_FEEDERERROR 1

#define TWAL_FEEDERWARNING 2

#define TWAL_BARCODE 3

#define TWAL_DOUBLEFEED 4

#define TWAL_JAM 5

#define TWAL_PATCHCODE 6

#define TWAL_POWER 7

#define TWAL_SKEW 8

/* ICAP_AUTOSIZE values Added 2.0 */

#define TWAS_NONE 0

#define TWAS_AUTO 1

#define TWAS_CURRENT 2

/* TWEI_BARCODEROTATION values (BCOR_ means barcode rotation) Added 1.7 */

#define TWBCOR_ROT0 0

#define TWBCOR_ROT90 1

#define TWBCOR_ROT180 2

#define TWBCOR_ROT270 3

#define TWBCOR_ROTX 4

/* ICAP_BARCODESEARCHMODE values (TWBD_ means search) */

#define TWBD_HORZ 0

#define TWBD_VERT 1

#define TWBD_HORZVERT 2

#define TWBD_VERTHORZ 3

/* ICAP_BITORDER values (BO_ means Bit Order) */

#define TWBO_LSBFIRST 0

#define TWBO_MSBFIRST 1

/* ICAP_AUTODISCARDBLANKPAGES values Added 2.0 */

#define TWBP_DISABLE -2

#define TWBP_AUTO -1

/* ICAP_BITDEPTHREDUCTION values (BR_ means Bitdepth Reduction) Added 1.5 */

#define TWBR_THRESHOLD 0

#define TWBR_HALFTONE 1

#define TWBR_CUSTHALFTONE 2

#define TWBR_DIFFUSION 3

/* ICAP_SUPPORTEDBARCODETYPES and TWEI_BARCODETYPE values Added 1.7 */

#define TWBT_3OF9 0

#define TWBT_2OF5INTERLEAVED 1

#define TWBT_2OF5NONINTERLEAVED 2

#define TWBT_CODE93 3

#define TWBT_CODE128 4

#define TWBT_UCC128 5

#define TWBT_CODABAR 6

#define TWBT_UPCA 7

#define TWBT_UPCE 8

#define TWBT_EAN8 9

#define TWBT_EAN13 10

#define TWBT_POSTNET 11

#define TWBT_PDF417 12

#define TWBT_2OF5INDUSTRIAL 13       /* Added 1.8 */

#define TWBT_2OF5MATRIX 14           /* Added 1.8 */

#define TWBT_2OF5DATALOGIC 15        /* Added 1.8 */

#define TWBT_2OF5IATA 16             /* Added 1.8 */

#define TWBT_3OF9FULLASCII 17        /* Added 1.8 */

#define TWBT_CODABARWITHSTARTSTOP 18 /* Added 1.8 */

#define TWBT_MAXICODE 19             /* Added 1.8 */

/* ICAP_COMPRESSION values (CP_ means ComPression ) */

#define TWCP_NONE 0

#define TWCP_PACKBITS 1

#define TWCP_GROUP31D 2    /* Follows CCITT spec (no End Of Line)          */

#define TWCP_GROUP31DEOL 3 /* Follows CCITT spec (has End Of Line)         */

#define TWCP_GROUP32D 4    /* Follows CCITT spec (use cap for K Factor)    */

#define TWCP_GROUP4 5      /* Follows CCITT spec                           */

#define TWCP_JPEG 6        /* Use capability for more info                 */

#define TWCP_LZW 7         /* Must license from Unisys and IBM to use      */

#define TWCP_JBIG 8        /* For Bitonal images  -- Added 1.7 KHL         */

#define TWCP_PNG 9         /* Added 1.8 */

#define TWCP_RLE4 10       /* Added 1.8 */

#define TWCP_RLE8 11       /* Added 1.8 */

#define TWCP_BITFIELDS 12  /* Added 1.8 */

/* CAP_CAMERASIDE and TWEI_PAGESIDE values (CS_ means camera side) Added 1.91 */

#define TWCS_BOTH 0

#define TWCS_TOP 1

#define TWCS_BOTTOM 2

/* CAP_CLEARBUFFERS values (CB_ means clear buffers) */

#define TWCB_AUTO 0

#define TWCB_CLEAR 1

#define TWCB_NOCLEAR 2

/* CAP_DEVICEEVENT values (DE_ means device event) */

#define TWDE_CUSTOMEVENTS 0x8000

#define TWDE_CHECKAUTOMATICCAPTURE 0

#define TWDE_CHECKBATTERY 1

#define TWDE_CHECKDEVICEONLINE 2

#define TWDE_CHECKFLASH 3

#define TWDE_CHECKPOWERSUPPLY 4

#define TWDE_CHECKRESOLUTION 5

#define TWDE_DEVICEADDED 6

#define TWDE_DEVICEOFFLINE 7

#define TWDE_DEVICEREADY 8

#define TWDE_DEVICEREMOVED 9

#define TWDE_IMAGECAPTURED 10

#define TWDE_IMAGEDELETED 11

#define TWDE_PAPERDOUBLEFEED 12

#define TWDE_PAPERJAM 13

#define TWDE_LAMPFAILURE 14

#define TWDE_POWERSAVE 15

#define TWDE_POWERSAVENOTIFY 16

/* TW_PASSTHRU.Direction values.  Added 1.8 */

#define TWDR_GET 1

#define TWDR_SET 2

/* TWEI_DESKEWSTATUS values Added 1.7 */

#define TWDSK_SUCCESS 0

#define TWDSK_REPORTONLY 1

#define TWDSK_FAIL 2

#define TWDSK_DISABLED 3

/* CAP_DUPLEX values Added 1.7 */

#define TWDX_NONE 0

#define TWDX_1PASSDUPLEX 1

#define TWDX_2PASSDUPLEX 2

/* CAP_FEEDERALIGNMENT values (FA_ means feeder alignment) */

#define TWFA_NONE 0

#define TWFA_LEFT 1

#define TWFA_CENTER 2

#define TWFA_RIGHT 3

/* ICAP_FEEDERTYPE */

#define TWFE_GENERAL 0

#define TWFE_PHOTO 1

/* ICAP_IMAGEFILEFORMAT values (FF_means File Format)   */

#define TWFF_TIFF 0      /* Tagged Image File Format     */

#define TWFF_PICT 1      /* Macintosh PICT               */

#define TWFF_BMP 2       /* Windows Bitmap               */

#define TWFF_XBM 3       /* X-Windows Bitmap             */

#define TWFF_JFIF 4      /* JPEG File Interchange Format */

#define TWFF_FPX 5       /* Flash Pix                    */

#define TWFF_TIFFMULTI 6 /* Multi-page tiff file         */

#define TWFF_PNG 7

#define TWFF_SPIFF 8

#define TWFF_EXIF 9

#define TWFF_PDF 10    /* 1.91 NB: this is not PDF/A */

#define TWFF_JP2 11    /* 1.91 */

#define TWFF_JPX 13    /* 1.91 */

#define TWFF_DEJAVU 14 /* 1.91 */

#define TWFF_PDFA 15   /* 2.0 Adobe PDF/A, Version 1*/

#define TWFF_PDFA2 16  /* 2.1 Adobe PDF/A, Version 2*/

/* ICAP_FLASHUSED2 values (FL_ means flash) */

#define TWFL_NONE 0

#define TWFL_OFF 1

#define TWFL_ON 2

#define TWFL_AUTO 3

#define TWFL_REDEYE 4

/* CAP_FEEDERORDER values (FO_ means feeder order) */

#define TWFO_FIRSTPAGEFIRST 0

#define TWFO_LASTPAGEFIRST 1

/* CAP_FEEDERPOCKET */

#define TWFP_POCKETERROR 0

#define TWFP_POCKET1 1

#define TWFP_POCKET2 2

#define TWFP_POCKET3 3

#define TWFP_POCKET4 4

#define TWFP_POCKET5 5

#define TWFP_POCKET6 6

#define TWFP_POCKET7 7

#define TWFP_POCKET8 8

#define TWFP_POCKET9 9

#define TWFP_POCKET10 10

#define TWFP_POCKET11 11

#define TWFP_POCKET12 12

#define TWFP_POCKET13 13

#define TWFP_POCKET14 14

#define TWFP_POCKET15 15

#define TWFP_POCKET16 16

/* ICAP_FLIPROTATION values (FR_ means flip rotation) */

#define TWFR_BOOK 0

#define TWFR_FANFOLD 1

/* ICAP_FILTER values (FT_ means Filter Type) */

#define TWFT_RED 0

#define TWFT_GREEN 1

#define TWFT_BLUE 2

#define TWFT_NONE 3

#define TWFT_WHITE 4

#define TWFT_CYAN 5

#define TWFT_MAGENTA 6

#define TWFT_YELLOW 7

#define TWFT_BLACK 8

/* TW_FILESYSTEM.FileType values (FY_ means file type) */

#define TWFY_CAMERA 0

#define TWFY_CAMERATOP 1

#define TWFY_CAMERABOTTOM 2

#define TWFY_CAMERAPREVIEW 3

#define TWFY_DOMAIN 4

#define TWFY_HOST 5

#define TWFY_DIRECTORY 6

#define TWFY_IMAGE 7

#define TWFY_UNKNOWN 8

/* ICAP_ICCPROFILE */

#define TWIC_NONE 0

#define TWIC_LINK 1

#define TWIC_EMBED 2

/* ICAP_IMAGEFILTER values (IF_ means image filter) */

#define TWIF_NONE 0

#define TWIF_AUTO 1

#define TWIF_LOWPASS 2

#define TWIF_BANDPASS 3

#define TWIF_HIGHPASS 4

#define TWIF_TEXT TWIF_BANDPASS

#define TWIF_FINELINE TWIF_HIGHPASS

/* ICAP_IMAGEMERGE values (IM_ means image merge) */

#define TWIM_NONE 0

#define TWIM_FRONTONTOP 1

#define TWIM_FRONTONBOTTOM 2

#define TWIM_FRONTONLEFT 3

#define TWIM_FRONTONRIGHT 4

/* CAP_JOBCONTROL values Added 1.7  */

#define TWJC_NONE 0

#define TWJC_JSIC 1

#define TWJC_JSIS 2

#define TWJC_JSXC 3

#define TWJC_JSXS 4

/* ICAP_JPEGQUALITY values (JQ_ means jpeg quality) */

#define TWJQ_UNKNOWN -4

#define TWJQ_LOW -3

#define TWJQ_MEDIUM -2

#define TWJQ_HIGH -1

/* ICAP_LIGHTPATH values (LP_ means Light Path) */

#define TWLP_REFLECTIVE 0

#define TWLP_TRANSMISSIVE 1

/* ICAP_LIGHTSOURCE values (LS_ means Light Source) */

#define TWLS_RED 0