git.oblomov.eu Git - wine/blob - include/twain.h

   1 /* ======================================================================== *\
   2
   3   Copyright (C) 1991, 1992 TWAIN Working Group: Aldus, Caere, Eastman-Kodak,
   4   Hewlett-Packard and Logitech Corporations.  All rights reserved.
   5
   6   Copyright (C) 1997 TWAIN Working Group: Bell+Howell, Canon, DocuMagix,
   7   Fujitsu, Genoa Technology, Hewlett-Packard, Kofax Imaging Products, and
   8   Ricoh Corporation.  All rights reserved.
   9
  10   Copyright (C) 1998 TWAIN Working Group: Adobe Systems Incorporated,
  11   Canon Information Systems, Eastman Kodak Company,
  12   Fujitsu Computer Products of America, Genoa Technology,
  13   Hewlett-Packard Company, Intel Corporation, Kofax Image Products,
  14   JFL Peripheral Solutions Inc., Ricoh Corporation, and Xerox Corporation.
  15   All rights reserved.
  16
  17   TWAIN.h -  This is the definitive include file for applications and
  18           data sources written to the TWAIN specification.
  19           It defines constants, data structures, messages etc.
  20           for the public interface to TWAIN.
  21
  22   Revision History:
  23     version 1.0, March 6, 1992.  TWAIN 1.0.
  24     version 1.1, January 1993.   Tech Notes 1.1
  25     version 1.5, June 1993.      Specification Update 1.5
  26                                  Change DC to TW
  27                                  Change filename from DC.H to TWAIN.H
  28     version 1.5, July 1993.      Remove spaces from country identifiers
  29
  30     version 1.7, July 1997       Added Capabilities and data structure for
  31                                  document imaging and digital cameras.
  32                                  KHL.
  33     version 1.7, July 1997       Inserted Borland compatible structure packing
  34                                  directives provided by Mentor.  JMH
  35     version 1.7, Aug 1997        Expanded file tabs to spaces.
  36                                  NOTE: future authors should be sure to have
  37                                  their editors set to automatically expand tabs
  38                                  to spaces (original tab setting was 4 spaces).
  39     version 1.7, Sept 1997       Added job control values
  40                                  Added return codes
  41     version 1.7, Sept 1997       changed definition of pRGBRESPONSE to
  42                                  pTW_RGBRESPONSE
  43     version 1.7  Aug 1998        Added missing TWEI_BARCODEROTATION values
  44                                  TWBCOR_ types JMH
  45     version 1.8  August 1998     Added new types and definitions required
  46                                  for 1.8 Specification JMH
  47     version 1.8  January 1999    Changed search mode from SRCH_ to TWBD_ as
  48                                  in 1.8 Specification, added TWBT_MAXICODE      JMH
  49     version 1.8  January 1999    Removed undocumented duplicate AUTO<cap> JMH
  50 \* ======================================================================== */
  51
  52 #ifndef TWAIN
  53 #define TWAIN
  54
  55 #include <stdarg.h>
  56
  57 #include "windef.h"
  58 #include "winbase.h"
  59
  60 /* The Twain structures must be packed on 2 byte alignment */
  61 #include "pshpack2.h"
  62
  63 #undef FAR
  64 #define FAR
  65
  66 /****************************************************************************
  67  * TWAIN Version                                                            *
  68  ****************************************************************************/
  69 #define TWON_PROTOCOLMINOR   8        /* Changed for Version 1.8            */
  70 #define TWON_PROTOCOLMAJOR   1
  71
  72 /****************************************************************************
  73  * Platform Dependent Definitions and Typedefs                              *
  74  ****************************************************************************/
  75
  76 /* Define one of the following, depending on the platform */
  77 /* #define _MAC_   */
  78 /* #define _UNIX_  */
  79 #define _MSWIN_
  80
  81 #ifdef  _MSWIN_
  82     typedef HANDLE         TW_HANDLE;
  83     typedef LPVOID         TW_MEMREF;
  84     typedef BYTE         * HPBYTE;
  85     typedef void         * HPVOID;
  86 #endif  /* _MSWIN_ */
  87
  88 #ifdef  _MAC_
  89 #define PASCAL         pascal
  90 #define FAR
  91     typedef Handle         TW_HANDLE;
  92     typedef char          *TW_MEMREF;
  93 #endif  /* _MAC_ */
  94
  95 #ifdef  _UNIX_
  96 /*    #define PASCAL         pascal */
  97 #define FAR
  98     typedef unsigned char *TW_HANDLE;
  99     typedef unsigned char *TW_MEMREF;
 100 #endif  /* _UNIX_ */
 101
 102 /****************************************************************************
 103  * Type Definitions                                                         *
 104  ****************************************************************************/
 105
 106 /* String types. These include room for the strings and a NULL char,     *
 107  * or, on the Mac, a length byte followed by the string.                 *
 108  * TW_STR255 must hold less than 256 chars so length fits in first byte. */
 109 typedef char    TW_STR32[34],     FAR *pTW_STR32;
 110 typedef char    TW_STR64[66],     FAR *pTW_STR64;
 111 typedef char    TW_STR128[130],   FAR *pTW_STR128;
 112 typedef char    TW_STR255[256],   FAR *pTW_STR255;
 113
 114 /* Numeric types. */
 115 typedef char           TW_INT8,   FAR *pTW_INT8;
 116 typedef short          TW_INT16,  FAR *pTW_INT16;
 117 typedef LONG           TW_INT32,  FAR *pTW_INT32;
 118 typedef unsigned char  TW_UINT8,  FAR *pTW_UINT8;
 119 typedef unsigned short TW_UINT16, FAR *pTW_UINT16;
 120 typedef ULONG          TW_UINT32, FAR *pTW_UINT32;
 121 typedef unsigned short TW_BOOL,   FAR *pTW_BOOL;
 122
 123 /* Fixed point structure type. */
 124 typedef struct {
 125     TW_INT16     Whole;        /* maintains the sign */
 126     TW_UINT16    Frac;
 127 } TW_FIX32,  FAR *pTW_FIX32;
 128
 129 /****************************************************************************
 130  * Structure Definitions                                                    *
 131  ****************************************************************************/
 132
 133 /* No DAT needed. */
 134 typedef struct {
 135    TW_FIX32   X;
 136    TW_FIX32   Y;
 137    TW_FIX32   Z;
 138 } TW_CIEPOINT, FAR * pTW_CIEPOINT;
 139
 140 /* No DAT needed. */
 141 typedef struct {
 142    TW_FIX32   StartIn;
 143    TW_FIX32   BreakIn;
 144    TW_FIX32   EndIn;
 145    TW_FIX32   StartOut;
 146    TW_FIX32   BreakOut;
 147    TW_FIX32   EndOut;
 148    TW_FIX32   Gamma;
 149    TW_FIX32   SampleCount;  /* if =0 use the gamma */
 150 } TW_DECODEFUNCTION, FAR * pTW_DECODEFUNCTION;
 151
 152 /* No DAT needed. */
 153 typedef struct {
 154    TW_UINT8    Index;    /* Value used to index into the color table. */
 155    TW_UINT8    Channel1; /* First  tri-stimulus value (e.g Red)       */
 156    TW_UINT8    Channel2; /* Second tri-stimulus value (e.g Green)     */
 157    TW_UINT8    Channel3; /* Third  tri-stimulus value (e.g Blue)      */
 158 } TW_ELEMENT8, FAR * pTW_ELEMENT8;
 159
 160 /* No DAT.  Defines a frame rectangle in ICAP_UNITS coordinates. */
 161 typedef struct {
 162    TW_FIX32   Left;
 163    TW_FIX32   Top;
 164    TW_FIX32   Right;
 165    TW_FIX32   Bottom;
 166 } TW_FRAME, FAR * pTW_FRAME;
 167
 168 /* No DAT needed.  Used to manage memory buffers. */
 169 typedef struct {
 170    TW_UINT32  Flags;  /* Any combination of the TWMF_ constants.           */
 171    TW_UINT32  Length; /* Number of bytes stored in buffer TheMem.          */
 172    TW_MEMREF  TheMem; /* Pointer or handle to the allocated memory buffer. */
 173 } TW_MEMORY, FAR * pTW_MEMORY;
 174
 175 /* No DAT needed. */
 176 typedef struct {
 177    TW_DECODEFUNCTION   Decode[3];
 178    TW_FIX32            Mix[3][3];
 179 } TW_TRANSFORMSTAGE, FAR * pTW_TRANSFORMSTAGE;
 180
 181 /* No DAT needed.  Describes version of software currently running. */
 182 typedef struct {
 183    TW_UINT16  MajorNum;  /* Major revision number of the software. */
 184    TW_UINT16  MinorNum;  /* Incremental revision number of the software. */
 185    TW_UINT16  Language;  /* e.g. TWLG_SWISSFRENCH */
 186    TW_UINT16  Country;   /* e.g. TWCY_SWITZERLAND */
 187    TW_STR32   Info;      /* e.g. "1.0b3 Beta release" */
 188 } TW_VERSION, FAR * pTW_VERSION;
 189
 190 /* TWON_ARRAY. Container for array of values (a simplified TW_ENUMERATION) */
 191 typedef struct {
 192    TW_UINT16  ItemType;
 193    TW_UINT32  NumItems;    /* How many items in ItemList           */
 194    TW_UINT8   ItemList[1]; /* Array of ItemType values starts here */
 195 } TW_ARRAY, FAR * pTW_ARRAY;
 196
 197 /* TWON_ENUMERATION. Container for a collection of values. */
 198 typedef struct {
 199    TW_UINT16  ItemType;
 200    TW_UINT32  NumItems;     /* How many items in ItemList                 */
 201    TW_UINT32  CurrentIndex; /* Current value is in ItemList[CurrentIndex] */
 202    TW_UINT32  DefaultIndex; /* Powerup value is in ItemList[DefaultIndex] */
 203    TW_UINT8   ItemList[1];  /* Array of ItemType values starts here       */
 204 } TW_ENUMERATION, FAR * pTW_ENUMERATION;
 205
 206 /* TWON_ONEVALUE. Container for one value. */
 207 typedef struct {
 208    TW_UINT16  ItemType;
 209    TW_UINT32  Item;
 210 } TW_ONEVALUE, FAR * pTW_ONEVALUE;
 211
 212 /* TWON_RANGE. Container for a range of values. */
 213 typedef struct {
 214    TW_UINT16  ItemType;
 215    TW_UINT32  MinValue;     /* Starting value in the range.           */
 216    TW_UINT32  MaxValue;     /* Final value in the range.              */
 217    TW_UINT32  StepSize;     /* Increment from MinValue to MaxValue.   */
 218    TW_UINT32  DefaultValue; /* Power-up value.                        */
 219    TW_UINT32  CurrentValue; /* The value that is currently in effect. */
 220 } TW_RANGE, FAR * pTW_RANGE;
 221
 222 /* DAT_CAPABILITY. Used by application to get/set capability from/in a data source. */
 223 typedef struct {
 224    TW_UINT16  Cap; /* id of capability to set or get, e.g. CAP_BRIGHTNESS */
 225    TW_UINT16  ConType; /* TWON_ONEVALUE, _RANGE, _ENUMERATION or _ARRAY   */
 226    TW_HANDLE  hContainer; /* Handle to container of type Dat              */
 227 } TW_CAPABILITY, FAR * pTW_CAPABILITY;
 228
 229 /* DAT_CIECOLOR. */
 230 typedef struct {
 231    TW_UINT16           ColorSpace;
 232    TW_INT16            LowEndian;
 233    TW_INT16            DeviceDependent;
 234    TW_INT32            VersionNumber;
 235    TW_TRANSFORMSTAGE   StageABC;
 236    TW_TRANSFORMSTAGE   StageLMN;
 237    TW_CIEPOINT         WhitePoint;
 238    TW_CIEPOINT         BlackPoint;
 239    TW_CIEPOINT         WhitePaper;
 240    TW_CIEPOINT         BlackInk;
 241    TW_FIX32            Samples[1];
 242 } TW_CIECOLOR, FAR * pTW_CIECOLOR;
 243
 244 /* DAT_EVENT. For passing events down from the application to the DS. */
 245 typedef struct {
 246    TW_MEMREF  pEvent;    /* Windows pMSG or Mac pEvent.                 */
 247    TW_UINT16  TWMessage; /* TW msg from data source, e.g. MSG_XFERREADY */
 248 } TW_EVENT, FAR * pTW_EVENT;
 249
 250 /* DAT_GRAYRESPONSE */
 251 typedef struct {
 252    TW_ELEMENT8         Response[1];
 253 } TW_GRAYRESPONSE, FAR * pTW_GRAYRESPONSE;
 254
 255 /* DAT_IDENTITY. Identifies the program/library/code resource. */
 256 typedef struct {
 257    TW_UINT32  Id;              /* Unique number.  In Windows, application hWnd      */
 258    TW_VERSION Version;         /* Identifies the piece of code              */
 259    TW_UINT16  ProtocolMajor;   /* Application and DS must set to TWON_PROTOCOLMAJOR */
 260    TW_UINT16  ProtocolMinor;   /* Application and DS must set to TWON_PROTOCOLMINOR */
 261    TW_UINT32  SupportedGroups; /* Bit field OR combination of DG_ constants */
 262    TW_STR32   Manufacturer;    /* Manufacturer name, e.g. "Hewlett-Packard" */
 263    TW_STR32   ProductFamily;   /* Product family name, e.g. "ScanJet"       */
 264    TW_STR32   ProductName;     /* Product name, e.g. "ScanJet Plus"         */
 265 } TW_IDENTITY, FAR * pTW_IDENTITY;
 266
 267 /* DAT_IMAGEINFO. Application gets detailed image info from DS with this. */
 268 typedef struct {
 269    TW_FIX32   XResolution;      /* Resolution in the horizontal             */
 270    TW_FIX32   YResolution;      /* Resolution in the vertical               */
 271    TW_INT32   ImageWidth;       /* Columns in the image, -1 if unknown by DS*/
 272    TW_INT32   ImageLength;      /* Rows in the image, -1 if unknown by DS   */
 273    TW_INT16   SamplesPerPixel;  /* Number of samples per pixel, 3 for RGB   */
 274    TW_INT16   BitsPerSample[8]; /* Number of bits for each sample           */
 275    TW_INT16   BitsPerPixel;     /* Number of bits for each padded pixel     */
 276    TW_BOOL    Planar;           /* True if Planar, False if chunky          */
 277    TW_INT16   PixelType;        /* How to interp data; photo interp (TWPT_) */
 278    TW_UINT16  Compression;      /* How the data is compressed (TWCP_xxxx)   */
 279 } TW_IMAGEINFO, FAR * pTW_IMAGEINFO;
 280
 281 /* DAT_IMAGELAYOUT. Provides image layout information in current units. */
 282 typedef struct {
 283    TW_FRAME   Frame;          /* Frame coords within larger document */
 284    TW_UINT32  DocumentNumber;
 285    TW_UINT32  PageNumber;     /* Reset when you go to next document  */
 286    TW_UINT32  FrameNumber;    /* Reset when you go to next page      */
 287 } TW_IMAGELAYOUT, FAR * pTW_IMAGELAYOUT;
 288
 289 /* DAT_IMAGEMEMXFER. Used to pass image data (e.g. in strips) from DS to application.*/
 290 typedef struct {
 291    TW_UINT16  Compression;  /* How the data is compressed                */
 292    TW_UINT32  BytesPerRow;  /* Number of bytes in a row of data          */
 293    TW_UINT32  Columns;      /* How many columns                          */
 294    TW_UINT32  Rows;         /* How many rows                             */
 295    TW_UINT32  XOffset;      /* How far from the side of the image        */
 296    TW_UINT32  YOffset;      /* How far from the top of the image         */
 297    TW_UINT32  BytesWritten; /* How many bytes written in Memory          */
 298    TW_MEMORY  Memory;       /* Mem struct used to pass actual image data */
 299 } TW_IMAGEMEMXFER, FAR * pTW_IMAGEMEMXFER;
 300
 301 /* Changed in 1.1: QuantTable, HuffmanDC, HuffmanAC TW_MEMREF -> TW_MEMORY  */
 302 /* DAT_JPEGCOMPRESSION. Based on JPEG Draft International Std, ver 10918-1. */
 303 typedef struct {
 304    TW_UINT16   ColorSpace;       /* One of the TWPT_xxxx values                */
 305    TW_UINT32   SubSampling;      /* Two word "array" for subsampling values    */
 306    TW_UINT16   NumComponents;    /* Number of color components in image        */
 307    TW_UINT16   RestartFrequency; /* Frequency of restart marker codes in MDU's */
 308    TW_UINT16   QuantMap[4];      /* Mapping of components to QuantTables       */
 309    TW_MEMORY   QuantTable[4];    /* Quantization tables                        */
 310    TW_UINT16   HuffmanMap[4];    /* Mapping of components to Huffman tables    */
 311    TW_MEMORY   HuffmanDC[2];     /* DC Huffman tables                          */
 312    TW_MEMORY   HuffmanAC[2];     /* AC Huffman tables                          */
 313 } TW_JPEGCOMPRESSION, FAR * pTW_JPEGCOMPRESSION;
 314
 315 /* DAT_PALETTE8. Color palette when TWPT_PALETTE pixels xfer'd in mem buf. */
 316 typedef struct {
 317    TW_UINT16    NumColors;   /* Number of colors in the color table.  */
 318    TW_UINT16    PaletteType; /* TWPA_xxxx, specifies type of palette. */
 319    TW_ELEMENT8  Colors[256]; /* Array of palette values starts here.  */
 320 } TW_PALETTE8, FAR * pTW_PALETTE8;
 321
 322 /* DAT_PENDINGXFERS. Used with MSG_ENDXFER to indicate additional data. */
 323 typedef struct {
 324    TW_UINT16 Count;
 325    union {
 326       TW_UINT32 EOJ;
 327       TW_UINT32 Reserved;
 328    } u;
 329 } TW_PENDINGXFERS, FAR *pTW_PENDINGXFERS;
 330
 331 /* DAT_RGBRESPONSE */
 332 typedef struct {
 333    TW_ELEMENT8         Response[1];
 334 } TW_RGBRESPONSE, FAR * pTW_RGBRESPONSE;
 335
 336 /* DAT_SETUPFILEXFER. Sets up DS to application data transfer via a file. */
 337 typedef struct {
 338    TW_STR255 FileName;
 339    TW_UINT16 Format;   /* Any TWFF_ constant */
 340    TW_INT16  VRefNum;  /* Used for Mac only  */
 341 } TW_SETUPFILEXFER, FAR * pTW_SETUPFILEXFER;
 342
 343 /* DAT_SETUPMEMXFER. Sets up DS to application data transfer via a memory buffer. */
 344 typedef struct {
 345    TW_UINT32 MinBufSize;
 346    TW_UINT32 MaxBufSize;
 347    TW_UINT32 Preferred;
 348 } TW_SETUPMEMXFER, FAR * pTW_SETUPMEMXFER;
 349
 350 /* DAT_STATUS. Application gets detailed status info from a data source with this. */
 351 typedef struct {
 352    TW_UINT16  ConditionCode; /* Any TWCC_ constant     */
 353    TW_UINT16  Reserved;      /* Future expansion space */
 354 } TW_STATUS, FAR * pTW_STATUS;
 355
 356 /* DAT_USERINTERFACE. Coordinates UI between application and data source. */
 357 typedef struct {
 358    TW_BOOL    ShowUI;  /* TRUE if DS should bring up its UI           */
 359    TW_BOOL    ModalUI; /* For Mac only - true if the DS's UI is modal */
 360    TW_HANDLE  hParent; /* For windows only - Application window handle        */
 361 } TW_USERINTERFACE, FAR * pTW_USERINTERFACE;
 362
 363 /* SDH - 03/21/95 - TWUNK */
 364 /* DAT_TWUNKIDENTITY. Provides DS identity and 'other' information necessary */
 365 /*                    across thunk link. */
 366 typedef struct {
 367    TW_IDENTITY identity;        /* Identity of data source.                 */
 368    TW_STR255   dsPath;          /* Full path and file name of data source.  */
 369 } TW_TWUNKIDENTITY, FAR * pTW_TWUNKIDENTITY;
 370
 371 /* SDH - 03/21/95 - TWUNK */
 372 /* Provides DS_Entry parameters over thunk link. */
 373 typedef struct
 374 {
 375     TW_INT8     destFlag;       /* TRUE if dest is not NULL                 */
 376     TW_IDENTITY dest;           /* Identity of data source (if used)        */
 377     TW_INT32    dataGroup;      /* DSM_Entry dataGroup parameter            */
 378     TW_INT16    dataArgType;    /* DSM_Entry dataArgType parameter          */
 379     TW_INT16    message;        /* DSM_Entry message parameter              */
 380     TW_INT32    pDataSize;      /* Size of pData (0 if NULL)                */
 381     /*  TW_MEMREF   pData; */   /* Based on implementation specifics, a     */
 382                                 /* pData parameter makes no sense in this   */
 383                                 /* structure, but data (if provided) will be*/
 384                                 /* appended in the data block.              */
 385    } TW_TWUNKDSENTRYPARAMS, FAR * pTW_TWUNKDSENTRYPARAMS;
 386
 387 /* SDH - 03/21/95 - TWUNK */
 388 /* Provides DS_Entry results over thunk link. */
 389 typedef struct
 390 {
 391     TW_UINT16   returnCode;     /* Thunker DsEntry return code.             */
 392     TW_UINT16   conditionCode;  /* Thunker DsEntry condition code.          */
 393     TW_INT32    pDataSize;      /* Size of pData (0 if NULL)                */
 394     /*  TW_MEMREF   pData; */   /* Based on implementation specifics, a     */
 395                                 /* pData parameter makes no sense in this   */
 396                                 /* structure, but data (if provided) will be*/
 397                                 /* appended in the data block.              */
 398 } TW_TWUNKDSENTRYRETURN, FAR * pTW_TWUNKDSENTRYRETURN;
 399
 400 /* WJD - 950818 */
 401 /* Added for 1.6 Specification */
 402 /* TWAIN 1.6 CAP_SUPPORTEDCAPSEXT structure */
 403 typedef struct
 404 {
 405     TW_UINT16 Cap;   /* Which CAP/ICAP info is relevant to */
 406     TW_UINT16 Properties;  /* Messages this CAP/ICAP supports */
 407 } TW_CAPEXT, FAR * pTW_CAPEXT;
 408
 409 /* ----------------------------------------------------------------------- *\
 410
 411   Version 1.7:      Added Following data structure for Document Imaging
 412   July 1997         Enhancement.
 413   KHL               TW_CUSTOMDSDATA --  For Saving and Restoring Source's
 414                                         state.
 415                     TW_INFO         --  Each attribute for extended image
 416                                         information.
 417                     TW_EXTIMAGEINFO --  Extended image information structure.
 418
 419 \* ----------------------------------------------------------------------- */
 420
 421 typedef struct {
 422     TW_UINT32  InfoLength;     /* Length of Information in bytes.  */
 423     TW_HANDLE  hData;          /* Place holder for data, DS Allocates */
 424 }TW_CUSTOMDSDATA, FAR *pTW_CUSTOMDSDATA;
 425
 426 typedef struct {
 427     TW_UINT16   InfoID;
 428     TW_UINT16   ItemType;
 429     TW_UINT16   NumItems;
 430     TW_UINT16   CondCode;
 431     TW_UINT32   Item;
 432 }TW_INFO, FAR* pTW_INFO;
 433
 434 typedef struct {
 435     TW_UINT32   NumInfos;
 436     TW_INFO     Info[1];
 437 }TW_EXTIMAGEINFO, FAR* pTW_EXTIMAGEINFO;
 438
 439 /* Added 1.8 */
 440
 441 /* DAT_AUDIOINFO, information about audio data */
 442 typedef struct {
 443    TW_STR255  Name;       /* name of audio data */
 444    TW_UINT32  Reserved;   /* reserved space */
 445 } TW_AUDIOINFO, FAR * pTW_AUDIOINFO;
 446
 447 /* DAT_DEVICEEVENT, information about events */
 448 typedef struct {
 449    TW_UINT32  Event;                  /* One of the TWDE_xxxx values. */
 450    TW_STR255  DeviceName;             /* The name of the device that generated the event */
 451    TW_UINT32  BatteryMinutes;         /* Battery Minutes Remaining    */
 452    TW_INT16   BatteryPercentage;      /* Battery Percentage Remaining */
 453    TW_INT32   PowerSupply;            /* Power Supply                 */
 454    TW_FIX32   XResolution;            /* Resolution                   */
 455    TW_FIX32   YResolution;            /* Resolution                   */
 456    TW_UINT32  FlashUsed2;             /* Flash Used2                  */
 457    TW_UINT32  AutomaticCapture;       /* Automatic Capture            */
 458    TW_UINT32  TimeBeforeFirstCapture; /* Automatic Capture            */
 459    TW_UINT32  TimeBetweenCaptures;    /* Automatic Capture            */
 460 } TW_DEVICEEVENT, FAR * pTW_DEVICEEVENT;
 461
 462 /* DAT_FILESYSTEM, information about TWAIN file system */
 463 typedef struct {
 464    /* DG_CONTROL / DAT_FILESYSTEM / MSG_xxxx fields     */
 465    TW_STR255  InputName; /* The name of the input or source file */
 466    TW_STR255  OutputName; /* The result of an operation or the name of a destination file */
 467    TW_MEMREF  Context; /* Source specific data used to remember state information */
 468    /* DG_CONTROL / DAT_FILESYSTEM / MSG_DELETE field    */
 469    int        Recursive; /* recursively delete all sub-directories */
 470    /* DG_CONTROL / DAT_FILESYSTEM / MSG_GETINFO fields  */
 471    TW_INT32   FileType; /* One of the TWFT_xxxx values */
 472    TW_UINT32  Size; /* Size of current FileType */
 473    TW_STR32   CreateTimeDate; /* creation date of the file */
 474    TW_STR32   ModifiedTimeDate; /* last date the file was modified */
 475    TW_UINT32  FreeSpace; /* bytes of free space on the current device */
 476    TW_INT32   NewImageSize; /* estimate of the amount of space a new image would take up */
 477    TW_UINT32  NumberOfFiles; /* number of files, depends on FileType */
 478    TW_UINT32  NumberOfSnippets; /**/
 479    char       Reserved[512]; /**/
 480 } TW_FILESYSTEM, FAR * pTW_FILESYSTEM;
 481
 482 /* DAT_PASSTHRU, device dependent data to pass through Data Source */
 483 typedef struct {
 484    TW_MEMREF  pCommand;        /* Pointer to Command buffer */
 485    TW_UINT32  CommandBytes;    /* Number of bytes in Command buffer */
 486    TW_INT32   Direction;       /* One of the TWDR_xxxx values.  Defines the direction of data flow */
 487    TW_MEMREF  pData;           /* Pointer to Data buffer */
 488    TW_UINT32  DataBytes;       /* Number of bytes in Data buffer */
 489    TW_UINT32  DataBytesXfered; /* Number of bytes successfully transferred */
 490 } TW_PASSTHRU, FAR * pTW_PASSTHRU;
 491
 492 /* DAT_SETUPAUDIOFILEXFER, information required to setup an audio file transfer */
 493 typedef struct {
 494    TW_STR255  FileName; /* full path target file */
 495    TW_UINT16  Format;   /* one of TWAF_xxxx */
 496    TW_INT16 VRefNum;
 497 } TW_SETUPAUDIOFILEXFER, FAR * pTW_SETUPAUDIOFILEXFER;
 498
 499 /****************************************************************************
 500  * Generic Constants                                                        *
 501  ****************************************************************************/
 502
 503 #define TWON_ARRAY           3 /* indicates TW_ARRAY container       */
 504 #define TWON_ENUMERATION     4 /* indicates TW_ENUMERATION container */
 505 #define TWON_ONEVALUE        5 /* indicates TW_ONEVALUE container    */
 506 #define TWON_RANGE           6 /* indicates TW_RANGE container       */
 507
 508 #define TWON_ICONID          962 /* res Id of icon used in USERSELECT lbox */
 509 #define TWON_DSMID           461 /* res Id of the DSM version num resource */
 510 #define TWON_DSMCODEID       63  /* res Id of the Mac SM Code resource     */
 511
 512 #define TWON_DONTCARE8       0xff
 513 #define TWON_DONTCARE16      0xffff
 514 #define TWON_DONTCARE32      0xffffffff
 515
 516 /* Flags used in TW_MEMORY structure. */
 517 #define TWMF_APPOWNS     0x1
 518 #define TWMF_DSMOWNS     0x2
 519 #define TWMF_DSOWNS      0x4
 520 #define TWMF_POINTER     0x8
 521 #define TWMF_HANDLE      0x10
 522
 523 /* Palette types for TW_PALETTE8 */
 524 #define TWPA_RGB         0
 525 #define TWPA_GRAY        1
 526 #define TWPA_CMY         2
 527
 528 /* There are four containers used for capabilities negotiation:
 529  *    TWON_ONEVALUE, TWON_RANGE, TWON_ENUMERATION, TWON_ARRAY
 530  * In each container structure ItemType can be TWTY_INT8, TWTY_INT16, etc.
 531  * The kind of data stored in the container can be determined by doing
 532  * DCItemSize[ItemType] where the following is defined in TWAIN glue code:
 533  *          DCItemSize[]= { sizeof(TW_INT8),
 534  *                          sizeof(TW_INT16),
 535  *                          etc.
 536  *                          sizeof(TW_UINT32) };
 537  *
 538  */
 539
 540 #define TWTY_INT8        0x0000    /* Means Item is a TW_INT8   */
 541 #define TWTY_INT16       0x0001    /* Means Item is a TW_INT16  */
 542 #define TWTY_INT32       0x0002    /* Means Item is a TW_INT32  */
 543
 544 #define TWTY_UINT8       0x0003    /* Means Item is a TW_UINT8  */
 545 #define TWTY_UINT16      0x0004    /* Means Item is a TW_UINT16 */
 546 #define TWTY_UINT32      0x0005    /* Means Item is a TW_UINT32 */
 547
 548 #define TWTY_BOOL        0x0006    /* Means Item is a TW_BOOL   */
 549
 550 #define TWTY_FIX32       0x0007    /* Means Item is a TW_FIX32  */
 551
 552 #define TWTY_FRAME       0x0008    /* Means Item is a TW_FRAME  */
 553
 554 #define TWTY_STR32       0x0009    /* Means Item is a TW_STR32  */
 555 #define TWTY_STR64       0x000a    /* Means Item is a TW_STR64  */
 556 #define TWTY_STR128      0x000b    /* Means Item is a TW_STR128 */
 557 #define TWTY_STR255      0x000c    /* Means Item is a TW_STR255 */
 558
 559 /****************************************************************************
 560  * Capability Constants                                                     *
 561  ****************************************************************************/
 562
 563 /* ICAP_BITORDER values (BO_ means Bit Order) */
 564 #define TWBO_LSBFIRST    0
 565 #define TWBO_MSBFIRST    1
 566
 567 /* ICAP_COMPRESSION values (CP_ means ComPression ) */
 568 #define TWCP_NONE        0
 569 #define TWCP_PACKBITS    1
 570 #define TWCP_GROUP31D    2 /* Follows CCITT spec (no End Of Line)          */
 571 #define TWCP_GROUP31DEOL 3 /* Follows CCITT spec (has End Of Line)         */
 572 #define TWCP_GROUP32D    4 /* Follows CCITT spec (use cap for K Factor)    */
 573 #define TWCP_GROUP4      5 /* Follows CCITT spec                           */
 574 #define TWCP_JPEG        6 /* Use capability for more info                 */
 575 #define TWCP_LZW         7 /* Must license from Unisys and IBM to use      */
 576 #define TWCP_JBIG        8 /* For Bitonal images  -- Added 1.7 KHL         */
 577 /* Added 1.8 */
 578 #define TWCP_PNG         9
 579 #define TWCP_RLE4        10
 580 #define TWCP_RLE8        11
 581 #define TWCP_BITFIELDS   12
 582
 583
 584 /* ICAP_IMAGEFILEFORMAT values (FF_means File Format)   */
 585 #define TWFF_TIFF        0    /* Tagged Image File Format     */
 586 #define TWFF_PICT        1    /* Macintosh PICT               */
 587 #define TWFF_BMP         2    /* Windows Bitmap               */
 588 #define TWFF_XBM         3    /* X-Windows Bitmap             */
 589 #define TWFF_JFIF        4    /* JPEG File Interchange Format */
 590 #define TWFF_FPX         5    /* Flash Pix                    */
 591 #define TWFF_TIFFMULTI   6    /* Multi-page tiff file         */
 592 #define TWFF_PNG         7
 593 #define TWFF_SPIFF       8
 594 #define TWFF_EXIF        9
 595
 596
 597 /* ICAP_FILTER values (FT_ means Filter Type) */
 598 #define TWFT_RED         0
 599 #define TWFT_GREEN       1
 600 #define TWFT_BLUE        2
 601 #define TWFT_NONE        3
 602 #define TWFT_WHITE       4
 603 #define TWFT_CYAN        5
 604 #define TWFT_MAGENTA     6
 605 #define TWFT_YELLOW      7
 606 #define TWFT_BLACK       8
 607
 608 /* ICAP_LIGHTPATH values (LP_ means Light Path) */
 609 #define TWLP_REFLECTIVE   0
 610 #define TWLP_TRANSMISSIVE 1
 611
 612 /* ICAP_LIGHTSOURCE values (LS_ means Light Source) */
 613 #define TWLS_RED         0
 614 #define TWLS_GREEN       1
 615 #define TWLS_BLUE        2
 616 #define TWLS_NONE        3
 617 #define TWLS_WHITE       4
 618 #define TWLS_UV          5
 619 #define TWLS_IR          6
 620
 621 /* ICAP_ORIENTATION values (OR_ means ORientation) */
 622 #define TWOR_ROT0        0
 623 #define TWOR_ROT90       1
 624 #define TWOR_ROT180      2
 625 #define TWOR_ROT270      3
 626 #define TWOR_PORTRAIT    TWOR_ROT0
 627 #define TWOR_LANDSCAPE   TWOR_ROT270
 628
 629 /* ICAP_PLANARCHUNKY values (PC_ means Planar/Chunky ) */
 630 #define TWPC_CHUNKY      0
 631 #define TWPC_PLANAR      1
 632
 633 /* ICAP_PIXELFLAVOR values (PF_ means Pixel Flavor) */
 634 #define TWPF_CHOCOLATE   0  /* zero pixel represents darkest shade  */
 635 #define TWPF_VANILLA     1  /* zero pixel represents lightest shade */
 636
 637 /* ICAP_PIXELTYPE values (PT_ means Pixel Type) */
 638 #define TWPT_BW          0 /* Black and White */
 639 #define TWPT_GRAY        1
 640 #define TWPT_RGB         2
 641 #define TWPT_PALETTE     3
 642 #define TWPT_CMY         4
 643 #define TWPT_CMYK        5
 644 #define TWPT_YUV         6
 645 #define TWPT_YUVK        7
 646 #define TWPT_CIEXYZ      8
 647
 648 /* ICAP_SUPPORTEDSIZES values (SS_ means Supported Sizes) */
 649 #define TWSS_NONE        0
 650 #define TWSS_A4LETTER    1
 651 #define TWSS_B5LETTER    2
 652 #define TWSS_USLETTER    3
 653 #define TWSS_USLEGAL     4
 654 /* Added 1.5 */
 655 #define TWSS_A5          5
 656 #define TWSS_B4          6
 657 #define TWSS_B6          7
 658 /*#define TWSS_B          8 */
 659 /* Added 1.7 */
 660 #define TWSS_USLEDGER    9
 661 #define TWSS_USEXECUTIVE 10
 662 #define TWSS_A3          11
 663 #define TWSS_B3          12
 664 #define TWSS_A6          13
 665 #define TWSS_C4          14
 666 #define TWSS_C5          15
 667 #define TWSS_C6          16
 668 /* Added 1.8 */
 669 #define TWSS_4A0          17
 670 #define TWSS_2A0          18
 671 #define TWSS_A0           19
 672 #define TWSS_A1           20
 673 #define TWSS_A2           21
 674 #define TWSS_A4           TWSS_A4LETTER
 675 #define TWSS_A7           22
 676 #define TWSS_A8           23
 677 #define TWSS_A9           24
 678 #define TWSS_A10          25
 679 #define TWSS_ISOB0        26
 680 #define TWSS_ISOB1        27
 681 #define TWSS_ISOB2        28
 682 #define TWSS_ISOB3        TWSS_B3
 683 #define TWSS_ISOB4        TWSS_B4
 684 #define TWSS_ISOB5        29
 685 #define TWSS_ISOB6        TWSS_B6
 686 #define TWSS_ISOB7        30
 687 #define TWSS_ISOB8        31
 688 #define TWSS_ISOB9        32
 689 #define TWSS_ISOB10       33
 690 #define TWSS_JISB0        34
 691 #define TWSS_JISB1        35
 692 #define TWSS_JISB2        36
 693 #define TWSS_JISB3        37
 694 #define TWSS_JISB4        38
 695 #define TWSS_JISB5        TWSS_B5LETTER
 696 #define TWSS_JISB6        39
 697 #define TWSS_JISB7        40
 698 #define TWSS_JISB8        41
 699 #define TWSS_JISB9        42
 700 #define TWSS_JISB10       43
 701 #define TWSS_C0           44
 702 #define TWSS_C1           45
 703 #define TWSS_C2           46
 704 #define TWSS_C3           47
 705 #define TWSS_C7           48
 706 #define TWSS_C8           49
 707 #define TWSS_C9           50
 708 #define TWSS_C10          51
 709 #define TWSS_USSTATEMENT  52
 710 #define TWSS_BUSINESSCARD 53
 711
 712 /* ICAP_XFERMECH values (SX_ means Setup XFer) */
 713 #define TWSX_NATIVE      0
 714 #define TWSX_FILE        1
 715 #define TWSX_MEMORY      2
 716
 717 /* ICAP_UNITS values (UN_ means UNits) */
 718 #define TWUN_INCHES      0
 719 #define TWUN_CENTIMETERS 1
 720 #define TWUN_PICAS       2
 721 #define TWUN_POINTS      3
 722 #define TWUN_TWIPS       4
 723 #define TWUN_PIXELS      5
 724
 725 /* Added 1.5 */
 726 /* ICAP_BITDEPTHREDUCTION values (BR_ means Bitdepth Reduction) */
 727 #define TWBR_THRESHOLD     0
 728 #define TWBR_HALFTONE      1
 729 #define TWBR_CUSTHALFTONE  2
 730 #define TWBR_DIFFUSION     3
 731
 732 /* Added 1.7 */
 733 /* ICAP_DUPLEX values */
 734 #define TWDX_NONE         0
 735 #define TWDX_1PASSDUPLEX  1
 736 #define TWDX_2PASSDUPLEX  2
 737
 738 /* Added 1.7 */
 739 /* TWEI_BARCODETYPE values */
 740 #define TWBT_3OF9                 0
 741 #define TWBT_2OF5INTERLEAVED      1
 742 #define TWBT_2OF5NONINTERLEAVED   2
 743 #define TWBT_CODE93               3
 744 #define TWBT_CODE128              4
 745 #define TWBT_UCC128               5
 746 #define TWBT_CODABAR              6
 747 #define TWBT_UPCA                 7
 748 #define TWBT_UPCE                 8
 749 #define TWBT_EAN8                 9
 750 #define TWBT_EAN13                10
 751 #define TWBT_POSTNET              11
 752 #define TWBT_PDF417               12
 753 /* Added 1.8 */
 754 #define TWBT_2OF5INDUSTRIAL       13
 755 #define TWBT_2OF5MATRIX           14
 756 #define TWBT_2OF5DATALOGIC        15
 757 #define TWBT_2OF5IATA             16
 758 #define TWBT_3OF9FULLASCII        17
 759 #define TWBT_CODABARWITHSTARTSTOP 18
 760 #define TWBT_MAXICODE             19
 761
 762 /* Added 1.7 */
 763 /* TWEI_DESKEWSTATUS values */
 764 #define TWDSK_SUCCESS     0
 765 #define TWDSK_REPORTONLY  1
 766 #define TWDSK_FAIL        2
 767 #define TWDSK_DISABLED    3
 768
 769 /* Added 1.7 */
 770 /* TWEI_PATCHCODE values */
 771 #define TWPCH_PATCH1      0
 772 #define TWPCH_PATCH2      1
 773 #define TWPCH_PATCH3      2
 774 #define TWPCH_PATCH4      3
 775 #define TWPCH_PATCH6      4
 776 #define TWPCH_PATCHT      5
 777
 778 /* Added 1.7 */
 779 /* CAP_JOBCONTROL values */
 780 #define TWJC_NONE   0
 781 #define TWJC_JSIC   1
 782 #define TWJC_JSIS   2
 783 #define TWJC_JSXC   3
 784 #define TWJC_JSXS   4
 785
 786 /* Added 1.7 */
 787 /* TWEI_BARCODEROTATION values (BCOR_ means barcode rotation) */
 788 #define TWBCOR_ROT0   0
 789 #define TWBCOR_ROT90  1
 790 #define TWBCOR_ROT180 2
 791 #define TWBCOR_ROT270 3
 792 #define TWBCOR_ROTX   4
 793
 794 /* Added 1.8 */
 795 /* ACAP_AUDIOFILEFORMAT values (AF_ means audio format) */
 796 #define TWAF_WAV      0
 797 #define TWAF_AIFF     1
 798 #define TWAF_AU       3
 799 #define TWAF_SND      4
 800
 801 /* CAP_ALARMS values (AL_ means alarms) */
 802 #define TWAL_ALARM          0
 803 #define TWAL_FEEDERERROR    1
 804 #define TWAL_FEEDERWARNING  2
 805 #define TWAL_BARCODE        3
 806 #define TWAL_DOUBLEFEED     4
 807 #define TWAL_JAM            5
 808 #define TWAL_PATCHCODE      6
 809 #define TWAL_POWER          7
 810 #define TWAL_SKEW           8
 811
 812 /* CAP_CLEARBUFFERS values (CB_ means clear buffers) */
 813 #define TWCB_AUTO           0
 814 #define TWCB_CLEAR          1
 815 #define TWCB_NOCLEAR        2
 816
 817 /* CAP_DEVICEEVENT values (DE_ means device event) */
 818 #define TWDE_CUSTOMEVENTS           0x8000
 819 #define TWDE_CHECKAUTOMATICCAPTURE  0
 820 #define TWDE_CHECKBATTERY           1
 821 #define TWDE_CHECKDEVICEONLINE      2
 822 #define TWDE_CHECKFLASH             3
 823 #define TWDE_CHECKPOWERSUPPLY       4
 824 #define TWDE_CHECKRESOLUTION        5
 825 #define TWDE_DEVICEADDED            6
 826 #define TWDE_DEVICEOFFLINE          7
 827 #define TWDE_DEVICEREADY            8
 828 #define TWDE_DEVICEREMOVED          9
 829 #define TWDE_IMAGECAPTURED          10
 830 #define TWDE_IMAGEDELETED           11
 831 #define TWDE_PAPERDOUBLEFEED        12
 832 #define TWDE_PAPERJAM               13
 833 #define TWDE_LAMPFAILURE            14
 834 #define TWDE_POWERSAVE              15
 835 #define TWDE_POWERSAVENOTIFY        16
 836
 837 /* CAP_FEEDERALIGNMENT values (FA_ means feeder alignment) */
 838 #define TWFA_NONE   0
 839 #define TWFA_LEFT   1
 840 #define TWFA_CENTER 2
 841 #define TWFA_RIGHT  3
 842
 843 /* CAP_FEEDERORDER values (FO_ means feeder order) */
 844 #define TWFO_FIRSTPAGEFIRST 0
 845 #define TWFO_LASTPAGEFIRST  1
 846
 847 /* CAP_FILESYSTEM values (FS_ means file system) */
 848 #define TWFS_FILESYSTEM       0
 849 #define TWFS_RECURSIVEDELETE  1
 850
 851 /* CAP_POWERSUPPLY values (PS_ means power supply) */
 852 #define TWPS_EXTERNAL 0
 853 #define TWPS_BATTERY  1
 854
 855 /* CAP_PRINTER values (PR_ means printer) */
 856 #define TWPR_IMPRINTERTOPBEFORE     0
 857 #define TWPR_IMPRINTERTOPAFTER      1
 858 #define TWPR_IMPRINTERBOTTOMBEFORE  2
 859 #define TWPR_IMPRINTERBOTTOMAFTER   3
 860 #define TWPR_ENDORSERTOPBEFORE      4
 861 #define TWPR_ENDORSERTOPAFTER       5
 862 #define TWPR_ENDORSERBOTTOMBEFORE   6
 863 #define TWPR_ENDORSERBOTTOMAFTER    7
 864
 865 /* CAP_PRINTERMODE values (PM_ means printer mode) */
 866 #define TWPM_SINGLESTRING     0
 867 #define TWPM_MULTISTRING      1
 868 #define TWPM_COMPOUNDSTRING   2
 869
 870 /* ICAP_BARCODESEARCHMODE values (TWBD_ means search) */
 871 #define TWBD_HORZ     0
 872 #define TWBD_VERT     1
 873 #define TWBD_HORZVERT 2
 874 #define TWBD_VERTHORZ 3
 875
 876 /* ICAP_FLASHUSED2 values (FL_ means flash) */
 877 #define TWFL_NONE     0
 878 #define TWFL_OFF      1
 879 #define TWFL_ON       2
 880 #define TWFL_AUTO     3
 881 #define TWFL_REDEYE   4
 882
 883 /* ICAP_FLIPROTATION values (FR_ means flip rotation) */
 884 #define TWFR_BOOK     0
 885 #define TWFR_FANFOLD  1
 886
 887 /* ICAP_IMAGEFILTER values (IF_ means image filter) */
 888 #define TWIF_NONE     0
 889 #define TWIF_AUTO     1
 890 #define TWIF_LOWPASS  2
 891 #define TWIF_BANDPASS 3
 892 #define TWIF_HIGHPASS 4
 893 #define TWIF_TEXT     TWIF_BANDPASS
 894 #define TWIF_FINELINE TWIF_HIGHPASS
 895
 896 /* ICAP_NOISEFILTER values (NF_ means noise filter) */
 897 #define TWNF_NONE         0
 898 #define TWNF_AUTO         1
 899 #define TWNF_LONEPIXEL    2
 900 #define TWNF_MAJORITYRULE 3
 901
 902 /* ICAP_OVERSCAN values (OV_ means overscan) */
 903 #define TWOV_NONE       0
 904 #define TWOV_AUTO       1
 905 #define TWOV_TOPBOTTOM  2
 906 #define TWOV_LEFTRIGHT  3
 907 #define TWOV_ALL        4
 908
 909 /* TW_FILESYSTEM.FileType values (FT_ means file type) */
 910 #define TWFY_CAMERA         0
 911 #define TWFY_CAMERATOP      1
 912 #define TWFY_CAMERABOTTOM   2
 913 #define TWFY_CAMERAPREVIEW  3
 914 #define TWFY_DOMAIN         4
 915 #define TWFY_HOST           5
 916 #define TWFY_DIRECTORY      6
 917 #define TWFY_IMAGE          7
 918 #define TWFY_UNKNOWN        8
 919
 920 /****************************************************************************
 921  * Country Constants                                                        *
 922  ****************************************************************************/
 923
 924 #define TWCY_AFGHANISTAN   1001
 925 #define TWCY_ALGERIA        213
 926 #define TWCY_AMERICANSAMOA  684
 927 #define TWCY_ANDORRA        033
 928 #define TWCY_ANGOLA        1002
 929 #define TWCY_ANGUILLA      8090
 930 #define TWCY_ANTIGUA       8091
 931 #define TWCY_ARGENTINA       54
 932 #define TWCY_ARUBA          297
 933 #define TWCY_ASCENSIONI     247
 934 #define TWCY_AUSTRALIA       61
 935 #define TWCY_AUSTRIA         43
 936 #define TWCY_BAHAMAS       8092
 937 #define TWCY_BAHRAIN        973
 938 #define TWCY_BANGLADESH     880
 939 #define TWCY_BARBADOS      8093
 940 #define TWCY_BELGIUM         32
 941 #define TWCY_BELIZE         501
 942 #define TWCY_BENIN          229
 943 #define TWCY_BERMUDA       8094
 944 #define TWCY_BHUTAN        1003
 945 #define TWCY_BOLIVIA        591
 946 #define TWCY_BOTSWANA       267
 947 #define TWCY_BRITAIN          6
 948 #define TWCY_BRITVIRGINIS  8095
 949 #define TWCY_BRAZIL          55
 950 #define TWCY_BRUNEI         673
 951 #define TWCY_BULGARIA       359
 952 #define TWCY_BURKINAFASO   1004
 953 #define TWCY_BURMA         1005
 954 #define TWCY_BURUNDI       1006
 955 #define TWCY_CAMAROON       237
 956 #define TWCY_CANADA           2
 957 #define TWCY_CAPEVERDEIS    238
 958 #define TWCY_CAYMANIS      8096
 959 #define TWCY_CENTRALAFREP  1007
 960 #define TWCY_CHAD          1008
 961 #define TWCY_CHILE           56
 962 #define TWCY_CHINA           86
 963 #define TWCY_CHRISTMASIS   1009
 964 #define TWCY_COCOSIS       1009
 965 #define TWCY_COLOMBIA        57
 966 #define TWCY_COMOROS       1010
 967 #define TWCY_CONGO         1011
 968 #define TWCY_COOKIS        1012
 969 #define TWCY_COSTARICA     506
 970 #define TWCY_CUBA           005
 971 #define TWCY_CYPRUS         357
 972 #define TWCY_CZECHOSLOVAKIA  42
 973 #define TWCY_DENMARK         45
 974 #define TWCY_DJIBOUTI      1013
 975 #define TWCY_DOMINICA      8097
 976 #define TWCY_DOMINCANREP   8098
 977 #define TWCY_EASTERIS      1014
 978 #define TWCY_ECUADOR        593
 979 #define TWCY_EGYPT           20
 980 #define TWCY_ELSALVADOR     503
 981 #define TWCY_EQGUINEA      1015
 982 #define TWCY_ETHIOPIA       251
 983 #define TWCY_FALKLANDIS    1016
 984 #define TWCY_FAEROEIS       298
 985 #define TWCY_FIJIISLANDS    679
 986 #define TWCY_FINLAND        358
 987 #define TWCY_FRANCE          33
 988 #define TWCY_FRANTILLES     596
 989 #define TWCY_FRGUIANA       594
 990 #define TWCY_FRPOLYNEISA    689
 991 #define TWCY_FUTANAIS      1043
 992 #define TWCY_GABON          241
 993 #define TWCY_GAMBIA         220
 994 #define TWCY_GERMANY         49
 995 #define TWCY_GHANA          233
 996 #define TWCY_GIBRALTER      350
 997 #define TWCY_GREECE          30
 998 #define TWCY_GREENLAND      299
 999 #define TWCY_GRENADA       8099
1000 #define TWCY_GRENEDINES    8015
1001 #define TWCY_GUADELOUPE     590
1002 #define TWCY_GUAM           671
1003 #define TWCY_GUANTANAMOBAY 5399
1004 #define TWCY_GUATEMALA      502
1005 #define TWCY_GUINEA         224
1006 #define TWCY_GUINEABISSAU  1017
1007 #define TWCY_GUYANA         592
1008 #define TWCY_HAITI          509
1009 #define TWCY_HONDURAS       504
1010 #define TWCY_HONGKONG      852
1011 #define TWCY_HUNGARY         36
1012 #define TWCY_ICELAND        354
1013 #define TWCY_INDIA           91
1014 #define TWCY_INDONESIA       62
1015 #define TWCY_IRAN            98
1016 #define TWCY_IRAQ           964
1017 #define TWCY_IRELAND        353
1018 #define TWCY_ISRAEL         972
1019 #define TWCY_ITALY           39
1020 #define TWCY_IVORYCOAST    225
1021 #define TWCY_JAMAICA       8010
1022 #define TWCY_JAPAN           81
1023 #define TWCY_JORDAN         962
1024 #define TWCY_KENYA          254
1025 #define TWCY_KIRIBATI      1018
1026 #define TWCY_KOREA           82
1027 #define TWCY_KUWAIT         965
1028 #define TWCY_LAOS          1019
1029 #define TWCY_LEBANON       1020
1030 #define TWCY_LIBERIA        231
1031 #define TWCY_LIBYA          218
1032 #define TWCY_LIECHTENSTEIN   41
1033 #define TWCY_LUXENBOURG     352
1034 #define TWCY_MACAO          853
1035 #define TWCY_MADAGASCAR    1021
1036 #define TWCY_MALAWI         265
1037 #define TWCY_MALAYSIA        60
1038 #define TWCY_MALDIVES       960
1039 #define TWCY_MALI          1022
1040 #define TWCY_MALTA          356
1041 #define TWCY_MARSHALLIS     692
1042 #define TWCY_MAURITANIA    1023
1043 #define TWCY_MAURITIUS      230
1044 #define TWCY_MEXICO           3
1045 #define TWCY_MICRONESIA     691
1046 #define TWCY_MIQUELON       508
1047 #define TWCY_MONACO          33
1048 #define TWCY_MONGOLIA      1024
1049 #define TWCY_MONTSERRAT    8011
1050 #define TWCY_MOROCCO        212
1051 #define TWCY_MOZAMBIQUE    1025
1052 #define TWCY_NAMIBIA        264
1053 #define TWCY_NAURU         1026
1054 #define TWCY_NEPAL          977
1055 #define TWCY_NETHERLANDS     31
1056 #define TWCY_NETHANTILLES   599
1057 #define TWCY_NEVIS         8012
1058 #define TWCY_NEWCALEDONIA   687
1059 #define TWCY_NEWZEALAND      64
1060 #define TWCY_NICARAGUA      505
1061 #define TWCY_NIGER          227
1062 #define TWCY_NIGERIA        234
1063 #define TWCY_NIUE          1027
1064 #define TWCY_NORFOLKI      1028
1065 #define TWCY_NORWAY          47
1066 #define TWCY_OMAN           968
1067 #define TWCY_PAKISTAN        92
1068 #define TWCY_PALAU         1029
1069 #define TWCY_PANAMA         507
1070 #define TWCY_PARAGUAY       595
1071 #define TWCY_PERU            51
1072 #define TWCY_PHILLIPPINES    63
1073 #define TWCY_PITCAIRNIS    1030
1074 #define TWCY_PNEWGUINEA     675
1075 #define TWCY_POLAND          48
1076 #define TWCY_PORTUGAL       351
1077 #define TWCY_QATAR          974
1078 #define TWCY_REUNIONI      1031
1079 #define TWCY_ROMANIA         40
1080 #define TWCY_RWANDA         250
1081 #define TWCY_SAIPAN         670
1082 #define TWCY_SANMARINO       39
1083 #define TWCY_SAOTOME       1033
1084 #define TWCY_SAUDIARABIA    966
1085 #define TWCY_SENEGAL        221
1086 #define TWCY_SEYCHELLESIS  1034
1087 #define TWCY_SIERRALEONE   1035
1088 #define TWCY_SINGAPORE       65
1089 #define TWCY_SOLOMONIS     1036
1090 #define TWCY_SOMALI        1037
1091 #define TWCY_SOUTHAFRICA    27
1092 #define TWCY_SPAIN           34
1093 #define TWCY_SRILANKA        94
1094 #define TWCY_STHELENA      1032
1095 #define TWCY_STKITTS       8013
1096 #define TWCY_STLUCIA       8014
1097 #define TWCY_STPIERRE       508
1098 #define TWCY_STVINCENT     8015
1099 #define TWCY_SUDAN         1038
1100 #define TWCY_SURINAME       597
1101 #define TWCY_SWAZILAND      268
1102 #define TWCY_SWEDEN          46
1103 #define TWCY_SWITZERLAND     41
1104 #define TWCY_SYRIA         1039
1105 #define TWCY_TAIWAN         886
1106 #define TWCY_TANZANIA       255
1107 #define TWCY_THAILAND        66
1108 #define TWCY_TOBAGO        8016
1109 #define TWCY_TOGO           228
1110 #define TWCY_TONGAIS        676
1111 #define TWCY_TRINIDAD      8016
1112 #define TWCY_TUNISIA        216
1113 #define TWCY_TURKEY          90
1114 #define TWCY_TURKSCAICOS   8017
1115 #define TWCY_TUVALU        1040
1116 #define TWCY_UGANDA         256
1117 #define TWCY_USSR             7
1118 #define TWCY_UAEMIRATES     971
1119 #define TWCY_UNITEDKINGDOM   44
1120 #define TWCY_USA              1
1121 #define TWCY_URUGUAY        598
1122 #define TWCY_VANUATU       1041
1123 #define TWCY_VATICANCITY     39
1124 #define TWCY_VENEZUELA       58
1125 #define TWCY_WAKE          1042
1126 #define TWCY_WALLISIS      1043
1127 #define TWCY_WESTERNSAHARA 1044
1128 #define TWCY_WESTERNSAMOA  1045
1129 #define TWCY_YEMEN         1046
1130 #define TWCY_YUGOSLAVIA      38
1131 #define TWCY_ZAIRE          243
1132 #define TWCY_ZAMBIA         260
1133 #define TWCY_ZIMBABWE       263
1134 /* Added for 1.8 */
1135 #define TWCY_ALBANIA        355
1136 #define TWCY_ARMENIA        374
1137 #define TWCY_AZERBAIJAN     994
1138 #define TWCY_BELARUS        375
1139 #define TWCY_BOSNIAHERZGO   387
1140 #define TWCY_CAMBODIA       855
1141 #define TWCY_CROATIA        385
1142 #define TWCY_CZECHREPUBLIC  420
1143 #define TWCY_DIEGOGARCIA    246
1144 #define TWCY_ERITREA        291
1145 #define TWCY_ESTONIA        372
1146 #define TWCY_GEORGIA        995
1147 #define TWCY_LATVIA         371
1148 #define TWCY_LESOTHO        266
1149 #define TWCY_LITHUANIA      370
1150 #define TWCY_MACEDONIA      389
1151 #define TWCY_MAYOTTEIS      269
1152 #define TWCY_MOLDOVA        373
1153 #define TWCY_MYANMAR        95
1154 #define TWCY_NORTHKOREA     850
1155 #define TWCY_PUERTORICO     787
1156 #define TWCY_RUSSIA         7
1157 #define TWCY_SERBIA         381
1158 #define TWCY_SLOVAKIA       421
1159 #define TWCY_SLOVENIA       386
1160 #define TWCY_SOUTHKOREA     82
1161 #define TWCY_UKRAINE        380
1162 #define TWCY_USVIRGINIS     340
1163 #define TWCY_VIETNAM        84
1164
1165 /****************************************************************************
1166  * Language Constants                                                       *
1167  ****************************************************************************/
1168
1169 #define TWLG_DAN              0 /* Danish                 */
1170 #define TWLG_DUT              1 /* Dutch                  */
1171 #define TWLG_ENG              2 /* International English  */
1172 #define TWLG_FCF              3 /* French Canadian        */
1173 #define TWLG_FIN              4 /* Finnish                */
1174 #define TWLG_FRN              5 /* French                 */
1175 #define TWLG_GER              6 /* German                 */
1176 #define TWLG_ICE              7 /* Icelandic              */
1177 #define TWLG_ITN              8 /* Italian                */
1178 #define TWLG_NOR              9 /* Norwegian              */
1179 #define TWLG_POR             10 /* Portuguese             */
1180 #define TWLG_SPA             11 /* Spanish                */
1181 #define TWLG_SWE             12 /* Swedish                */
1182 #define TWLG_USA             13 /* U.S. English           */
1183 /* Added for 1.8 */
1184 #define TWLG_USERLOCALE           -1
1185 #define TWLG_AFRIKAANS            14
1186 #define TWLG_ALBANIA              15
1187 #define TWLG_ARABIC               16
1188 #define TWLG_ARABIC_ALGERIA       17
1189 #define TWLG_ARABIC_BAHRAIN       18
1190 #define TWLG_ARABIC_EGYPT         19
1191 #define TWLG_ARABIC_IRAQ          20
1192 #define TWLG_ARABIC_JORDAN        21
1193 #define TWLG_ARABIC_KUWAIT        22
1194 #define TWLG_ARABIC_LEBANON       23
1195 #define TWLG_ARABIC_LIBYA         24
1196 #define TWLG_ARABIC_MOROCCO       25
1197 #define TWLG_ARABIC_OMAN          26
1198 #define TWLG_ARABIC_QATAR         27
1199 #define TWLG_ARABIC_SAUDIARABIA   28
1200 #define TWLG_ARABIC_SYRIA         29
1201 #define TWLG_ARABIC_TUNISIA       30
1202 #define TWLG_ARABIC_UAE           31 /* United Arabic Emirates */
1203 #define TWLG_ARABIC_YEMEN         32
1204 #define TWLG_BASQUE               33
1205 #define TWLG_BYELORUSSIAN         34
1206 #define TWLG_BULGARIAN            35
1207 #define TWLG_CATALAN              36
1208 #define TWLG_CHINESE              37
1209 #define TWLG_CHINESE_HONGKONG     38
1210 #define TWLG_CHINESE_PRC          39 /* People's Republic of China */
1211 #define TWLG_CHINESE_SINGAPORE    40
1212 #define TWLG_CHINESE_SIMPLIFIED   41
1213 #define TWLG_CHINESE_TAIWAN       42
1214 #define TWLG_CHINESE_TRADITIONAL  43
1215 #define TWLG_CROATIA              44
1216 #define TWLG_CZECH                45
1217 #define TWLG_DANISH               TWLG_DAN
1218 #define TWLG_DUTCH                TWLG_DUT
1219 #define TWLG_DUTCH_BELGIAN        46
1220 #define TWLG_ENGLISH              TWLG_ENG
1221 #define TWLG_ENGLISH_AUSTRALIAN   47
1222 #define TWLG_ENGLISH_CANADIAN     48
1223 #define TWLG_ENGLISH_IRELAND      49
1224 #define TWLG_ENGLISH_NEWZEALAND   50
1225 #define TWLG_ENGLISH_SOUTHAFRICA  51
1226 #define TWLG_ENGLISH_UK           52
1227 #define TWLG_ENGLISH_USA          TWLG_USA
1228 #define TWLG_ESTONIAN             53
1229 #define TWLG_FAEROESE             54
1230 #define TWLG_FARSI                55
1231 #define TWLG_FINNISH              TWLG_FIN
1232 #define TWLG_FRENCH               TWLG_FRN
1233 #define TWLG_FRENCH_BELGIAN       56
1234 #define TWLG_FRENCH_CANADIAN      TWLG_FCF
1235 #define TWLG_FRENCH_LUXEMBOURG    57
1236 #define TWLG_FRENCH_SWISS         58
1237 #define TWLG_GERMAN               TWLG_GER
1238 #define TWLG_GERMAN_AUSTRIAN      59
1239 #define TWLG_GERMAN_LUXEMBOURG    60
1240 #define TWLG_GERMAN_LIECHTENSTEIN 61
1241 #define TWLG_GERMAN_SWISS         62
1242 #define TWLG_GREEK                63
1243 #define TWLG_HEBREW               64
1244 #define TWLG_HUNGARIAN            65
1245 #define TWLG_ICELANDIC            TWLG_ICE
1246 #define TWLG_INDONESIAN           66
1247 #define TWLG_ITALIAN              TWLG_ITN
1248 #define TWLG_ITALIAN_SWISS        67
1249 #define TWLG_JAPANESE             68
1250 #define TWLG_KOREAN               69
1251 #define TWLG_KOREAN_JOHAB         70
1252 #define TWLG_LATVIAN              71
1253 #define TWLG_LITHUANIAN           72
1254 #define TWLG_NORWEGIAN            TWLG_NOR
1255 #define TWLG_NORWEGIAN_BOKMAL     73
1256 #define TWLG_NORWEGIAN_NYNORSK    74
1257 #define TWLG_POLISH               75
1258 #define TWLG_PORTUGUESE           TWLG_POR
1259 #define TWLG_PORTUGUESE_BRAZIL    76
1260 #define TWLG_ROMANIAN             77
1261 #define TWLG_RUSSIAN              78
1262 #define TWLG_SERBIAN_LATIN        79
1263 #define TWLG_SLOVAK               80
1264 #define TWLG_SLOVENIAN            81
1265 #define TWLG_SPANISH              TWLG_SPA
1266 #define TWLG_SPANISH_MEXICAN      82
1267 #define TWLG_SPANISH_MODERN       83
1268 #define TWLG_SWEDISH              TWLG_SWE
1269 #define TWLG_THAI                 84
1270 #define TWLG_TURKISH              85
1271 #define TWLG_UKRANIAN             86
1272 /* More stuff added for 1.8 */
1273 #define TWLG_ASSAMESE             87
1274 #define TWLG_BENGALI              88
1275 #define TWLG_BIHARI               89
1276 #define TWLG_BODO                 90
1277 #define TWLG_DOGRI                91
1278 #define TWLG_GUJARATI             92
1279 #define TWLG_HARYANVI             93
1280 #define TWLG_HINDI                94
1281 #define TWLG_KANNADA              95
1282 #define TWLG_KASHMIRI             96
1283 #define TWLG_MALAYALAM            97
1284 #define TWLG_MARATHI              98
1285 #define TWLG_MARWARI              99
1286 #define TWLG_MEGHALAYAN          100
1287 #define TWLG_MIZO                101
1288 #define TWLG_NAGA                102
1289 #define TWLG_ORISSI              103
1290 #define TWLG_PUNJABI             104
1291 #define TWLG_PUSHTU              105
1292 #define TWLG_SERBIAN_CYRILLIC    106
1293 #define TWLG_SIKKIMI             107
1294 #define TWLG_SWEDISH_FINLAND     108
1295 #define TWLG_TAMIL               109
1296 #define TWLG_TELUGU              110
1297 #define TWLG_TRIPURI             111
1298 #define TWLG_URDU                112
1299 #define TWLG_VIETNAMESE          113
1300
1301 /****************************************************************************
1302  * Data Groups                                                              *
1303  ****************************************************************************/
1304
1305 /* More Data Groups may be added in the future.
1306  * Possible candidates include text, vector graphics, sound, etc.
1307  * NOTE: Data Group constants must be powers of 2 as they are used
1308  *       as bitflags when Application asks DSM to present a list of DSs.
1309  */
1310
1311 #define DG_CONTROL          0x0001L /* data pertaining to control       */
1312 #define DG_IMAGE            0x0002L /* data pertaining to raster images */
1313 /* Added 1.8 */
1314 #define DG_AUDIO            0x0004L /* data pertaining to audio */
1315
1316 /****************************************************************************
1317  * Data Argument Types                                                      *
1318  ****************************************************************************/
1319
1320 /*  SDH - 03/23/95 - WATCH                                                  */
1321 /*  The thunker requires knowledge about size of data being passed in the   */
1322 /*  lpData parameter to DS_Entry (which is not readily available due to     */
1323 /*  type LPVOID.  Thus, we key off the DAT_ argument to determine the size. */
1324 /*  This has a couple implications:                                         */
1325 /*  1) Any additional DAT_ features require modifications to the thunk code */
1326 /*     for thunker support.                                                 */
1327 /*  2) Any applications which use the custom capabilities are not supported */
1328 /*     under thunking since we have no way of knowing what size data (if    */
1329 /*     any) is being passed.                                                */
1330
1331 #define DAT_NULL            0x0000 /* No data or structure. */
1332 #define DAT_CUSTOMBASE      0x8000 /* Base of custom DATs.  */
1333
1334 /* Data Argument Types for the DG_CONTROL Data Group. */
1335 #define DAT_CAPABILITY      0x0001 /* TW_CAPABILITY                        */
1336 #define DAT_EVENT           0x0002 /* TW_EVENT                             */
1337 #define DAT_IDENTITY        0x0003 /* TW_IDENTITY                          */
1338 #define DAT_PARENT          0x0004 /* TW_HANDLE, application win handle in Windows */
1339 #define DAT_PENDINGXFERS    0x0005 /* TW_PENDINGXFERS                      */
1340 #define DAT_SETUPMEMXFER    0x0006 /* TW_SETUPMEMXFER                      */
1341 #define DAT_SETUPFILEXFER   0x0007 /* TW_SETUPFILEXFER                     */
1342 #define DAT_STATUS          0x0008 /* TW_STATUS                            */
1343 #define DAT_USERINTERFACE   0x0009 /* TW_USERINTERFACE                     */
1344 #define DAT_XFERGROUP       0x000a /* TW_UINT32                            */
1345 /*  SDH - 03/21/95 - TWUNK                                         */
1346 /*  Additional message required for thunker to request the special */
1347 /*  identity information.                                          */
1348 #define DAT_TWUNKIDENTITY   0x000b /* TW_TWUNKIDENTITY                     */
1349 #define DAT_CUSTOMDSDATA    0x000c /* TW_CUSTOMDSDATA.                     */
1350 /* Added 1.8 */
1351 #define DAT_DEVICEEVENT     0x000d /* TW_DEVICEEVENT                       */
1352 #define DAT_FILESYSTEM      0x000e /* TW_FILESYSTEM                        */
1353 #define DAT_PASSTHRU        0x000f /* TW_PASSTHRU                          */
1354
1355 /* Data Argument Types for the DG_IMAGE Data Group. */
1356 #define DAT_IMAGEINFO       0x0101 /* TW_IMAGEINFO                         */
1357 #define DAT_IMAGELAYOUT     0x0102 /* TW_IMAGELAYOUT                       */
1358 #define DAT_IMAGEMEMXFER    0x0103 /* TW_IMAGEMEMXFER                      */
1359 #define DAT_IMAGENATIVEXFER 0x0104 /* TW_UINT32 loword is hDIB, PICHandle  */
1360 #define DAT_IMAGEFILEXFER   0x0105 /* Null data                            */
1361 #define DAT_CIECOLOR        0x0106 /* TW_CIECOLOR                          */
1362 #define DAT_GRAYRESPONSE    0x0107 /* TW_GRAYRESPONSE                      */
1363 #define DAT_RGBRESPONSE     0x0108 /* TW_RGBRESPONSE                       */
1364 #define DAT_JPEGCOMPRESSION 0x0109 /* TW_JPEGCOMPRESSION                   */
1365 #define DAT_PALETTE8        0x010a /* TW_PALETTE8                          */
1366 #define DAT_EXTIMAGEINFO    0x010b /* TW_EXTIMAGEINFO -- for 1.7 Spec.     */
1367
1368 /* Added 1.8 */
1369 /* Data Argument Types for the DG_AUDIO Data Group. */
1370 #define DAT_AUDIOFILEXFER   0x0201 /* Null data                            */
1371 #define DAT_AUDIOINFO       0x0202 /* TW_AUDIOINFO                         */
1372 #define DAT_AUDIONATIVEXFER 0x0203 /* TW_UINT32 handle to WAV, (AIFF Mac)  */
1373
1374 /****************************************************************************
1375  * Messages                                                                 *
1376  ****************************************************************************/
1377
1378 /* All message constants are unique.
1379  * Messages are grouped according to which DATs they are used with.*/
1380
1381 #define MSG_NULL         0x0000 /* Used in TW_EVENT structure               */
1382 #define MSG_CUSTOMBASE   0x8000 /* Base of custom messages                  */
1383
1384 /* Generic messages may be used with any of several DATs.                   */
1385 #define MSG_GET          0x0001 /* Get one or more values                   */
1386 #define MSG_GETCURRENT   0x0002 /* Get current value                        */
1387 #define MSG_GETDEFAULT   0x0003 /* Get default (e.g. power up) value        */
1388 #define MSG_GETFIRST     0x0004 /* Get first of a series of items, e.g. DSs */
1389 #define MSG_GETNEXT      0x0005 /* Iterate through a series of items.       */
1390 #define MSG_SET          0x0006 /* Set one or more values                   */
1391 #define MSG_RESET        0x0007 /* Set current value to default value       */
1392 #define MSG_QUERYSUPPORT 0x0008 /* Get supported operations on the cap.     */
1393
1394 /* Messages used with DAT_NULL                                              */
1395 #define MSG_XFERREADY    0x0101 /* The data source has data ready           */
1396 #define MSG_CLOSEDSREQ   0x0102 /* Request for Application. to close DS             */
1397 #define MSG_CLOSEDSOK    0x0103 /* Tell the Application. to save the state.         */
1398 /* Added 1.8 */
1399 #define MSG_DEVICEEVENT  0X0104 /* Some event has taken place               */
1400
1401 /* Messages used with a pointer to a DAT_STATUS structure                   */
1402 #define MSG_CHECKSTATUS  0x0201 /* Get status information                   */
1403
1404 /* Messages used with a pointer to DAT_PARENT data                          */
1405 #define MSG_OPENDSM      0x0301 /* Open the DSM                             */
1406 #define MSG_CLOSEDSM     0x0302 /* Close the DSM                            */
1407
1408 /* Messages used with a pointer to a DAT_IDENTITY structure                 */
1409 #define MSG_OPENDS       0x0401 /* Open a data source                       */
1410 #define MSG_CLOSEDS      0x0402 /* Close a data source                      */
1411 #define MSG_USERSELECT   0x0403 /* Put up a dialog of all DS                */
1412
1413 /* Messages used with a pointer to a DAT_USERINTERFACE structure            */
1414 #define MSG_DISABLEDS    0x0501 /* Disable data transfer in the DS          */
1415 #define MSG_ENABLEDS     0x0502 /* Enable data transfer in the DS           */
1416 #define MSG_ENABLEDSUIONLY  0x0503  /* Enable for saving DS state only.     */
1417
1418 /* Messages used with a pointer to a DAT_EVENT structure                    */
1419 #define MSG_PROCESSEVENT 0x0601
1420
1421 /* Messages used with a pointer to a DAT_PENDINGXFERS structure             */
1422 #define MSG_ENDXFER      0x0701
1423
1424 /* Added 1.8 */
1425 /* Messages used with a pointer to a DAT_FILESYSTEM structure               */
1426 #define MSG_CHANGEDIRECTORY   0x0801
1427 #define MSG_CREATEDIRECTORY   0x0802
1428 #define MSG_DELETE            0x0803
1429 #define MSG_FORMATMEDIA       0x0804
1430 #define MSG_GETCLOSE          0x0805
1431 #define MSG_GETFIRSTFILE      0x0806
1432 #define MSG_GETINFO           0x0807
1433 #define MSG_GETNEXTFILE       0x0808
1434 #define MSG_RENAME            0x0809
1435
1436 /* Messages used with a pointer to a DAT_PASSTHRU structure                 */
1437 #define MSG_PASSTHRU          0x0901
1438
1439 /****************************************************************************
1440  * Capabilities                                                             *
1441  ****************************************************************************/
1442
1443 #define CAP_CUSTOMBASE          0x8000 /* Base of custom capabilities */
1444
1445 /* all data sources are REQUIRED to support these caps */
1446 #define CAP_XFERCOUNT           0x0001
1447
1448 /* image data sources are REQUIRED to support these caps */
1449 #define ICAP_COMPRESSION        0x0100
1450 #define ICAP_PIXELTYPE          0x0101
1451 #define ICAP_UNITS              0x0102 /* default is TWUN_INCHES */
1452 #define ICAP_XFERMECH           0x0103
1453
1454 /* all data sources MAY support these caps */
1455 #define CAP_AUTHOR                  0x1000
1456 #define CAP_CAPTION                 0x1001
1457 #define CAP_FEEDERENABLED           0x1002
1458 #define CAP_FEEDERLOADED            0x1003
1459 #define CAP_TIMEDATE                0x1004
1460 #define CAP_SUPPORTEDCAPS           0x1005
1461 #define CAP_EXTENDEDCAPS            0x1006
1462 #define CAP_AUTOFEED                0x1007
1463 #define CAP_CLEARPAGE               0x1008
1464 #define CAP_FEEDPAGE                0x1009
1465 #define CAP_REWINDPAGE              0x100a
1466 #define CAP_INDICATORS              0x100b   /* Added 1.1 */
1467 #define CAP_SUPPORTEDCAPSEXT        0x100c   /* Added 1.6 */
1468 #define CAP_PAPERDETECTABLE         0x100d   /* Added 1.6 */
1469 #define CAP_UICONTROLLABLE          0x100e   /* Added 1.6 */
1470 #define CAP_DEVICEONLINE            0x100f   /* Added 1.6 */
1471 #define CAP_AUTOSCAN                0x1010   /* Added 1.6 */
1472 #define CAP_THUMBNAILSENABLED       0x1011   /* Added 1.7 */
1473 #define CAP_DUPLEX                  0x1012   /* Added 1.7 */
1474 #define CAP_DUPLEXENABLED           0x1013   /* Added 1.7 */
1475 #define CAP_ENABLEDSUIONLY          0x1014   /* Added 1.7 */
1476 #define CAP_CUSTOMDSDATA            0x1015   /* Added 1.7 */
1477 #define CAP_ENDORSER                0x1016   /* Added 1.7 */
1478 #define CAP_JOBCONTROL              0x1017   /* Added 1.7 */
1479 #define CAP_ALARMS                  0x1018   /* Added 1.8 */
1480 #define CAP_ALARMVOLUME             0x1019   /* Added 1.8 */
1481 #define CAP_AUTOMATICCAPTURE        0x101a   /* Added 1.8 */
1482 #define CAP_TIMEBEFOREFIRSTCAPTURE  0x101b   /* Added 1.8 */
1483 #define CAP_TIMEBETWEENCAPTURES     0x101c   /* Added 1.8 */
1484 #define CAP_CLEARBUFFERS            0x101d   /* Added 1.8 */
1485 #define CAP_MAXBATCHBUFFERS         0x101e   /* Added 1.8 */
1486 #define CAP_DEVICETIMEDATE          0x101f   /* Added 1.8 */
1487 #define CAP_POWERSUPPLY             0x1020   /* Added 1.8 */
1488 #define CAP_CAMERAPREVIEWUI         0x1021   /* Added 1.8 */
1489 #define CAP_DEVICEEVENT             0x1022   /* Added 1.8 */
1490 #define CAP_PAGEMULTIPLEACQUIRE     0x1023   /* Added 1.8 */
1491 #define CAP_SERIALNUMBER            0x1024   /* Added 1.8 */
1492 #define CAP_FILESYSTEM              0x1025   /* Added 1.8 */
1493 #define CAP_PRINTER                 0x1026   /* Added 1.8 */
1494 #define CAP_PRINTERENABLED          0x1027   /* Added 1.8 */
1495 #define CAP_PRINTERINDEX            0x1028   /* Added 1.8 */
1496 #define CAP_PRINTERMODE             0x1029   /* Added 1.8 */
1497 #define CAP_PRINTERSTRING           0x102a   /* Added 1.8 */
1498 #define CAP_PRINTERSUFFIX           0x102b   /* Added 1.8 */
1499 #define CAP_LANGUAGE                0x102c   /* Added 1.8 */
1500 #define CAP_FEEDERALIGNMENT         0x102d   /* Added 1.8 */
1501 #define CAP_FEEDERORDER             0x102e   /* Added 1.8 */
1502 #define CAP_PAPERBINDING            0x102f   /* Added 1.8 */
1503 #define CAP_REACQUIREALLOWED        0x1030   /* Added 1.8 */
1504 #define CAP_PASSTHRU                0x1031   /* Added 1.8 */
1505 #define CAP_BATTERYMINUTES          0x1032   /* Added 1.8 */
1506 #define CAP_BATTERYPERCENTAGE       0x1033   /* Added 1.8 */
1507 #define CAP_POWERDOWNTIME           0x1034   /* Added 1.8 */
1508
1509 /* image data sources MAY support these caps */
1510 #define ICAP_AUTOBRIGHT                   0x1100
1511 #define ICAP_BRIGHTNESS                   0x1101
1512 #define ICAP_CONTRAST                     0x1103
1513 #define ICAP_CUSTHALFTONE                 0x1104
1514 #define ICAP_EXPOSURETIME                 0x1105
1515 #define ICAP_FILTER                       0x1106
1516 #define ICAP_FLASHUSED                    0x1107
1517 #define ICAP_GAMMA                        0x1108
1518 #define ICAP_HALFTONES                    0x1109
1519 #define ICAP_HIGHLIGHT                    0x110a
1520 #define ICAP_IMAGEFILEFORMAT              0x110c
1521 #define ICAP_LAMPSTATE                    0x110d
1522 #define ICAP_LIGHTSOURCE                  0x110e
1523 #define ICAP_ORIENTATION                  0x1110
1524 #define ICAP_PHYSICALWIDTH                0x1111
1525 #define ICAP_PHYSICALHEIGHT               0x1112
1526 #define ICAP_SHADOW                       0x1113
1527 #define ICAP_FRAMES                       0x1114
1528 #define ICAP_XNATIVERESOLUTION            0x1116
1529 #define ICAP_YNATIVERESOLUTION            0x1117
1530 #define ICAP_XRESOLUTION                  0x1118
1531 #define ICAP_YRESOLUTION                  0x1119
1532 #define ICAP_MAXFRAMES                    0x111a
1533 #define ICAP_TILES                        0x111b
1534 #define ICAP_BITORDER                     0x111c
1535 #define ICAP_CCITTKFACTOR                 0x111d
1536 #define ICAP_LIGHTPATH                    0x111e
1537 #define ICAP_PIXELFLAVOR                  0x111f
1538 #define ICAP_PLANARCHUNKY                 0x1120
1539 #define ICAP_ROTATION                     0x1121
1540 #define ICAP_SUPPORTEDSIZES               0x1122
1541 #define ICAP_THRESHOLD                    0x1123
1542 #define ICAP_XSCALING                     0x1124
1543 #define ICAP_YSCALING                     0x1125
1544 #define ICAP_BITORDERCODES                0x1126
1545 #define ICAP_PIXELFLAVORCODES             0x1127
1546 #define ICAP_JPEGPIXELTYPE                0x1128
1547 #define ICAP_TIMEFILL                     0x112a
1548 #define ICAP_BITDEPTH                     0x112b
1549 #define ICAP_BITDEPTHREDUCTION            0x112c  /* Added 1.5 */
1550 #define ICAP_UNDEFINEDIMAGESIZE           0x112d  /* Added 1.6 */
1551 #define ICAP_IMAGEDATASET                 0x112e  /* Added 1.7 */
1552 #define ICAP_EXTIMAGEINFO                 0x112f  /* Added 1.7 */
1553 #define ICAP_MINIMUMHEIGHT                0x1130  /* Added 1.7 */
1554 #define ICAP_MINIMUMWIDTH                 0x1131  /* Added 1.7 */
1555 #define ICAP_AUTODISCARDBLANKPAGES        0x1134  /* Added 1.8 */
1556 #define ICAP_FLIPROTATION                 0x1136  /* Added 1.8 */
1557 #define ICAP_BARCODEDETECTIONENABLED      0x1137  /* Added 1.8 */
1558 #define ICAP_SUPPORTEDBARCODETYPES        0x1138  /* Added 1.8 */
1559 #define ICAP_BARCODEMAXSEARCHPRIORITIES   0x1139  /* Added 1.8 */
1560 #define ICAP_BARCODESEARCHPRIORITIES      0x113a  /* Added 1.8 */
1561 #define ICAP_BARCODESEARCHMODE            0x113b  /* Added 1.8 */
1562 #define ICAP_BARCODEMAXRETRIES            0x113c  /* Added 1.8 */
1563 #define ICAP_BARCODETIMEOUT               0x113d  /* Added 1.8 */
1564 #define ICAP_ZOOMFACTOR                   0x113e  /* Added 1.8 */
1565 #define ICAP_PATCHCODEDETECTIONENABLED    0x113f  /* Added 1.8 */
1566 #define ICAP_SUPPORTEDPATCHCODETYPES      0x1140  /* Added 1.8 */
1567 #define ICAP_PATCHCODEMAXSEARCHPRIORITIES 0x1141  /* Added 1.8 */
1568 #define ICAP_PATCHCODESEARCHPRIORITIES    0x1142  /* Added 1.8 */
1569 #define ICAP_PATCHCODESEARCHMODE          0x1143  /* Added 1.8 */
1570 #define ICAP_PATCHCODEMAXRETRIES          0x1144  /* Added 1.8 */
1571 #define ICAP_PATCHCODETIMEOUT             0x1145  /* Added 1.8 */
1572 #define ICAP_FLASHUSED2                   0x1146  /* Added 1.8 */
1573 #define ICAP_IMAGEFILTER                  0x1147  /* Added 1.8 */
1574 #define ICAP_NOISEFILTER                  0x1148  /* Added 1.8 */
1575 #define ICAP_OVERSCAN                     0x1149  /* Added 1.8 */
1576 #define ICAP_AUTOMATICBORDERDETECTION     0x1150  /* Added 1.8 */
1577 #define ICAP_AUTOMATICDESKEW              0x1151  /* Added 1.8 */
1578 #define ICAP_AUTOMATICROTATE              0x1152  /* Added 1.8 */
1579
1580 /* image data sources MAY support these audio caps */
1581 #define ACAP_AUDIOFILEFORMAT    0x1201  /* Added 1.8 */
1582 #define ACAP_XFERMECH           0x1202  /* Added 1.8 */
1583
1584 /* ----------------------------------------------------------------------- *\
1585
1586   Version 1.7:      Following is Extended Image Info Attributes.
1587   July 1997
1588   KHL
1589
1590 \* ----------------------------------------------------------------------- */
1591
1592 #define TWEI_BARCODEX               0x1200
1593 #define TWEI_BARCODEY               0x1201
1594 #define TWEI_BARCODETEXT            0x1202
1595 #define TWEI_BARCODETYPE            0x1203
1596 #define TWEI_DESHADETOP             0x1204
1597 #define TWEI_DESHADELEFT            0x1205
1598 #define TWEI_DESHADEHEIGHT          0x1206
1599 #define TWEI_DESHADEWIDTH           0x1207
1600 #define TWEI_DESHADESIZE            0x1208
1601 #define TWEI_SPECKLESREMOVED        0x1209
1602 #define TWEI_HORZLINEXCOORD         0x120A
1603 #define TWEI_HORZLINEYCOORD         0x120B
1604 #define TWEI_HORZLINELENGTH         0x120C
1605 #define TWEI_HORZLINETHICKNESS      0x120D
1606 #define TWEI_VERTLINEXCOORD         0x120E
1607 #define TWEI_VERTLINEYCOORD         0x120F
1608 #define TWEI_VERTLINELENGTH         0x1210
1609 #define TWEI_VERTLINETHICKNESS      0x1211
1610 #define TWEI_PATCHCODE              0x1212
1611 #define TWEI_ENDORSEDTEXT           0x1213
1612 #define TWEI_FORMCONFIDENCE         0x1214
1613 #define TWEI_FORMTEMPLATEMATCH      0x1215
1614 #define TWEI_FORMTEMPLATEPAGEMATCH  0x1216
1615 #define TWEI_FORMHORZDOCOFFSET      0x1217
1616 #define TWEI_FORMVERTDOCOFFSET      0x1218
1617 #define TWEI_BARCODECOUNT           0x1219
1618 #define TWEI_BARCODECONFIDENCE      0x121A
1619 #define TWEI_BARCODEROTATION        0x121B
1620 #define TWEI_BARCODETEXTLENGTH      0x121C
1621 #define TWEI_DESHADECOUNT           0x121D
1622 #define TWEI_DESHADEBLACKCOUNTOLD   0x121E
1623 #define TWEI_DESHADEBLACKCOUNTNEW   0x121F
1624 #define TWEI_DESHADEBLACKRLMIN      0x1220
1625 #define TWEI_DESHADEBLACKRLMAX      0x1221
1626 #define TWEI_DESHADEWHITECOUNTOLD   0x1222
1627 #define TWEI_DESHADEWHITECOUNTNEW   0x1223
1628 #define TWEI_DESHADEWHITERLMIN      0x1224
1629 #define TWEI_DESHADEWHITERLAVE      0x1225
1630 #define TWEI_DESHADEWHITERLMAX      0x1226
1631 #define TWEI_BLACKSPECKLESREMOVED   0x1227
1632 #define TWEI_WHITESPECKLESREMOVED   0x1228
1633 #define TWEI_HORZLINECOUNT          0x1229
1634 #define TWEI_VERTLINECOUNT          0x122A
1635 #define TWEI_DESKEWSTATUS           0x122B
1636 #define TWEI_SKEWORIGINALANGLE      0x122C
1637 #define TWEI_SKEWFINALANGLE         0x122D
1638 #define TWEI_SKEWCONFIDENCE         0x122E
1639 #define TWEI_SKEWWINDOWX1           0x122F
1640 #define TWEI_SKEWWINDOWY1           0x1230
1641 #define TWEI_SKEWWINDOWX2           0x1231
1642 #define TWEI_SKEWWINDOWY2           0x1232
1643 #define TWEI_SKEWWINDOWX3           0x1233
1644 #define TWEI_SKEWWINDOWY3           0x1234
1645 #define TWEI_SKEWWINDOWX4           0x1235
1646 #define TWEI_SKEWWINDOWY4           0x1236
1647
1648 #define TWEJ_NONE                   0x0000
1649 #define TWEJ_MIDSEPARATOR           0x0001
1650 #define TWEJ_PATCH1                 0x0002
1651 #define TWEJ_PATCH2                 0x0003
1652 #define TWEJ_PATCH3                 0x0004
1653 #define TWEJ_PATCH4                 0x0005
1654 #define TWEJ_PATCH6                 0x0006
1655 #define TWEJ_PATCHT                 0x0007
1656
1657 /***************************************************************************
1658  *            Return Codes and Condition Codes section                     *
1659  ***************************************************************************/
1660
1661 /* Return Codes: DSM_Entry and DS_Entry may return any one of these values. */
1662 #define TWRC_CUSTOMBASE     0x8000
1663
1664 #define TWRC_SUCCESS          0
1665 #define TWRC_FAILURE          1 /* Application may get TW_STATUS for info on failure */
1666 #define TWRC_CHECKSTATUS      2 /* "tried hard"; get status                  */
1667 #define TWRC_CANCEL           3
1668 #define TWRC_DSEVENT          4
1669 #define TWRC_NOTDSEVENT       5
1670 #define TWRC_XFERDONE         6
1671 #define TWRC_ENDOFLIST        7 /* After MSG_GETNEXT if nothing left         */
1672 #define TWRC_INFONOTSUPPORTED 8
1673 #define TWRC_DATANOTAVAILABLE 9
1674
1675 /* Condition Codes: Application gets these by doing DG_CONTROL DAT_STATUS MSG_GET.  */
1676 #define TWCC_CUSTOMBASE         0x8000
1677
1678 #define TWCC_SUCCESS            0 /* It worked!                                */
1679 #define TWCC_BUMMER             1 /* Failure due to unknown causes             */
1680 #define TWCC_LOWMEMORY          2 /* Not enough memory to perform operation    */
1681 #define TWCC_NODS               3 /* No Data Source                            */
1682 #define TWCC_MAXCONNECTIONS     4 /* DS is connected to max possible applications */
1683 #define TWCC_OPERATIONERROR     5 /* DS or DSM reported error, application shouldn't */
1684 #define TWCC_BADCAP             6 /* Unknown capability                        */
1685 #define TWCC_BADPROTOCOL        9 /* Unrecognized MSG DG DAT combination       */
1686 #define TWCC_BADVALUE           10 /* Data parameter out of range              */
1687 #define TWCC_SEQERROR           11 /* DG DAT MSG out of expected sequence      */
1688 #define TWCC_BADDEST            12 /* Unknown destination Application/Source in DSM_Entry */
1689 #define TWCC_CAPUNSUPPORTED     13 /* Capability not supported by source            */
1690 #define TWCC_CAPBADOPERATION    14 /* Operation not supported by capability         */
1691 #define TWCC_CAPSEQERROR        15 /* Capability has dependency on other capability */
1692 /* Added 1.8 */
1693 #define TWCC_DENIED             16 /* File System operation is denied (file is protected) */
1694 #define TWCC_FILEEXISTS         17 /* Operation failed because file already exists. */
1695 #define TWCC_FILENOTFOUND       18 /* File not found */
1696 #define TWCC_NOTEMPTY           19 /* Operation failed because directory is not empty */
1697 #define TWCC_PAPERJAM           20  /* The feeder is jammed */
1698 #define TWCC_PAPERDOUBLEFEED    21  /* The feeder detected multiple pages */
1699 #define TWCC_FILEWRITEERROR     22  /* Error writing the file (meant for things like disk full conditions) */
1700 #define TWCC_CHECKDEVICEONLINE  23  /* The device went offline prior to or during this operation */
1701
1702
1703 /* bit patterns: for query the operation that are supported by the data source on a capability */
1704 /* Application gets these through DG_CONTROL/DAT_CAPABILITY/MSG_QUERYSUPPORT */
1705 /* Added 1.6 */
1706 #define TWQC_GET           0x0001
1707 #define TWQC_SET           0x0002
1708 #define TWQC_GETDEFAULT    0x0004
1709 #define TWQC_GETCURRENT    0x0008
1710 #define TWQC_RESET         0x0010
1711
1712
1713 /****************************************************************************
1714  * Entry Points                                                             *
1715  ****************************************************************************/
1716
1717 /**********************************************************************
1718  * Function: DSM_Entry, the only entry point into the Data Source Manager.
1719  *
1720  * Parameters:
1721  *  pOrigin Identifies the source module of the message. This could
1722  *          identify an Application, a Source, or the Source Manager.
1723  *
1724  *  pDest   Identifies the destination module for the message.
1725  *          This could identify an application or a data source.
1726  *          If this is NULL, the message goes to the Source Manager.
1727  *
1728  *  DG      The Data Group.
1729  *          Example: DG_IMAGE.
1730  *
1731  *  DAT     The Data Attribute Type.
1732  *          Example: DAT_IMAGEMEMXFER.
1733  *
1734  *  MSG     The message.  Messages are interpreted by the destination module
1735  *          with respect to the Data Group and the Data Attribute Type.
1736  *          Example: MSG_GET.
1737  *
1738  *  pData   A pointer to the data structure or variable identified
1739  *          by the Data Attribute Type.
1740  *          Example: (TW_MEMREF)&ImageMemXfer
1741  *                   where ImageMemXfer is a TW_IMAGEMEMXFER structure.
1742  *
1743  * Returns:
1744  *  ReturnCode
1745  *         Example: TWRC_SUCCESS.
1746  *
1747  ********************************************************************/
1748
1749 /* Don't mangle the name "DSM_Entry" if we're compiling in C++! */
1750 #ifdef  __cplusplus
1751 extern "C" {
1752 #endif  /* __cplusplus */
1753
1754 #ifdef  _MSWIN_
1755 TW_UINT16 FAR PASCAL DSM_Entry( pTW_IDENTITY pOrigin,
1756                                 pTW_IDENTITY pDest,
1757                                 TW_UINT32    DG,
1758                                 TW_UINT16    DAT,
1759                                 TW_UINT16    MSG,
1760                                 TW_MEMREF    pData);
1761
1762 typedef TW_UINT16 (FAR PASCAL *DSMENTRYPROC)(pTW_IDENTITY, pTW_IDENTITY,
1763                                              TW_UINT32,    TW_UINT16,
1764                                              TW_UINT16,    TW_MEMREF);
1765 #else   /* _MSWIN_ */
1766
1767 /*FAR PASCAL TW_UINT16 DSM_Entry( pTW_IDENTITY pOrigin,
1768                                 pTW_IDENTITY pDest,
1769                                 TW_UINT32    DG,
1770                                 TW_UINT16    DAT,
1771                                 TW_UINT16    MSG,
1772                                 TW_MEMREF    pData);*/
1773
1774 typedef TW_UINT16 (*DSMENTRYPROC)(pTW_IDENTITY, pTW_IDENTITY,
1775                                   TW_UINT32,    TW_UINT16,
1776                                   TW_UINT16,    TW_MEMREF);
1777 #endif  /* _MSWIN_ */
1778
1779 #ifdef  __cplusplus
1780 }
1781 #endif  /* cplusplus */
1782
1783
1784 /**********************************************************************
1785  * Function: DS_Entry, the entry point provided by a Data Source.
1786  *
1787  * Parameters:
1788  *  pOrigin Identifies the source module of the message. This could
1789  *          identify an application or the Data Source Manager.
1790  *
1791  *  DG      The Data Group.
1792  *          Example: DG_IMAGE.
1793  *
1794  *  DAT     The Data Attribute Type.
1795  *          Example: DAT_IMAGEMEMXFER.
1796  *
1797  *  MSG     The message.  Messages are interpreted by the data source
1798  *          with respect to the Data Group and the Data Attribute Type.
1799  *          Example: MSG_GET.
1800  *
1801  *  pData   A pointer to the data structure or variable identified
1802  *          by the Data Attribute Type.
1803  *          Example: (TW_MEMREF)&ImageMemXfer
1804  *                   where ImageMemXfer is a TW_IMAGEMEMXFER structure.
1805  *
1806  * Returns:
1807  *  ReturnCode
1808  *          Example: TWRC_SUCCESS.
1809  *
1810  * Note:
1811  *  The DSPROC type is only used by an application when it calls
1812  *  a Data Source directly, bypassing the Data Source Manager.
1813  *
1814  ********************************************************************/
1815 /* Don't mangle the name "DS_Entry" if we're compiling in C++! */
1816 #ifdef  __cplusplus
1817 extern "C" {
1818 #endif  /* __cplusplus */
1819 #ifdef  _MSWIN_
1820   TW_UINT16 DECLSPEC_EXPORT PASCAL DS_Entry (pTW_IDENTITY pOrigin,
1821                                              TW_UINT32    DG,
1822                                              TW_UINT16    DAT,
1823                                              TW_UINT16    MSG,
1824                                              TW_MEMREF    pData);
1825
1826   typedef TW_UINT16 (FAR PASCAL *DSENTRYPROC) (pTW_IDENTITY pOrigin,
1827                                                TW_UINT32    DG,
1828                                                TW_UINT16    DAT,
1829                                                TW_UINT16    MSG,
1830                                                TW_MEMREF    pData);
1831 #else   /* _MSWIN_ */
1832 /*FAR PASCAL TW_UINT16 DS_Entry( pTW_IDENTITY pOrigin,
1833                                TW_UINT32    DG,
1834                                TW_UINT16    DAT,
1835                                TW_UINT16    MSG,
1836                                TW_MEMREF    pData);*/
1837
1838 typedef TW_UINT16 (*DSENTRYPROC)(pTW_IDENTITY,
1839                                   TW_UINT32,    TW_UINT16,
1840                                   TW_UINT16,    TW_MEMREF);
1841 #endif  /* _MSWIN_ */
1842 #ifdef  __cplusplus
1843 }
1844 #endif  /* cplusplus */
1845
1846 /* The Twain structures must be packed on 2 byte alignment */
1847 #include "poppack.h"
1848
1849 #endif  /* TWAIN */