code_device/hgdriver/hgdev/hg_scanner.h

#pragma once

// hg_scanner is the base class of kinds of scanners
//
// created on 2022-01-30
//
#include <memory>
#include <string>
#include <vector>
#include <algorithm>
#include <mutex>
#include <thread>

#include "usb_manager.h"
#include "../../sdk/hginclude/huagaoxxx_warraper_ex.h"
#include "jsonconfig.h"
#include "../3rdparty/nick/StopWatch.h"
#include "hg_ipc.h"
#include "common_setting.h"
#include "image_process.h"
#include "StopWatch.h"
#include "PaperSize.h"

#if defined(WIN32) || defined(_WIN64)
#else
#include <unistd.h>
#endif

#define MAPPING_FUNCTION_IN_BASE                            // 定义该标志，各子类不必再初始化setting_map_数组

#ifdef OEM_HANWANG
#define hg_scanner      hw_scanner
#elif defined(OEM_LISICHENG)
#define hg_scanner      lsc_scanner
#endif

class hg_scanner
{
    bool                notify_setting_result_;
	std::string	        name_;
    std::string         save_multiout; //保存多留输出类型
    bool                save_sizecheck;
    int                 is_color_type_;//保存最后下发到设备的颜色类型
    sane_callback       ui_ev_cb_;
    do_when_born_and_dead<hg_scanner>* scan_life_;

    std::unique_ptr<std::thread> thread_usb_read_;
    void thread_handle_usb(void);

    std::unique_ptr<std::thread> thread_img_handle_;
    void thread_image_handle(void);

    void get_range(int setting_no, std::vector<std::string>& range, std::string& def_val, bool& is_range/*range or list*/);
    bool check_range(int setting_no, bool& val);
    bool check_range(int setting_no, int& val);
    bool check_range(int setting_no, double& val);
    bool check_range(int setting_no, std::string& val);
    int  restore(int setting_no);
    bool get_default_value(void* buf, json* jsn);
    bool is_to_file(void);
    void thread_handle_image_process(void);

    void working_begin(void*);
    void working_done(void*);

    

    void reset_custom_area_range(int paper);
    int  set_color_change(void);

    /////////////////////////////////////////
    // ids ...
    int id_scan_mode_ = -1;
    int id_scan_count_ = -1;
    /////////////////////////////////////////

    // 设置接口
protected:

    // 配置序号映射数组，各子类必须重载“init_setting_map”方法以初始化该数组 --> 2022-05-09：基类中以title自动匹配功能序号，子类不必再处理并屏蔽此项工作
    // 比如：  某型设备的“颜色模式”功能号为1，则 setting_map_[HG_BASE_SETTING_INDEX_COLOR_MODE] = 1
    //         如果设备的“颜色模式”配置逻辑与基类预定义的不同，
    //          则 setting_map_[HG_BASE_SETTING_INDEX_COLOR_MODE] = -1，在子类重载的set_setting_value方法中处理
    // 
    // 2022-06-28: 属性处理函数改用map结构存储，只须处理set_setting_map函数即可
    //  int             setting_map_[HG_BASE_SETTING_INDEX_MAX];
    //virtual void init_setting_map(int* setting_map, int count);
    map<int, int (hg_scanner::*)(int, void*)>    setting_map_;
    int invoke_setting_xxx(int(hg_scanner::* func)(int, void*), void* data);
    void set_setting_map(int sn, const char* title);

    int setting_restore(int sn, void* data);
    int setting_help(int sn, void* data);
    int setting_color_mode(int sn, void* data);
    
    int setting_multi_out(int sn, void*data);
    int setting_multi_out_type(int sn, void*data);

    int setting_rid_color(int sn, void* data);
    int setting_rid_multi_red(int sn, void* data);
    int setting_rid_answer_red(int sn, void* data);
    int setting_erase_background(int sn, void* data);
    int setting_erase_background_range(int sn, void* data);
    int setting_noise_optimize(int sn, void* data);
    int setting_noise_optimize_range(int sn, void* data);
    int setting_paper(int sn, void* data);
    int setting_paper_check(int sn, void* data);
    int setting_page(int sn, void* data);
    int setting_page_omit_empty(int sn, void* data);
    int setting_resolution(int sn, void* data);
    int setting_exchagnge(int sn, void* data);
    int setting_split_image(int sn, void* data);
    int setting_automatic_skew(int sn, void* data);
    int setting_rid_hole(int sn, void* data);
    int setting_rid_hoe_range(int sn, void* data);
    int setting_bright(int sn, void* data);
    int setting_contrast(int sn, void* data);
    int setting_gamma(int sn, void* data);
    int setting_sharpen(int sn, void* data);
    int setting_dark_sample(int sn, void* data);
    int setting_erase_black_frame(int sn, void* data);
    int setting_threshold(int sn, void* data);
    int setting_anti_noise(int sn, void* data);
    int setting_margin(int sn, void* data);
    int setting_filling_background(int sn, void* data);
    int setting_is_permeate(int sn, void*data);
    int setting_is_permeate_lv(int sn, void*data);
    int setting_remove_morr(int sn, void* data);
    int setting_error_extention(int sn, void* data);
    int setting_remove_texture(int sn, void* data);
    int setting_ultrasonic_check(int sn, void* data);
    int setting_go_on_when_double_checked(int sn, void* data);
    int setting_staple_check(int sn, void* data);
    int setting_scan_mode(int sn, void* data);
    int setting_scan_count(int sn, void* data);
    int setting_text_direction(int sn, void* data);
    int setting_rotate_bkg_180(int sn, void* data);
    int setting_fractate_check(int sn, void* data);
    int setting_fractate_check_level(int sn, void* data);
    int setting_skew_check(int sn, void* data);
    int setting_skew_check_level(int sn, void* data);
    int setting_is_custom_gamma(int sn, void* data);
    int setting_custom_gamma_data(int sn, void* data);
    int setting_is_custom_area(int sn, void* data);
    int setting_custom_area_left(int sn, void* data);
    int setting_custom_area_top(int sn, void* data);
    int setting_custom_area_right(int sn, void* data);
    int setting_custom_area_bottom(int sn, void* data);
    int setting_img_quality(int sn, void*data);
    int setting_color_fill(int sn, void*data);
    int setting_keep_watermark(int sn, void* data);
    int setting_black_white_threshold(int sn, void* data);
    int setting_setfeedmode(int sn, void* data);
    int setting_getfeedmode(int sn, void* data);
    int setting_setsleeptime(int sn, void* data);
    int setting_getsleeptime(int sn, void* data);

    virtual int on_color_mode_changed(int& color_mode); // COLOR_MODE_xxx
    virtual int on_paper_changed(int& paper);           // PAPER_xxx
    virtual int on_paper_check_changed(bool& check);
    virtual int on_resolution_changed(int& dpi);
    virtual int on_ultrasonic_check_changed(bool& check);
    virtual int on_staple_check_changed(bool& check);
    virtual int on_skew_check_changed(bool& check);
    virtual int on_skew_check_level_changed(int& check);
    virtual int on_get_feedmode(int& feedmode);//获取分纸强度
    virtual int on_set_feedmode(int feedmode);//设置分纸强度

protected:
    virtual void on_device_reconnected(void);
	virtual int set_setting_value(int setting_no, void* data, int len);
	virtual int on_scanner_closing(bool force);
    virtual void thread_handle_usb_read(void) = 0;
    virtual void image_process(std::shared_ptr<tiny_buffer>& buff) = 0;

    // adjust color or apply custom gamma 
    void adjust_color(hg_imgproc::HIMGPRC handle);
    hg_imgproc::HIMGPRC get_image_process_object(int model);
    SANE_Image_Statu last_usb_image_statu(int err);

protected:
    volatile bool   run_;
    volatile bool   user_cancel_;
    platform_event     wait_usb_;
    platform_event     wait_img_;
    platform_event      wait_usb_result_;
    usb_io*         io_;
    std::mutex      io_lock_;
    bool            online_;
    int			    status_;
    bool            async_io_;
    bool            cb_mem_;
    bool            test_1_paper_;      // 是否为单张扫描模式
    json	        setting_jsn_;
    int             setting_count_;

    IMGPRCFIXPARAM  image_prc_param_;
    int             erase_bkg_range_;   // 背景移除像素范围
    int             noise_range_;       // 噪点优化尺寸
    TwSS            paper_size_;
    int             omit_empty_level_;  // 跳过空白页灵敏度
    int             resolution_;        // 分辨率
    double          rid_hole_range_;    // 穿孔移除范围
    int             bright_;            // 亮度
    int             contrast_;          // 对比度
    double          gamma_;             // 伽玛
    int             threshold_;         // 阈值
    int             anti_noise_;        // 背景搞噪等级
    int             margin_;            // 边缘缩进
    int             fractate_level_;    // 折角检测复杂度
    int             scan_count_;        // 扫描张数，各实例化类在重载set_setting_value中，如果发现该设置项对该参数有影响时，需要对此值作更改
    bool            is_auto_matic_color;// 自动颜色识别
    int             is_quality_;        // 画质设置
    bool            is_color_fill;      // 色彩填充
    bool            is_multiout;        // 多流输出
   
    int             bw_threshold_;      // 黑白图像阈值 （added on 2022-06-28）
    int             feedmode_;          // 分纸强度
    int             sleeptime_;         // 睡眠时间

    SCANCONF 	img_conf_;  //此参数外部不做任何改变，请在writedown_image_configuration做修改
    std::string img_type_;

    final_img_queue final_imgs_;	// JPG ...
    unsigned int    usb_img_index_;
    unsigned int    final_img_index_;
    std::string     final_path_;
    BlockingQueue<std::shared_ptr<tiny_buffer>> imgs_;

    void init_settings(const char* json_setting_text);
    int on_scann_error(int err);        // 返回“0”忽略错误继续执行，其它值则停止后续工作
    int try_third_app_handle_start(bool& handled);
    int try_third_app_after_start(int err);
    std::shared_ptr<tiny_buffer> aquire_memory(int size, bool from_usb = true);

    // callback to ui ...
    int notify_ui_working_status(const char* msg, int ev = SANE_EVENT_STATUS, int status = SCANNER_ERR_OK);
    bool waiting_for_memory_enough(unsigned need_bytes);

    void copy_to_sane_image_header(SANE_Parameters* header, int w, int h, int line_bytes, int channels, int bits);
    int save_usb_data(std::shared_ptr<tiny_buffer> data);
    int save_final_image(hg_imgproc::LPIMGHEAD head, void* buf);

    enum thread_running
    {
        THREAD_RUNNING_IDLE = 0,
        THREAD_RUNNING_USB = 1 << 0,
        THREAD_RUNNING_IMAGE = 1 << 1,
    };
    int is_running(void);   // return thread_running

    ////////////////////////////////////////////////////////////////
    // 新增自定义伽玛曲线及扫描区域属性 - 2022-05-05
    bool    custom_gamma_;                  // 为true时，应用custom_gamma_val_阵列调整图像色彩；为false时，保持原来的处理方式
    SANE_Gamma *custom_gamma_val_;          // 当为RGB或者彩色时，为三组256字节的数据；当为黑白或灰度时，只有一组256字节
    bool    custom_area_;                   // 是否启用自定义区域，为true时才使用下列4个数据；为false时保持原来的处理方式
    double  custom_area_lt_x_;              // 自定义区域左上角x坐标
    double  custom_area_lt_y_;              // 自定义区域左上角y坐标
    double  custom_area_br_x_;              // 自定义区域右下角x坐标
    double  custom_area_br_y_;              // 自定义区域右下角y坐标
    SIZE    paper_size_mm_;                 // 当前纸张尺寸（mm）
    // 新增自定义伽玛曲线及扫描区域属性 - END
    ////////////////////////////////////////////////////////////////

    // 2022-07-23 新增双张之后留图继续扫描
    int     double_paper_handle_;           // 汉王要求出现双张的时候可保留
    bool    keep_watermark_;                // 汉王要求图像处理过程中保留水印 - 是否与背景移除、背景填充相关？？？

public:
    void set_ui_callback(sane_callback cb, bool enable_async_io);
    int reset_io(usb_io* io);
    int io_disconnected(void);
    int get_pid(void);
    int get_vid(void);
    int close(bool force);
	int set_setting(int setting_no, void* data, int len);
	int get_setting(int setting_no, char* json_txt_buf, int* len);

	std::string name(void);
	int status(void);
    bool is_online(void);

public:
    virtual int start(void);
    virtual int get_image_info(SANE_Parameters* ii);
    virtual int read_image_data(unsigned char* buf, int* len);
    virtual int stop(void);
    virtual int reset(void);
    virtual int device_io_control(unsigned long code, void* data, unsigned* len);

public:
	hg_scanner(ScannerSerial serial, const char* dev_name, usb_io* io);
	virtual ~hg_scanner();

    static std::string temporary_file(char* tail = NULL, char* head = NULL);
    static int save_2_tempory_file(std::shared_ptr<std::vector<char>> data, std::string* path_file, unsigned int index = 0);

public:
///////////////////////////////新增 20220425//////////////////////////
    virtual int set_leaflet_scan(void);//单张扫描
    virtual int get_abuot_info(void);//获取软件关于信息 (基类实现) 
    virtual int restore_default_setting(void);//恢复默认设置 (基类实现) 
    virtual int set_final_image_format(SANE_FinalImgFormat* fmt); // 设置图像处理最终输出（final()）的图像数据格式  (基类实现) ***
    virtual int get_compression_format(void);//获取支持的压缩格式  功能不支持

    
    virtual int clear_roller_num(void); // 清除滚轴计数
    

    virtual int set_compression_format(void);//设置图像数据最终输出的压缩格式
    virtual int set_auto_color_type(void);// 设置自动匹配颜色模式  (基类实现) ***

    virtual std::string get_firmware_version(void);
    virtual std::string get_serial_num(void);
    virtual std::string get_ip(void);

    virtual int get_device_code(void);//获取设备编码
  
   
    virtual int get_dogear_distance(void);//获取折角检测最小距离阈值
    virtual int set_dogear_distance(void);// 设置折角检测最小距离阈值
    virtual int get_scanner_paperon(SANE_Bool* paperon = NULL);//获取设备有无纸张
    virtual int set_scan_when_paper_on(void);//获取是否为检测到进纸盘上有纸即开始扫描
    virtual int get_scan_when_paper_on(void);//设置是否为检测到进纸盘上有纸即开始扫描
    virtual int get_scan_with_hole(void);// 获取是否为带孔扫描
    virtual int set_scan_with_hole(void);// 设置是否为带孔扫描

    virtual int get_scan_is_sleep(void);//获取设备是否休眠当中

    virtual int get_sleep_time(int& getsleepime);//获取功耗模式（休眠）
    virtual int set_sleep_time(int sleeptime);//设置功耗模式（休眠）
    virtual int get_history_count(void);//获取历史扫描张数 -2：设备不支持该功能；-1：与设备通信失败；其它大于等于0的为正常
    virtual int get_roller_num(void);   //获取滚轮张数 -2：设备不支持该功能；-1：与设备通信失败；其它大于等于0的为正常

    virtual int notify_sleep(void);//唤醒设备
    virtual int get_device_log(string &log);//获取设备日志

};

#ifdef UOS
    #ifdef OEM_HANWANG
    static const std::string helpfile_ ="/opt/apps/com.hanvonchina.hanvonscan/entries/help/HanvonScan_scanSettings_Help_manual.pdf";//帮助文档路径
    #elif  OEM_LISICHENG
    static const std::string helpfile_ ="/opt/apps/com.lanxumchina.lanxumscan/entries/help/LanxumScan_scanSettings_Help_manual.pdf";//帮助文档路径
    #else
    static const std::string helpfile_ ="/opt/apps/com.huagaochina.huagoscan/entries/help/HuaGoScan_scanSettings_Help_manual.pdf";//帮助文档路径
    #endif
#elif KYLIN
    #ifdef OEM_HANWANG
    static const std::string helpfile_ ="/opt/apps/scanner-driver-hanvon/doc/HanvonScan_scanSettings_Help_manual.pdf";//帮助文档路径
    #elif  OEM_LISICHENG
    static const std::string helpfile_ ="/opt/apps/scanner-driver-lanxum/doc/LanxumScan_scanSettings_Help_manual.pdf";//帮助文档路径
    #else
    static const std::string helpfile_ ="/opt/apps/scanner-driver-huagao/doc/HuaGoScan_scanSettings_Help_manual.pdf";//帮助文档路径
    #endif
#elif defined(WIN32) || defined(_WIN64)
    static const std::string helpfile_ = "docs\\help_setting.pdf";
#endif