Twain Practice

Official Website:http://www.twain.org

一、简介

    TWAIN 数据源管理程序 (DSM) 工业标准的软件库，用于从静态图像设备提取图像。绝大部分的扫描仪和数码相机都提供了 TWAIN 驱动程序，利用统一的 TWAIN 接口，应用程序可以非常方便地从这些设备中获取图像。

二、使用步骤

    互联网上关于 TWAIN 编程的中文资料很少，代码更是难找到，因为我不得不仔细阅读了 www.twain.org 提供的 TWAIN Specification。下面说说使用 TWAIN 接口获取图像的简要步骤。

    Windows 系统中存在一个 TWAIN_32.dll，所有的 TWAIN 操作都是通过这个 DLL 导出的 DSM_Entry 函数来实现的 (说实在话，我个人觉得 TWAIN 接口设计得太差了，看看 MS 的WIA，逻辑上非常清晰)。这个函数的声明如下:

        TW_UINT16 FAR PASCAL DSM_Entry(
            pTW_IDENTITY pOrigin,   // Source of message
            pTW_IDENTITY pDest,     // Destination of message
            TW_UINT32 DG,           // Data group ID: DG_xxxx
            TW_UINT16 DAT,          // Data argument type: DAT_xxxx
            TW_UINT16 MSG,          // Message ID: MSG_xxxx
            TW_MEMREF pData         // Pointer to data
            );

1. 打开 DSM (Data Source Manager: 数据源管理器)

    TWAIN 是一个数据源管理程序，应用程序首先要使用 MSG_OPENDSM 消息，打开数据源管理器。这里需要指定一个窗口句柄，应用程序应该在此窗口的消息循环中处理 TWAIN 消息 (MSG_PROCESSEVENT)。

2. 选择 DS (Data Source: 数据源)

    因为一个系统中可能存在多个 TWAIN 设备，因此必须选择一个数据源。选择数据源通常有两种方式:  选择默认数据源 (MSG_GETDEFAULT) 和显示选择数据源对话框，由用户来选择数据源 (MSG_USERSELECT)。

3. 打开 DS

    使用 MSG_OPENDS 消息打开数据源。

4. 设置参数

    消息为 MSG_SET，设置各种参数，如获取方式、图像数量等。有些参数由设备驱动支持才有效。

5. 显示扫描界面

    使用 MSG_ENABLEDS 消息，显示设备驱动提供的用户界面 (UI)。

6. 获取图像

    如果用户选择扫描什么的，可以在窗口的消息循环中获取到这个事件 (MSG_XFERREADY)。此时，应用程序可以通过 DAT_SETUPFILEXFER 设置文件名，然后用 DAT_IMAGEFILEXFER 获取图像到文件中。

7. 关闭扫描界面

    在窗口的消息循环中获取到 MSG_CLOSEDSREQ 或 MSG_CLOSEDSOK 消息，可以关闭扫描界面 (MSG_DISABLEDS)。

8. 关闭 DS

    消息为 MSG_CLOSEDS。

9. 关闭数据源
   
    消息为 MSG_CLOSEDSM。

三、CTwainHelper 助手类

    为了使用方便，我写了一个静态 TWAIN 助手类 CTwainHelper。使用 CTwainHelper 的五个函数，就可以简单地从 TWAIN 设备获取图像到文件中。使用方法如下:

1. 调用 CTwainHelper::Initialize() 确定是否有可用的设备。
2. 在窗口消息循环中，调用 CTwainHelper::ProcessMessage() 处理 TWAIN 消息。
3. 要获取图像时，调用 CTwainHelper::GetImage()。
4. 如果图像已准备好 (如用户确定扫描图像)，窗口会收到 WM_COMMAND 消息，wParam 为 IDC_TwainHelper。此时应用程序可以调用 CTwainHelper::TransferImage() 获取图像到文件中。

    具体使用方法请参看示例代码。
   
    CTwainHelper 可以在 Visual C++ 6.x/7.x 工程中使用，支持 UNICODE 编译。因为是静态类，要改写成 C 代码只需要做一点点少量的工作。
   

四、后话

    当然，上面只是一种常用的步骤。其实应用程序完全可以自定义所有的步骤，比如不使用 TWAIN 驱动提供扫描对话框而直接扫描，或者扫描图像到内存中等等。详细情况请参考 TWAIN Specification，步骤大同小异，消息和参数千差万别，仔细看看应该很容易的。

    如果没有 TWAIN 设备又要进行 TWAIN 程序开发，可以到 TWAIN 官方网站下载 TWAIN Developers Toolkit，安装后会有一个虚拟的 TWAIN 设备。不过应用程序在这个虚拟 TWAIN 设备中正常工作，不代表一定能在实际的 TWAIN 设备正常使用，这点需要注意。以前 CTwainHelper 就碰到过这样的情况  在虚拟 TWAIN 设备中明明是好的，在我的扫描仪上却不能扫描图像。检查后发现，原来设置了不支持的参数。
   
    最后，TWAIN 是 Technology Without A Interesting Name 缩写，直译为没有“没有让人感兴趣名字的技术”，真是一个让人摸不着头脑的名字。

    TWAIN 助手类: CTwainHelper (包含示例代码 35K)
    TWAIN 官方网站: http://www.twain.org
    TWAIN 头文件: http://www.twain.org/devfiles/twain.h
    TWAIN Specification: http://www.twain.org/docs/Spec1_9_197.pdf
    TWAIN Developers Toolkit: http://www.twain.org/devfiles/twainkit.exe

Load the Source Manager and Get the DSM_Entry (State 1 to 2)
Open the Source Manager (State 2 to 3)
Select the Source (during State 3)
Open the Source (State 3 to 4)
Negotiate Capabilities with the Source (during State 4)
Request the Acquisition of Data from the Source (State 4 to 5)
Recognize that the Data Transfer is Ready (State 5 to 6)
Start and Perform the Transfer (State 6 to 7)
Conclude the Transfer (State 7 to 6 to 5)
Disconnect the TWAIN Session (State 5 to 1 in sequence)

VC++ Call Twain

Header

 #ifndef __TWAINCPP_
 #define __TWAINCPP_

 #include "Twain.h"


 #define TWCPP_ANYCOUNT        (-1)
 #define TWCPP_CANCELTHIS    (1)
 #define TWCPP_CANCELALL        (2)
 #define TWCPP_DOTRANSFER    (0)

 class CTwain
 {
 public:
     void Deskew(LPSTR lpFilename);


     CTwain(HWND hWnd = NULL);
     virtual ~CTwain();
     BOOL InitTwain(HWND hWnd);
     void ReleaseTwain();


     /*
       This routine must be implemented by the dervied class
       After setting the required values in the m_AppId structure,
       the derived class should call the parent class implementation
       Refer Pg: 51 of the Twain Specification version 1.8
     */
     virtual void GetIdentity();
     virtual BOOL SelectSource();
     virtual BOOL OpenSource(TW_IDENTITY *pSource=NULL);
     virtual int  ShouldTransfer(TW_IMAGEINFO& info) { return TWCPP_DOTRANSFER;};

     void SetPara(int nFileFormat,LPCTSTR lpFileName,int nAD,int nPage,int nStep,BOOL bDeskdw);
     void GetPara(UINT &nPage);

     BOOL ProcessMessage(MSG msg);

     BOOL SelectDefaultSource();
     BOOL IsValidDriver() const;
     BOOL SourceSelected() const {return m_bSourceSelected;} ;
     BOOL DSMOpen() const;
     BOOL DSOpen() const;
     BOOL SourceEnabled() const { return m_bSourceEnabled;};
     BOOL ModalUI() const { return m_bModalUI; };

     TW_INT16 GetRC() const { return m_returnCode; };
     TW_STATUS GetStatus() const { return m_Status; };

     BOOL SetImageCount(TW_INT16 nCount = 1);
     BOOL Acquire(int numImages=1);
     void DoFileTransfer();
     void CloseDSM();
 protected:
     BOOL CallTwainProc(pTW_IDENTITY pOrigin,pTW_IDENTITY pDest,
                        TW_UINT32 DG,TW_UINT16 DAT,TW_UINT16 MSG,
                        TW_MEMREF pData);

     void CloseDS();

     BOOL GetCapability(TW_CAPABILITY& twCap,TW_UINT16 cap,TW_UINT16 conType=TWON_DONTCARE16);
     BOOL GetCapability(TW_UINT16 cap,TW_UINT32& value);
     BOOL SetCapability(TW_UINT16 cap,TW_UINT16 value,BOOL sign=FALSE);
     BOOL SetCapability(TW_CAPABILITY& twCap);
     BOOL EnableSource(BOOL showUI = TRUE);

     BOOL GetImageInfo(TW_IMAGEINFO& info);

     virtual BOOL DisableSource();
     virtual BOOL CanClose()  { return TRUE; };

     void TranslateMessage(TW_EVENT& twEvent);
     void TransferImage();
     BOOL EndTransfer();
     void CancelTransfer();
     BOOL ShouldContinue();
     BOOL GetImage(TW_IMAGEINFO& info);

 //    virtual void CopyImage(HANDLE hBitmap,TW_IMAGEINFO& info)=0;

 protected:
     HINSTANCE m_hTwainDLL;
     DSMENTRYPROC m_pDSMProc;

     TW_IDENTITY m_AppId;
     TW_IDENTITY m_Source;
     TW_STATUS m_Status;
     TW_INT16  m_returnCode;
     HWND m_hMessageWnd;

     BOOL m_bSourceSelected;
     BOOL m_bDSMOpen;
     BOOL m_bDSOpen;
     BOOL m_bSourceEnabled;
     BOOL m_bModalUI;

Cpp

 #include "stdafx.h"
 #include "twaincpp.h"
 #include "showpic.h"
 #include "tiff2pdfdll.h"

 CTwain::CTwain(HWND hWnd)
 {
     m_hTwainDLL = NULL;
     m_pDSMProc = NULL;
     m_bSourceSelected = FALSE;
     m_bDSOpen = m_bDSMOpen = FALSE;
     m_bSourceEnabled = FALSE;
     m_bModalUI = TRUE;
     m_nImageCount = TWCPP_ANYCOUNT;
     if(hWnd)
     {
         InitTwain(hWnd);
     }
 }

 CTwain::~CTwain()
 {
     ReleaseTwain();
 }

 /*
 初始化TWAIN 接口. 构造函数中已经调用，不过如果调用了ReleaseTwain的话就需要再次调用.
 hWnd是接受Twain消息的窗口句柄，通常应该是主应用程序的窗口句柄
 */
 BOOL CTwain::InitTwain(HWND hWnd)
 {
 char libName[512];
     if(IsValidDriver())
     {
         return TRUE;
     }
     memset(&m_AppId,0,sizeof(m_AppId));
     if(!IsWindow(hWnd))
     {
         return FALSE;
     }
     m_hMessageWnd = hWnd;
     strcpy(libName,"TWAIN_32.DLL");

     m_hTwainDLL  = LoadLibrary(libName);
     if(m_hTwainDLL != NULL)
     {
         if(!(m_pDSMProc = (DSMENTRYPROC)GetProcAddress(m_hTwainDLL,MAKEINTRESOURCE(1))))
         {
             FreeLibrary(m_hTwainDLL);
             m_hTwainDLL = NULL;
         }
     }
     if(IsValidDriver())
     {
         GetIdentity();
         m_bDSMOpen= CallTwainProc(&m_AppId,NULL,DG_CONTROL,DAT_PARENT,MSG_OPENDSM,(TW_MEMREF)&m_hMessageWnd);
         return TRUE;
     }
     else
     {
         return FALSE;
     }
 }

 /*
 释放Twain接口，除非不再使用Twain接口，否则就无需调用
 */
 void CTwain::ReleaseTwain()
 {
     if(IsValidDriver())
     {
         CloseDSM();
         FreeLibrary(m_hTwainDLL);
         m_hTwainDLL = NULL;
         m_pDSMProc = NULL;
     }
 }

 /*
 如果正确的装载了驱动程序，就返回TRUE
 */
 BOOL CTwain::IsValidDriver() const
 {
     return (m_hTwainDLL && m_pDSMProc);
 }

 BOOL CTwain::CallTwainProc(pTW_IDENTITY pOrigin,pTW_IDENTITY pDest,
                        TW_UINT32 DG,TW_UINT16 DAT,TW_UINT16 MSG,
                        TW_MEMREF pData)
 {
     if(IsValidDriver())
     {
     USHORT ret_val;
         ret_val = (*m_pDSMProc)(pOrigin,pDest,DG,DAT,MSG,pData);
         m_returnCode = ret_val;
         if(ret_val != TWRC_SUCCESS)
         {
             (*m_pDSMProc)(pOrigin,pDest,DG_CONTROL,DAT_STATUS,MSG_GET,&m_Status);
         }
         return (ret_val == TWRC_SUCCESS);
     }
     else
     {
         m_returnCode = TWRC_FAILURE;
         return FALSE;
     }
 }

 /*
 设置Twain的一些入口参数
 */
 void CTwain::GetIdentity()
 {
     // Expects all the fields in m_AppId to be set except for the id field.
     m_AppId.Id = 0; // Initialize to 0 (Source Manager
     m_AppId.Version.MajorNum = 1; //Your app's version number
     m_AppId.Version.MinorNum = 5;
     m_AppId.Version.Language = TWLG_USA;
     m_AppId.Version.Country = TWCY_USA;
     strcpy (m_AppId.Version.Info, "3.5");
     m_AppId.ProtocolMajor = TWON_PROTOCOLMAJOR;
     m_AppId.ProtocolMinor = TWON_PROTOCOLMINOR;
     m_AppId.SupportedGroups = DG_IMAGE | DG_CONTROL;
     strcpy (m_AppId.Manufacturer, "MICSS");
     strcpy (m_AppId.ProductFamily, "Generic");
     strcpy (m_AppId.ProductName, "Twain Test");

 }


 /*
 调用此函数显示选择扫描设备窗口
 */
 BOOL CTwain::SelectSource()
 {
     memset(&m_Source,0,sizeof(m_Source));
     if(!SourceSelected())
     {
         SelectDefaultSource();
     }
     if(CallTwainProc(&m_AppId,NULL,DG_CONTROL,DAT_IDENTITY,MSG_USERSELECT,&m_Source))
     {
         m_bSourceSelected = TRUE;
     }
     return m_bSourceSelected;
 }

 /*
 用于选择缺省扫描设备
 */
 BOOL CTwain::SelectDefaultSource()
 {
     m_bSourceSelected = CallTwainProc(&m_AppId,NULL,DG_CONTROL,DAT_IDENTITY,MSG_GETDEFAULT,&m_Source);
     return m_bSourceSelected;
 }

 /*
 关闭数据源（即扫描仪）
 */
 void CTwain::CloseDS()
 {
     if(DSOpen())
     {
         DisableSource();
         CallTwainProc(&m_AppId,NULL,DG_CONTROL,DAT_IDENTITY,MSG_CLOSEDS,(TW_MEMREF)&m_Source);
         m_bDSOpen = FALSE;
     }
 }

 /*
 关闭数据源管理器
 */
 void CTwain::CloseDSM()
 {
     if(DSMOpen())
     {
         CloseDS();
         CallTwainProc(&m_AppId,NULL,DG_CONTROL,DAT_PARENT,MSG_CLOSEDSM,(TW_MEMREF)&m