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