#pragma once #if !defined(_WIN32) && !defined(_WIN64) #define UTIL_API __attribute__((visibility("default"))) #include #else #ifdef UTIL_EXPORTS #define UTIL_API __declspec(dllexport) #else #define UTIL_API __declspec(dllimport) #endif #include #endif #include"DynamsoftCaptureVisionRouter.h" #define DISA_VERSION "1.4.20.2248" #ifdef __cplusplus using namespace dynamsoft::basic_structures; using namespace dynamsoft::cvr; namespace dynamsoft { namespace utility { /** * The CUtilityModule class defines general functions in the utility module. */ class UTIL_API CUtilityModule { public: /** * Get version information of utility module. * * @return Returns the version information string. * */ static const char* GetVersion(); }; /** * The CMultiFrameResultCrossFilter class is responsible for filtering captured results.It contains * several callback functions for different types of results,including raw image,decoded barcodes, * recognized text lines,detected quads,normalized images,and parsed results. * */ class UTIL_API CMultiFrameResultCrossFilter : public CCapturedResultFilter { private: class CMultiFrameResultCrossFilterInner; CMultiFrameResultCrossFilterInner* pInner; public: CMultiFrameResultCrossFilter(); CMultiFrameResultCrossFilter(CCaptureVisionRouter* router); virtual ~CMultiFrameResultCrossFilter(); /** * Enable result verification feature to improve the accuracy * of video streaming recognition results. * * @param [in] resultItemTypes The or value of the captured result item types. * @param [in] enabled Set whether to enable result verification. * */ void EnableResultCrossVerification(int resultItemTypes, bool enabled); /** * Determines whether the result verification feature is enabled for * the specific captured result item type. * * @param [in] type The specific captured result item type. * @return Returns a bool value indicating whether result verification is * enabled for the specific captured result item type. */ bool IsResultCrossVerificationEnabled(CapturedResultItemType type) const; /** * Enable duplicate filter feature to filter out the duplicate results in * the period of duplicateForgetTime for video streaming recognition. The * default value of duplicateForgetTime is 3000ms. * * CRIT_BARCODE:When the text and format are identical,it is considered as the same barcode. * CRIT_TEXT_LINE:When the text is exactly the same,it is considered as the same text line. * CRIT_DETECTED_QUAD:When the quadrilateral is approximately the same, it is considered as * the same quadrilateral. * * @param [in] resultItemTypes The or value of the captured result item types. * @param [in] enabled Set whether to enable result duplicate filter. * */ void EnableResultDeduplication(int resultItemTypes, bool enabled); /** * Determines whether the duplicate filter feature is enabled for the specific result item type. * * @param [in] type The specific captured result item type. * @return Returns a bool value indicating whether duplicate filter is enabled for the specific * result item type. * */ bool IsResultDeduplicationEnabled(CapturedResultItemType type) const; /** * Sets the duplicate forget time for the specific captured result item types.The same captured result * item will be returned only once during the period. * * CRIT_BARCODE:When the text and format are identical,it is considered as the same barcode. * CRIT_TEXT_LINE:When the text is exactly the same,it is considered as the same text line. * CRIT_DETECTED_QUAD:When the quadrilateral is approximately the same, it is considered as * the same quadrilateral. * * @param [in] resultItemTypes The or value of the captured result item types. * @param [in] time The duplicate forget time measured in milliseconds. * */ void SetDuplicateForgetTime(int resultItemTypes, int time); /** * Gets the duplicate forget time for a specific captured result item type. * * @param [in] type The specific captured result item type. * @return Returns the duplicate forget time for the specific captured result item type. * */ int GetDuplicateForgetTime(CapturedResultItemType type) const; /** * Sets the max referencing frames count for the to-the-latest overlapping feature. * * @param [in] resultItemTypes Specifies one or multiple specific result item types, which can be defined using CapturedResultItemType. * @param [in] maxOverlappingFrames The max referencing frames count for the to-the-latest overlapping feature. */ void SetMaxOverlappingFrames(int resultItemTypes, int maxOverlappingFrames); /** * Gets the max referencing frames count for the to-the-latest overlapping feature. * * @param [in] resultItemType Specifies a specific result item type, which can be defined using CapturedResultItemType. * @return Returns the max referencing frames count for the to-the-latest overlapping feature. */ int GetMaxOverlappingFrames(CapturedResultItemType resultItemType) const; /** * Enable to-the-latest overlapping feature. The output decoded barcode result will become a combination of the recent results if the latest frame is proved to be similar with the previous. * * @param [in] resultItemTypes The or value of the captured result item types. * @param [in] enabled Set whether to enable to-the-latest overlapping. * */ void EnableLatestOverlapping(int resultItemTypes, bool enabled); /** * Determines whether the to-the-latest overlapping feature is enabled for the specific result item type. * * @param [in] type The specific captured result item type. * @return Returns a bool value indicating whether to-the-latest overlapping is * enabled for the specific captured result item type. */ bool IsLatestOverlappingEnabled(CapturedResultItemType type) const; virtual void OnOriginalImageResultReceived(COriginalImageResultItem* pResult); virtual void OnDecodedBarcodesReceived(dbr::CDecodedBarcodesResult* pResult); virtual void OnRecognizedTextLinesReceived(dlr::CRecognizedTextLinesResult* pResult); virtual void OnDetectedQuadsReceived(ddn::CDetectedQuadsResult* pResult); virtual void OnNormalizedImagesReceived(ddn::CNormalizedImagesResult* pResult); virtual void OnParsedResultsReceived(dcp::CParsedResult* pResult); virtual void ClearStatus(); virtual void Init(); }; /** * The CProactiveImageSourceAdapter class is an abstract base class that extends the * CImageSourceAdapter class. It provides an interface for proactively fetching images in * a separate thread. */ class UTIL_API CProactiveImageSourceAdapter : public CImageSourceAdapter { private: class CProactiveImageSourceAdapterInner; CProactiveImageSourceAdapter(const CProactiveImageSourceAdapter&); CProactiveImageSourceAdapter& operator=(const CProactiveImageSourceAdapter&); CProactiveImageSourceAdapterInner* m_inner; void FetchImageToBuffer(); protected: CProactiveImageSourceAdapter(); /** * This method needs to be implemented in the derived class. It is called in a loop in the Fetching thread to obtain images. * * @return Returns a pointer to the CImageData object representing the fetched image. * */ virtual CImageData* FetchImage() = 0; public: ~CProactiveImageSourceAdapter(); bool HasNextImageToFetch()const override; /** * Sets the time interval for the ImageSource to wait before attempting to fetch another image to put in the buffer. * * @param [in] milliseconds Specifies the wait time in milliseconds. If set to -1, the ImageSource does not proactively fetch images. * */ void SetImageFetchInterval(int milliseconds); /** * Gets the time interval for the ImageSource to wait before attempting to fetch another image to put in the buffer. * * @return Returns the wait time in milliseconds. If the value is -1, the ImageSource does not proactively fetch images. * */ int GetImageFetchInterval()const; /** * Starts fetching images. */ void StartFetching()override; /** * Stops fetching images. */ void StopFetching()override; }; /** * The CDirectoryFetcher class is a utility class that retrieves a list of files from a specified directory based on certain criteria. It inherits from the CProactiveImageSourceAdapter class. */ class UTIL_API CDirectoryFetcher : public CProactiveImageSourceAdapter { /** Maximum Image Count is set to say 10 or 20; * Buffer ProtectionMode is set to Block; * FetchMode is set to Proactive; * FetchInterval is set to 0; * FetchIntervalAutoCalculatin is disabled; * FetchTimeout is set to 0; * * It works like this: * 1. Specify files with SetFilePath or SetDirectory * 2. The paths of the files are stored in filePaths * 3. Each time FetchImage is called, it processes the file specified by * indexOfNextFileToFetch and gets one image only * called, it tries to get the next image into Buffer. */ private: class DirectoryFetcherInner; DirectoryFetcherInner* m_directoryFetcherInner; CImageData* FetchImage()override; public: CDirectoryFetcher(); ~CDirectoryFetcher(); /** * Sets the directory path and filter for the file search. * * @param [in] path The path of the directory to search. * @param [in] filter A string that specifies file extensions. For example: "*.BMP;*.JPG;*.GIF", or "*.*", etc. * @param [in] recursive Specifies whether to load files recursively. * * @return Returns an integer value that represents the success or failure of the operation. * */ int SetDirectory(const char* filePath, const char* filter = "*.bmp;*.jpg;*.jpeg;*.tif;*.png;*.tiff;*.gif;*.pdf", bool recursive = false); /** * Sets the parameters for reading PDF files. * * @param [in] para The parameter object for reading PDF files. * * @return Returns an integer value that represents the success or failure of the operation. * */ int SetPDFReadingParameter(const CPDFReadingParameter& para); /** * Determines whether there are more images left to fetch. * * @return Returns true if there are more images left to fetch, false otherwise. This function must be implemented in the subclass. * */ bool HasNextImageToFetch()const override; /** * Sets the pages to be fetched. It only takes effect when the file is a multi-page image. * * @param [in] pages The pages to be fetched. * @param [in] pagesCount The number of pages to be fetched. * * @return Returns an integer value that represents the success or failure of the operation. * */ int SetPages(const int pages[], int pagesCount); }; /** * The 'CFileFetcher' class is a utility class that partitions a multi-page image file into multiple independent 'ImageData' objects. It inherits * from the 'CImageSourceAdapter' class. */ class UTIL_API CFileFetcher : public CImageSourceAdapter { public: CFileFetcher(const CPDFReadingParameter& pdfReadingParameter = CPDFReadingParameter()); ~CFileFetcher(); /** * Sets the file by path. * @param [in] path The file path. * @return Returns an integer value that represents the success or failure of the operation. */ int SetFile(const char* path); /** * Sets the file using a file bytes. * @param [in] pFileBytes The file bytes. * @param [in] fileSieze The file bytes length. * @return Returns an integer value that represents the success or failure of the operation. */ int SetFile(const unsigned char* pFileBytes, int fileSize); /** * Sets the file using a CImageData object. * @param [in] imageData The image data. * @return Returns an integer value that represents the success or failure of the operation. */ int SetFile(const CImageData* imageData); /** * Sets the parameters for reading PDF files. * @param [in] para The parameter object for reading PDF files. * @return Returns an integer value that represents the success or failure of the operation. */ int SetPDFReadingParameter(const CPDFReadingParameter& para); /** * Determines whether there are more images left to fetch. * * @return Returns true if there are more images left to fetch, false otherwise. This function must be implemented in the subclass. * */ bool HasNextImageToFetch()const override; /** * Returns a buffered image. * * @return Returns a pointer to the image if it exists in the buffer, NULL otherwise. * */ CImageData* GetImage()override; /** * Sets the pages to be fetched. It only takes effect when the file is a multi-page image. * * @param [in] pages The pages to be fetched. * @param [in] pagesCount The number of pages to be fetched. * * @return Returns an integer value that represents the success or failure of the operation. * */ int SetPages(const int pages[], int pagesCount); private: void* m_pFetcher; }; /** * The CImageManager class is a utility class for managing and manipulating images. It provides functionality for saving images to files and drawing various shapes on images. * */ class UTIL_API CImageManager { public: /** * Saves an image to a file. * * @param [in] pImageData A pointer to the image data to be saved. * @param [in] path The path to the file to save the image. * @param [in] overwrite A flag indicating whether to overwrite the file if it already exists. Defaults to true. * * @return Returns an integer indicating the success of the operation. 0 indicates success, while a non-zero value indicates an error occurred. * */ int SaveToFile(const CImageData* pImageData, const char* path, bool overwrite = true); /** * Draws various shapes on an image. * * @param [in] pImageData A pointer to the image data to draw on. * @param [in] quads[] An array of quadrilaterals to draw on the image. * @param [in] quadsCount The number of quadrilaterals in the array. * @param [in] color The color to use for drawing. Defaults to 0xFFFF0000 (red). * @param [in] thickness The thickness of the lines to draw. Defaults to 1. * * @return Returns a pointer to the modified image data. * */ CImageData* DrawOnImage(const CImageData* pImageData, CQuadrilateral quads[], int quadsCount, int color = 0xFFFF0000, int thickness = 1); CImageData* DrawOnImage(const CImageData* pImageData, CLineSegment lines[], int linesCount, int color = 0xFFFF0000, int thickness = 1); CImageData* DrawOnImage(const CImageData* pImageData, CContour contours[], int contoursCount, int color = 0xFFFF0000, int thickness = 1); CImageData* DrawOnImage(const CImageData* pImageData, CCorner corners[], int cornersCount, int color = 0xFFFF0000, int thickness = 1); CImageData* DrawOnImage(const CImageData* pImageData, CEdge edges[], int edgesCount, int color = 0xFFFF0000, int thickness = 1); }; } } #endif // __cplusplus