三汇CTI 系列语音卡 SHF-4B-JM PCI 传真解码卡 程序员手册

admin管理员组

文章数量:1530844

2024年7月10日发(作者：)

三汇SHF系列解码卡

SHF-4B-JM/PCI

传真解码卡

Version 1.1

杭 州 三 汇 信 息 工 程 有 限 公 司

杭州三汇信息工程有限公司

目 录

目 录.................................................................................................................................................i

版权申明................................................................................................................................................ii

版本修订记录........................................................................................................................................iii

第一章 概 述.....................................................................................................................................1

1.1

1.2

1.3

1.4

功能描述.................................................................................................................................1

传真解码卡通道说明.............................................................................................................1

驱动程序支持的操作系统.....................................................................................................1

注意事项.................................................................................................................................1

第二章 传真解码卡API函数及通知消息..........................................................................................2

2.1 传真解码卡API函数相关信息..............................................................................................2

2.2 传真解码卡API函数..............................................................................................................2

2.2.1

传真解码卡操作函数

.....................................................................................................2

2.2.1..2

2.2.1.2

2.2.1.3

2.2.1.3

2.2.2

数据输入和解码控制函数

.............................................................................................4

2.2.2.4

2.2.2..4

2.2.2.5

2.2.2.6

2.2.2.6

2.2.2.7

2.2.2.7

2.2.2.8

2.2.2.8

2.2.3

解码输出函数

.................................................................................................................9

2.2.3.9

2.2.3..9

2.2.3.10

2.2.3..11

2.2.3.11

2.2.3.12

2.2.3..12

2.3 通知消息...............................................................................................................................13

附录A 技术/销售支持.........................................................................................................................14

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 i 页

杭州三汇信息工程有限公司

版权申明

本文档版权属杭州三汇信息工程有限公司所有。

杭州三汇信息工程有限公司保留对此文件进行修改而不另行通知

之权利。

杭州三汇信息工程有限公司承诺所提供的信息为正确且可靠, 但并

不保证本文件绝无错误。

请在使用本产品前, 自行确定所使用的相关技术文件及规格为最新

有效之版本。若因贵公司使用本公司之文件或产品, 而需要第三方之产

品、专利或者著作等与其配合时，则应由贵公司负责取得第三方同意及

授权。关于上述同意及授权，非属本公司应为保证之责任。

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 ii 页

杭州三汇信息工程有限公司

版本修订记录

版本号

Version 1.0

Version 1.1

发布日期

2004.10

2007.03

修订内容

新创建此文档

规范整理，形成此版本

请访问我们的网站（），以获取该文档的最新版本。

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 iii 页

杭州三汇信息工程有限公司

第一章 概 述

传真解码卡可以将已经录制成声音文件的传真通话过程重新解码生成传真图像，该卡可以

作为电话录音系统的配套产品使用。

1.1 功能描述

z 解码速度快，可达到约四倍速解码

z 支持图像逐行输出，方便实现动态图像更新，在解码的过程中可以察看解码结果

z 采用DSP技术，可以动态更新非标格式列表，支持新增的非标传真格式

z 接口方便，待解数据直接从PCI总线输入，无需外接线路

z 对原始数据信噪比要求低

1.2 传真解码卡通道说明

通道指板卡上一路具有传真解码能力的物理电路实体。

对于通道的编号，驱动程序的API函数使用的参数nCh均指物理编号。物理编号是指通道在

所在板卡上的编号，通道物理编号由驱动程序自动分配，并且从0开始编号。传真解码卡只有4

个物理通道，并且一个系统中最多只能使用一块传真解码卡。

1.3 驱动程序支持的操作系统

驱动程序支持WINDOWS操作系统，具体如下：

z WINDOWS系列：包括 Windows 98，Windows Me，Windows NT，Windows 2000，

Windows XP，Windows 2003。

1.4 注意事项

z 传给驱动解码的声音文件必须是在录音通道不打开自动增益开关的情况下录制的。

z 驱动目前支持的声音文件传真解码速率最大为14400bps。

z 进行解码的声音文件数据格式要求为A-Law。

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 1 页

杭州三汇信息工程有限公司

第二章 传真解码卡API函数及通知消息

2.1 传真解码卡API函数相关信息

驱动程序版本要求

FaxDecode Ver. 1.0.0.0

Header sh_FaxjmApi.h

Library sh_

DLL sh_

2.2 传真解码卡API函数

2.2.1 传真解码卡操作函数

2.2.1.1 InitJMCard

函数原型：

int InitJMCard()

参数说明：

无

返回值：

1

0

功能描述：

初始化传真解码卡。

注意事项：

相关函数：

调用成功

调用失败

2.2.1.2 ShutJMCard

函数原型：

int ShutJMCard()

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 2 页

杭州三汇信息工程有限公司

参数说明：

无

返回值：

1

0

功能描述：

注意事项：

相关函数：

调用成功

调用失败

关闭传真解码卡。

2.2.1.3 GetJMMessage

函数原型：

int GetJMMessage（LPSTR szMsgBuf）

参数说明：

szMsgBuf

返回值：

1

0

功能描述：

获取最后一次调用驱动程序接口函数的错误信息，如果最后一次调用接口函数成功，将返

回空字符串。

注意事项：

z szMsgBuf应为有效的字符串指针

相关函数：

调用成功

调用失败

错误消息缓冲区

2.2.1.4 IsIdlesse

函数原型：

int IsIdlesse(int nCh)

参数说明：

nCh

返回值：

通道号

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 3 页

杭州三汇信息工程有限公司

1

-1

0

功能描述：

指定的通道空闲

指定的通道正在忙于解码

失败

判断一个指定的通道是否空闲

。

注意事项：

相关函数：

2.2.2 数据输入和解码控制函数

2.2.2.1 SetOwnerWnd

函数原型：

int SetOwnerWnd(int nCh , HWND hWnd = NULL)

参数说明：

nCh

hWnd

返回值：

1

0

功能描述：

设置某个通道所属窗口的句柄，这样驱动程序可以向此窗口发送特定消息。如果要接收驱

动程序发给客户的消息，则在调用

StartJMWithFile(Ex)或者StartJMWithStream(Ex)之前需要调用

此函数。

注意事项：

相关函数：

成功

失败

通道编号

窗口句柄

2.2.2.2 HandleLostData

函数原型：

int HandleLostData(BOOL bHandle)

参数说明：

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 4 页

杭州三汇信息工程有限公司

bHandle

返回值：

1

0

功能描述：

是否对传真文件解调丢点进行处理

成功

失败

设置驱动是否对传真文件解调丢点进行处理。默认为不处理。

注意事项：

相关函数：

2.2.2.3 StartJMWithFile

函数原型：

int StartJMWithFile(int nCh, LPSTR szFilePath, int iType, PFN_GETBMPLINE pfnGetBmpLine,

BOOL bSaveToBmp)

参数说明：

nCh

szFilePath

通道编号

传真语音文件完整路径

解码结束方式：

0：指示驱动程序在遇到文件尾后，自动结束解码；

1：驱动程序不断检测文件是否有新增数据，直到用户调用

FinishedSendData函数指示数据已经接收完毕，适用于正在录音的

文件解码。

传真页解码行结束回调函数，用户可以通过设置此函数，实时地取得传

真页解码后的数据，实现动态显示。

传真页解码后的数据是否保存为bmp文件。

TRUE：保存为bmp文件；

FALSE：不保存为bmp文件。

文件名命名方式为原始语音文件名加页序号加扩展名bmp。

iType

pfnGetBmpLine

bSaveToBmp

函数返回：

1

0

功能描述：

指定文件名，由传真驱动程序直接读取文件，开始解码。

注意事项：

z 语音文件数据格式要求为A-Law。

相关函数：StartJMWithFileEx，StartJMWithStream，StartJMWithStreamEx

成功

启动失败

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 5 页

杭州三汇信息工程有限公司

2.2.2.4 StartJMWithFileEx

函数原型：

int WINAPI StartJMWithFileEx(int nCh, LPSTR szFilePath, int iType, PFN_GETBMPLINE

pfnGetBmpLine , LPSTR szSaveToFile)

参数说明：

nCh

通道编号

szFilePath

传真语音文件完整路径

解码结束方式。

0：指示驱动程序在遇到文件尾后，自动结束解码；

iType

1：驱动程序不断监测文件是否有新增数据，直到客户调用

FinishedSendData函数指示数据已经接收完毕，适用于正在录音的

文件解码。

传真页解码行结束回调函数，用户可以通过设置此函数，实时的取得传

pfnGetBmpLine

真页解码后的数据，实现动态显示。

创建的bmp文件名路径基名称。实际的bmp文件名为szSaveToFile加页

序号加扩展名bmp，如果此参数为NULL，解码结果将不保存为bmp图

szSaveToFile

象；否则则保存为此文件。

函数返回：

1

0

功能描述：

指定文件名，由传真驱动程序直接读取文件，开始解码。

注意事项：

z 语音文件数据格式要求为A-Law。

相关函数：StartJMWithFile，StartJMWithStream，StartJMWithStreamEx

成功

启动失败

2.2.2.5 StartJMWithStream

函数原型：

int StartJMWithStream(int nCh, PFN_GETBMPLINE pfnGetBmpLine , BOOL bSaveToBmp)

参数说明：

nCh

pfnGetBmpLine

通道编号

传真页解码行结束回调函数，用户可以通过设置此函数，实时地取得传

真页解码后的数据，实现动态显示。

TRUE：保存为bmp文件；

FALSE：不保存为bmp文件。

文件名命名方式为stream加上一个序列号加上页序号，再加上扩展名

bmp，如。

bSaveToBmp

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 6 页

杭州三汇信息工程有限公司

函数返回：

1

0

功能描述：

指示驱动程序开始接收数据流，并将数据流解码。调用此函数后，要调用

SendStream函数

发送数据流到驱动程序进行解码，并调用

FinishedSendData函数指示发送数据完毕。

注意事项：

z 语音文件数据格式要求为A-Law。

相关函数：StartJMWithFile，StartJMWithFileEx，StartJMWithStreamEx

成功

启动失败

2.2.2.6 StartJMWithStreamEx

函数原型：

int StartJMWithStreamEx(int nCh, PFN_GETBMPLINE pfnGetBmpLine , LPSTR szSaveToFile)

参数说明：

nCh

pfnGetBmpLine

szSaveToFile

函数返回：

1

0

功能描述：

指示驱动程序开始接收数据流，并将数据流解码。调用此函数后，要调用

SendStream函数

发送数据流到驱动程序进行解码，并调用

FinishedSendData函数指示发送数据流完毕。

注意事项：

z 语音文件数据格式要求为A-Law。

相关函数：StartJMWithFile，StartJMWithFileEx，StartJMWithStream

成功

启动失败

通道编号

传真页解码行结束回调函数，用户可以通过设置此函数，实时取得传真

页解码后的数据，实现动态显示。

创建的bmp文件名路径基名称。实际的bmp文件名为szSaveToFile加页

序号加扩展名bmp。如果此参数为NULL，解码结果将不保存为bmp图

象。

2.2.2.7 SendStream

函数原型：

int SendStream(int nCh,LPSTR szBuf,int cbSize)

参数说明：

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 7 页

杭州三汇信息工程有限公司

nCh

szBuf

cbSize

返回值：

〉=0

-1

功能描述：

通道编号

发送到解码卡的数据块首指针

发送到解码卡的数据块大小

实际写入的大小

失败

发送数据块到解码卡。在调用SendStream函数前，若StartJMWithStream(Ex)没有被调用则调

用失败。

注意事项：

相关函数：StartJMWithStream，StartJMWithStreamEx

2.2.2.8 FinishedSendData

函数原型：

int FinishedSendData（int nCh）

参数说明：

nCh

返回值：

1

0

功能描述：

结束本通道的数据传送。当用户调用

StartJMWithStream(Ex)函数解码时，或者当用户调用

StartJMWithFile(Ex)函数并且指定了参数iType等于1的方式解码时，调用此函数结束数据的传

送。

注意事项：

相关函数：StartJMWithStream，StartJMWithStreamEx，StartJMWithFile，StartJMWithFileEx

成功

失败

通道编号

2.2.2.9 CloseJM

函数原型：

int CloseJM（int nCh）

参数说明：

nCh

返回值：

通道编号

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 8 页

杭州三汇信息工程有限公司

1

0

功能描述：

成功

失败

结束指定通道的解码。

注意事项：

相关函数：

StartJMWithStream，StartJMWithStreamEx，StartJMWithFile，StartJMWithFileEx

2.2.3 解码输出函数

2.2.3.1 GetBmpStyle

函数原型：

int GetBmpStyle(int nCh, int nPageNum, int *nWidth, int *nHeight)

参数说明：

nCh

nPageNum

nWidth

nHeight

返回值：

1

0

功能描述：

获得传真页面图像格式。

注意事项：

相关函数：

成功

失败

通道编号

页码

纸宽

总行数，在解码过程中，实时调用时的返回值不一定精确

2.2.3.2 GetFileInfo

函数原型：

int GetFileInfo(int nCh , int* pDeModemMode , int* pDecodeStyle , int* pPaperWidth , int*

pBmpHeight , LPSTR szCISTelNo , LPSTR szTSITelNo , BOOL* pEcmCode)

参数说明：

nCh

pDeModemMode

通道编号

解调模式

0x09： 2400bps V.27

0x0a：4800bps V.27

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 9 页

杭州三汇信息工程有限公司

pDecodeStyle

pPaperWidth

pBmpHeight

szCISTelNo

szTSITelNo

pEcmCode

返回值：

1

0

功能描述：

0x14：9600bps V.29

0x12：7200bps V.29

0x31：14400bps V.33

0x32：12000bps V.33

0x31：14400bps V.17

0x32：12000bps V.17

0x34：9600bps V.17

0x38：7200bps V.17

0x78：V34

解码方式

0：MH

1：MR

2：MMR

0xFF：未知

纸宽

解出来的传真图像总高度

被叫用户号码

主叫用户号码

是否有纠错模式

成功

失败

当这个通道解码结束时，通过此函数获取呼叫接续信息。

注意事项：

相关函数：

2.2.3.3 GetJMState

函数原型：

int GetJMState(int nCh)

参数说明：

nCh

返回值：

0

1

2

-1

功能描述：

获取指定通道的状态信息。

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 10 页

正在解码

解码结束，有图形输出

解码结束，没有图形输出

出错退出

通道编号

杭州三汇信息工程有限公司

注意事项：

z 在返回2后，再次调用本函数，会返回1，这是为了兼容早期版本的驱动。在实际应用

中，本函数只要返回1或者2，就表示解码结束，不必再次调用本函数。

相关函数：

2.2.3.4 GetJMStateEx

函数原型：

int GetJMStateEx(int nCh , LPSTR szJMState)

参数说明：

nCh

szJMState

返回值：

1

0

功能描述：

获取指定通道的状态信息。

注意事项：

相关函数：

成功

失败

通道编号

状态信息缓冲区

2.2.3.5 GetFinishedPercent

函数原型：

int GetFinishedPercent(int nCh , int* pPercent)

参数说明：

nCh

pPercent

返回值：

1

0

功能描述：

获取指定通道的解码完成情况。

注意事项：

相关函数：

成功

失败

通道编号

完成百分比

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 11 页

杭州三汇信息工程有限公司

2.2.3.6 GetBmp

函数原型：

int GetBmp(int nCh, LPSTR szBmpBuf, int *pCBRead , int *pCurPage)

参数说明：

nCh

szBmpBuf

pCBRead

pCurPage

返回值：

>0

=0

-2

功能描述：

获取一个传真页面。

注意事项：

z 当*pCurPage为-1时，函数返回总页数。

相关函数：

总页数

失败

内存不足

通道号

存放bmp图像数据的缓冲

输入时，为szBmpBuf缓冲区的长度；输出时，为读取到的szBmpBuf缓

冲区数据的长度

当前页码

2.2.3.7 DrawBmp

函数原型：

BOOL DrawBmp(int nCh, HDC hDC, int nX, int nY)

参数说明：

nCh

hDC

nX

nY

返回值：

1

0

功能描述：

在指定的hDC上画解码输出的bmp图象。

注意事项：

成功

失败

通道号

设备上下文

起始点X坐标

起始点Y坐标

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 12 页

杭州三汇信息工程有限公司

相关函数：

2.3 通知消息

WM_FINISHEDPERCENT

解码完成百分比通知信息，通过响应此消息可以获取指定通道的解码完成情况。

消息的两个参数：

WPARAM

通道号

LPARAM

完成百分比

WM_JMSTATE

解码过程中的状态消息，通过响应此消息可以获取解码过程中的一些状态信息。

消息的两个参数：

WPARAM

通道号

PARAM

解码过程中的信息

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 13 页

杭州三汇信息工程有限公司

附录A 技术/销售支持

您在使用我们的产品的过程中，有任何疑问都可以与我们联系，我

们将尽心尽力提供服务。

公司联系方法：

杭州三汇信息工程有限公司

http：//

地址：杭州文二路385号汽轮大厦12楼

邮编：310012

电话：*************（总机）

传真：*************

技术支持：

电话：*************，*************

手机：（0）133****1675

Email：

*******************

销售部：

电话：*************（总机）-2045、2046

手机：（0）133****2676

Email：

*****************

SHF

系列

SHF-4B-JM/PCI

程序员手册（

Version 1.1

）

第 14 页

本文标签： 解码函数传真文件数据