280 lines
10 KiB
C++
280 lines
10 KiB
C++
/***************************************************************************
|
||
* Copyright ?2007 TWAIN Working Group:
|
||
* Adobe Systems Incorporated, AnyDoc Software Inc., Eastman Kodak Company,
|
||
* Fujitsu Computer Products of America, JFL Peripheral Solutions Inc.,
|
||
* Ricoh Corporation, and Xerox Corporation.
|
||
* All rights reserved.
|
||
*
|
||
* Redistribution and use in source and binary forms, with or without
|
||
* modification, are permitted provided that the following conditions are met:
|
||
* * Redistributions of source code must retain the above copyright
|
||
* notice, this list of conditions and the following disclaimer.
|
||
* * Redistributions in binary form must reproduce the above copyright
|
||
* notice, this list of conditions and the following disclaimer in the
|
||
* documentation and/or other materials provided with the distribution.
|
||
* * Neither the name of the TWAIN Working Group nor the
|
||
* names of its contributors may be used to endorse or promote products
|
||
* derived from this software without specific prior written permission.
|
||
*
|
||
* THIS SOFTWARE IS PROVIDED BY TWAIN Working Group ``AS IS'' AND ANY
|
||
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
* DISCLAIMED. IN NO EVENT SHALL TWAIN Working Group BE LIABLE FOR ANY
|
||
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
*
|
||
***************************************************************************/
|
||
|
||
/**
|
||
* @file CTWAINDS_FreeImage.h
|
||
* The main Data Source class.
|
||
* This class is derived from the Base class describing a TWAIN DS.
|
||
* @author TWAIN Working Group
|
||
* @date April 2007
|
||
*/
|
||
#ifndef __CTWAINDS_FREEIMAGE_H__
|
||
#define __CTWAINDS_FREEIMAGE_H__
|
||
|
||
#include "CTWAINDS_Base.h"
|
||
#include "CScanner_FreeImage.h"
|
||
#include "JsonConfig.h"
|
||
//#include "IndicatorDlg.h"
|
||
|
||
#define CUSTCAP_LONGDOCUMENT CAP_CUSTOMBASE+1
|
||
#define CUSTCAP_DOCS_IN_ADF CAP_CUSTOMBASE+2
|
||
|
||
#define kCUSTOMDSGUI "{A4FAF845-1383-4036-AEDC-17C3968188B4}"
|
||
|
||
const TW_GUID CustomDSGUI =
|
||
{ 0xa4faf845, 0x1383, 0x4036, { 0xae, 0xdc, 0x17, 0xc3, 0x96, 0x81, 0x88, 0xb4 } };
|
||
|
||
typedef struct _CUST_DS_DATA_ELEMENT
|
||
{
|
||
DWORD dwSize;
|
||
TW_UINT16 unCapID;
|
||
TW_UINT16 unCapIdx;
|
||
TW_UINT16 unItemType;
|
||
TW_UINT16 unContType;
|
||
DWORD dwVal[1];
|
||
}CUST_DS_DATA_ELEMENT;
|
||
|
||
/**
|
||
* This is the main DS class. It inherits the TWAIN base class, implements all
|
||
* the pure virtual functions and manages all of the required capabilities
|
||
*/
|
||
class CTWAINDS_FreeImage : public CTWAINDS_Base
|
||
{
|
||
public:
|
||
CTWAINDS_FreeImage(TW_IDENTITY AppID);
|
||
~CTWAINDS_FreeImage();
|
||
|
||
/**
|
||
* Fills the passed in identity structure with our information.
|
||
* @param[in] _idStruct the TW_IDENTITY structure to fill
|
||
*/
|
||
void fillIdentityStructure(TW_IDENTITY& _idStruct);
|
||
|
||
/**
|
||
* Initialize the Datasource. Allocate memory for Capabilities.
|
||
* Sets condition code if had problem.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 Initialize();
|
||
|
||
/**
|
||
* Get image information.
|
||
* Implementation of base class pure virtual function.
|
||
* Called when a DG_IMAGE / DAT_IMAGEINFO / MSG_GET op is sent.
|
||
* -If in state 6, general info is provided about the image about to be transferred.
|
||
* -If in state 7, specific info is provided about the current image just transferred.
|
||
* @param[out] _pImageInfo a TW_IMAGEINFO structure to return image information.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 getImageInfo(pTW_IMAGEINFO _pImageInfo);
|
||
|
||
/**
|
||
* Open the Data Source.
|
||
* Implementation of base class pure virtual function.
|
||
* Called when a DG_CONTROL / DAT_IDENTITY / MSG_OPENDS op is sent.
|
||
* @param[in] _pOrigin a pointer to TW_IDENTITY structure of the Application identity.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 openDS(pTW_IDENTITY _pOrigin);
|
||
|
||
/**
|
||
* Close the Data Source.
|
||
* Implementation of base class pure virtual function.
|
||
* Called when a DG_CONTROL / DAT_IDENTITY / MSG_CLOSEDS op is sent.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 closeDS();
|
||
|
||
/**
|
||
* Process events.
|
||
* Implementation of base class pure virtual function.
|
||
* Called when a DG_CONTROL / DAT_EVENT / MSG_PROCESSEVENT op is sent.
|
||
* @param[in] _pEvent a pointer to TW_EVENT structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 processEvent(pTW_EVENT _pEvent);
|
||
|
||
/**
|
||
* Stop currect transfer if not done. Single from application that application is
|
||
* done with all data with current image.
|
||
* Check to see if there is still documents or data remaining to transfer.
|
||
* Implementation of base class pure virtual function.
|
||
* Called when a DG_CONTROL / DAT_PENDINGXFERS / MSG_ENDXFER op is sent.
|
||
* @param[out] _pXfers a pointer to TW_PENDINGXFERS structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 endXfer(pTW_PENDINGXFERS _pXfers);
|
||
|
||
/**
|
||
* Check to see if there is still documents or data remaining to transfer.
|
||
* Called when a DG_CONTROL / DAT_PENDINGXFERS / MSG_GET op is sent.
|
||
* @param[out] _pXfers a pointer to TW_PENDINGXFERS structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 getXfer(pTW_PENDINGXFERS _pXfers);
|
||
|
||
/**
|
||
* Flush all pending transfers from the Source..
|
||
* Called when a DG_CONTROL / DAT_PENDINGXFERS / MSG_RESET op is sent.
|
||
* @param[out] _pXfers a pointer to TW_PENDINGXFERS structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 resetXfer(pTW_PENDINGXFERS _pXfers);
|
||
|
||
/**
|
||
* Called by the base class when the data source is enabled.
|
||
* @param[in] _pData contains info about if the UI should be shown etc.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 enableDS(pTW_USERINTERFACE _pData);
|
||
|
||
/**
|
||
* Enable the Data Source in setup mode.
|
||
* Called when a DG_CONTROL / DAT_USERINTERFACE / MSG_ENABLEDS op is sent.
|
||
* @param[in] _pData a pointer to a TW_USERINTERFACE structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 enableDSOnly(pTW_USERINTERFACE _pData);
|
||
|
||
/**
|
||
* Called by the base class when the data source is disabled.
|
||
* @param[in] _pData a pointer to a TW_USERINTERFACE struct.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 disableDS(pTW_USERINTERFACE _pData);
|
||
|
||
|
||
/**
|
||
* handles DAT_IMAGELAYOUT requests
|
||
* @param[in] _MSG the message to handle.
|
||
* @param[in] _pData a pointer to TW_IMAGELAYOUT structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 dat_imagelayout(TW_UINT16 _MSG, pTW_IMAGELAYOUT _pData);
|
||
|
||
/**
|
||
* Figures out what to do with the DAT_EXTIMAGEINFO request.
|
||
* @param[in] _MSG the message to handle.
|
||
* @param[in] _pData a pointer to a TW_EXTIMAGEINFO structure.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 dat_extimageinfo(TW_UINT16 _MSG,
|
||
pTW_EXTIMAGEINFO _pData);
|
||
|
||
/**
|
||
* Called by the base class to when the application wants to get memory transfer data.
|
||
* @param[in] _pData filled with buffer size data
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 getMemoryXfer(pTW_SETUPMEMXFER _pData);
|
||
|
||
/**
|
||
* Transfer image data from scanner to memory.
|
||
* Called during one of the transfer methods.
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 transfer();
|
||
|
||
/**
|
||
* Return a CTWAINContainer for requested capability.
|
||
* @param[in] _unCap the ICAP_xxxx that is requested.
|
||
* @return a CTWAINContainer for the capability.
|
||
*/
|
||
CTWAINContainer* findCapability(const TW_UINT16 _unCap);
|
||
|
||
/**
|
||
* Request the DSM the most likly user clicks on the <20>OK?button on GUI.
|
||
* @return true if successful.
|
||
*/
|
||
virtual bool DoCloseDSOkEvent();
|
||
|
||
/**
|
||
* Updates the scanner from the current caps.
|
||
* @return true if successful.
|
||
*/
|
||
bool updateScannerFromCaps();
|
||
|
||
/**
|
||
* Convenience function that will get the proper ICAP_BITDEPTH container
|
||
* @return CTWAINContainer BitDepth for current PixelType.
|
||
*/
|
||
CTWAINContainer* getICAP_BITDEPTH();
|
||
|
||
bool StartScanning(bool showUI=true);
|
||
bool StopScanning();
|
||
bool ReadCustomDSdata(stringstream &DsData);
|
||
bool StoreCustomDSdata(stringstream &DsData);
|
||
bool StoreCapInStream(stringstream &_DsData, TW_UINT16 _unCapID, TW_UINT16 _unCapIdx, TW_UINT16 unContType);
|
||
bool ReadCapFromStream(stringstream &_DsData, TW_UINT16 _unCapID, TW_UINT16 _unCapIdx);
|
||
|
||
/**
|
||
* Get Gustom DS data
|
||
* @param[out] _pDSData a pointer to a TW_CUSTOMDSDATA structure.
|
||
* @return a valid TWRC_xxxx return code, TWRC_SUCCESS on success.
|
||
*/
|
||
TW_INT16 GetGustomDSData(pTW_CUSTOMDSDATA _pDSData);
|
||
|
||
/**
|
||
* Set Gustom DS data
|
||
* @param[in] _pDSData a pointer to a TW_CUSTOMDSDATA structure.
|
||
* @return a valid TWRC_xxxx return code, TWRC_SUCCESS on success.
|
||
*/
|
||
TW_INT16 SetGustomDSData(pTW_CUSTOMDSDATA _pDSData);
|
||
|
||
/**
|
||
* Validate the value being used to set a capability. Ranges and enums can be tested
|
||
* by the capability but OneValues might have only some values that are acceptable.
|
||
* Override this function in base class to support more capabilities
|
||
* @param[in] Cap the Capability ID
|
||
* @param[in] ConType the container type
|
||
* @param[in] _pCap a pointer to BYTE. Pointer to Cap container
|
||
* @return a valid TWRC_xxxx return code.
|
||
*/
|
||
TW_INT16 validateCapabilitySet(TW_UINT16 _Cap, TW_UINT16 _ConType, BYTE* _pContainer);
|
||
|
||
bool UpdateCapsFromConfig(CONFIGPARAMS pConfig);
|
||
std::string GetSerialNum();
|
||
std::string GetFWVerison();
|
||
bool IsImageQueueEmpty();
|
||
protected:
|
||
CScanner_FreeImage m_Scanner; /**< The main scanner. */
|
||
|
||
TWAINCapabilitiesMap_int m_BitDepthMap; /**< Capability for various Bit Depths */
|
||
CTWAINContainerFrame *m_pICAP_FRAMES; /**< Capabiltiy for a FRAMES based container */
|
||
TW_IDENTITY m_AppID;
|
||
bool m_bCanceled;
|
||
CTWAIN_UI *m_pGUI; /**< This is the main MFC UI dialog */
|
||
bool bIndicators;
|
||
BOOL b_created;
|
||
bool isDestroyed;
|
||
};
|
||
#endif // __CTWAINDS_FREEIMAGE_H__
|