中維JVS-C900卡系統(tǒng)SDK手冊(cè)

中維JVS-C900系列壓縮卡系統(tǒng)SDK文檔版本：4.0濟(jì)南中維世紀(jì)科技2023年11月創(chuàng)立2023年02月26日修訂“://jovetech/“://jovetech目 錄一、前言二、升級(jí)說明三、SDK概述四、SDK函數(shù)詳述一、前言中維公司在板卡市場(chǎng)上目前主要包括面對(duì)低端的JVS-C600低端的JVS-C800系列以及面對(duì)中高端和二次開發(fā)的JVS-C900系列。中維JVS-C900卡是中維公司自主研發(fā)的安防監(jiān)控行業(yè)專用的音視頻壓縮卡，視頻預(yù)覽承受DirectDraw技術(shù)，視頻壓縮參考H.264標(biāo)準(zhǔn)。中維JVS-C900卡承受PCI-E接口，最大支持32路全實(shí)時(shí)的D1預(yù)覽與D1壓縮，支持本地D1錄像和網(wǎng)絡(luò)CIF傳輸?shù)碾p碼流架構(gòu)，具有兼容性好、穩(wěn)定性強(qiáng)、預(yù)覽效果清楚、壓縮質(zhì)量高、占用資源少的特點(diǎn)。驅(qū)動(dòng)程序支持Windows2023/XP/VISTA操作系統(tǒng)。/音視頻編解碼/網(wǎng)絡(luò)傳輸?shù)燃夹g(shù)均為中維公司獨(dú)立自主研發(fā)，版權(quán)全部，任何侵權(quán)行為必將受到嚴(yán)峻懲罰。中維壓縮卡SDK主要用于上層應(yīng)用軟件對(duì)壓縮卡的二次開發(fā)，分系統(tǒng)本SDK沒有內(nèi)置網(wǎng)絡(luò)SDK，有關(guān)網(wǎng)絡(luò)傳輸局部的實(shí)現(xiàn)請(qǐng)參見系統(tǒng)SDK和播放SDK的DEMO演示或網(wǎng)絡(luò)SDK文檔。更多信息請(qǐng)?jiān)L問公司網(wǎng)站：“://jovetech/“jovetech二、升級(jí)說明參見隨帶的“系統(tǒng)SDK升級(jí)說明.txt“文件。三、SDK概述中維壓縮卡SDK分系統(tǒng)SDK和播放SDK，本文檔僅針對(duì)系統(tǒng)SDK。中維壓縮卡系統(tǒng)SDK主要用于捕獲壓縮卡采集到的數(shù)據(jù)并進(jìn)展預(yù)覽或壓縮，包括卡的初始化、預(yù)覽、壓縮、參數(shù)設(shè)置等功能。本系統(tǒng)SDK〔版本V4.0〕主要特征包括：1、最大支持32路同時(shí)預(yù)覽和壓縮。2、預(yù)覽區(qū)分率和壓縮區(qū)分率最高可達(dá)704x576(4CIF)。3、兼容絕大多數(shù)主板、CPU、顯卡。4、視頻預(yù)覽承受DirectDraw，視頻壓縮核心符合H.264BaselineProfile標(biāo)準(zhǔn)。5、支持雙碼流壓縮。中維系統(tǒng)SDK的函數(shù)均以JVS_開頭。中維壓縮卡系統(tǒng)SDK中用于實(shí)現(xiàn)預(yù)覽的最簡潔調(diào)用為：初始化SDK：初始化預(yù)覽資源：翻開通道：設(shè)置視頻捕獲模式：翻開視頻預(yù)覽：關(guān)閉預(yù)覽：釋放預(yù)覽資源：釋放SDK：

JVS_InitSDKJVS_InitPreviewJVS_OpenChannelJVS_SetVideoPixelModeJVS_SetVideoPreviewJVS_SetVideoPreviewJVS_CloseChannelJVS_ReleasePreviewJVS_ReleaseSDK關(guān)于系統(tǒng)SDKJVSDKDEMO文件夾中的源代碼或者參見Simple文件夾中的源代碼。四、SDK函數(shù)詳述、翻開與關(guān)閉初始化SDK資源int JVS_InitSDK;輸入?yún)?shù)：無返回值：0。說明：第一個(gè)被調(diào)用的SDKSDK內(nèi)部參數(shù)和資源。釋放SDK資源void JVS_ReleaseSDK;輸入?yún)?shù)：無返回值：無說明：最終一個(gè)被調(diào)用的SDK函數(shù)，該函數(shù)主要用來釋放SDK資源。設(shè)置回調(diào)函數(shù)void JVS_SetCallBack (CALLBACK_ENC_DATA cbEncData,CALLBACK_RAW_DATAcbRawData);輸入?yún)?shù)：cbEncData：處理壓縮數(shù)據(jù)的回調(diào)函數(shù)地址。NULL。返回值：無說明：當(dāng)SDK壓縮出一幀數(shù)據(jù)后，SDK內(nèi)部將調(diào)用用戶編寫的cbEncData壓縮回調(diào)函數(shù)做進(jìn)一步處理。假設(shè)用戶需要處理原始視頻數(shù)據(jù)，則需要編寫cbRawData函數(shù)，如不需要處理則置cbRawData為NULL。由于回調(diào)函數(shù)是在SDK內(nèi)調(diào)用，所以應(yīng)用程序必需留神編寫此回調(diào)函數(shù)，回調(diào)函數(shù)盡量寫的簡潔高效。壓縮回調(diào)函數(shù)一般用于對(duì)壓縮出的數(shù)據(jù)進(jìn)展硬盤存儲(chǔ)和網(wǎng)絡(luò)發(fā)送?；卣{(diào)函數(shù)的編寫請(qǐng)參見demo。格式的原始數(shù)據(jù)的緩沖區(qū)首地址，而視頻圖像的寬度和高度可通過JVS_GetBitmapSize〔目前cbRawData中處理的視頻圖像僅支持352x288和320x240兩種區(qū)分率〕翻開通道BOOL JVS_OpenChannel(intnChannel);輸入?yún)?shù)：nChannel：被翻開的通道號(hào)，第一通道為0，依次類推。返回值：說明：只有翻開了某通道后才可以進(jìn)一步對(duì)該通道進(jìn)展進(jìn)一步操作。留意：當(dāng)該通道設(shè)備已被別的應(yīng)用程序占用時(shí)將導(dǎo)致翻開失敗。4.1.5關(guān)閉通道void JVS_CloseChannel(intnChannel);輸入?yún)?shù)：nChannel：通道號(hào)。返回值：無說明：無注冊(cè)通知大事void JVS_RegisterNotify(HWNDhWnd,DWORDdwNotifyMsg);輸入?yún)?shù)：hWnd：通知大事的接收窗口dwNotifyMsg：通知大事ID返回值：無說明：向SDKSDK需要向應(yīng)用程序發(fā)出通知時(shí)，就會(huì)通過PostMessage將dwNotifyMsg大事發(fā)往hWnd窗口，hWnd窗口收為子消息類型。關(guān)于子消息類型請(qǐng)參見JVSDK.h使用JVS_GetBitmap進(jìn)展抓圖則可以不調(diào)用本函數(shù)。設(shè)置視頻區(qū)分率模式voidJVS_SetVideoPixelMode(intnChannel,DWORDdwPixelMode,DWORDdwVideoFormat);輸入?yún)?shù)：nChannel：通道號(hào)dwPixelMode：區(qū)分率模式，0表示CIF模式，1表示D1模式。dwVideoFormat：視頻制式，0表示PAL制式，1表示NTSC制式。返回值：無說明：當(dāng)區(qū)分率模式承受D1模式時(shí)，通過使用JVS_EnableSubStream可以實(shí)現(xiàn)本地D1壓縮，網(wǎng)絡(luò)CIF壓縮。JVS_EnableSubStream應(yīng)當(dāng)在本函數(shù)之后被調(diào)用。本函數(shù)建議在翻開通道后第一個(gè)被調(diào)用。了預(yù)覽和壓縮后進(jìn)展。開啟捕獲VoidJVS_StartCapture(intnChannel);輸入?yún)?shù)：nChannel：通道號(hào)返回值：無說明：SDK會(huì)自動(dòng)開啟視頻數(shù)據(jù)的捕獲，但假設(shè)用戶僅需要進(jìn)展原始數(shù)據(jù)的捕獲而不需要進(jìn)展視頻預(yù)覽和壓縮，則需要單獨(dú)調(diào)用本函數(shù)來開啟視頻數(shù)據(jù)的捕獲。目前暫不支持原始音頻數(shù)據(jù)的捕獲。據(jù)的捕獲。預(yù)覽初始化視頻預(yù)覽BOOL JVS_InitPreview;輸入?yún)?shù)：無返回值：說明：初始化預(yù)覽，本SDK默認(rèn)承受DirectDraw技術(shù)進(jìn)展畫面預(yù)覽。此函數(shù)主要是對(duì)DirectDraw進(jìn)展初始化。JVS_ReleasePreview釋放被占用的資源。只有成功調(diào)用了本函數(shù)后才可以調(diào)用JVS_SetVideoPreview對(duì)相關(guān)畫面進(jìn)展預(yù)覽顯示。該函數(shù)應(yīng)在翻開通道之前調(diào)用。翻開/關(guān)閉預(yù)覽void JVS_SetVideoPreview(int nChannel, HWND hWnd, rtWindow,BOOLbPreview);輸入?yún)?shù)：nChannel：通道號(hào)。hWnd：窗口句柄。rtWindow：顯示窗口矩形。bPreview：開啟/關(guān)閉預(yù)覽。返回值：無說明：本SDK承受DirectDraw預(yù)覽，不占用CPU資源。參數(shù)rtWindow是相對(duì)于屏幕的矩形區(qū)域。翻開/關(guān)閉音頻監(jiān)聽BOOLJVS_SetAudioPreview(int nChannel, HWND hWnd, bPreview);輸入?yún)?shù)：nChannel：通道號(hào)hWnd：窗口句柄bPreview：是否翻開音頻監(jiān)聽返回值：說明：假設(shè)沒有音頻則該函數(shù)返回FALSE。釋放預(yù)覽資源void JVS_ReleasePreview;輸入?yún)?shù)：無返回值：無說明：假設(shè)初始化預(yù)覽成功，則應(yīng)用程序完畢時(shí)應(yīng)當(dāng)調(diào)用此函數(shù)釋放預(yù)覽資源。獵取圖像大小BOOL JVS_GetBitmapSize(intnChannel,DWORD*dwWidth,DWORD*dwHeight);輸入?yún)?shù)：nChannel：通道號(hào)dwWidth：指向DWORD變量的地址，SDK會(huì)將圖像寬度存放在此地址中。dwHeight：指向DWORD變量的地址，SDK會(huì)將圖像高度存放在此地址中。返回值：TRUE，失敗返回FALSE。說明：協(xié)作抓圖函數(shù)使用。抓圖BOOL JVS_GetBitmap(intnChannel,PUCHARpBuffer);輸入?yún)?shù)：nChannel：通道號(hào)返回值：說明：抓取當(dāng)前圖片。抓圖之前應(yīng)調(diào)用JVS_GetBitmapSize來得到圖像的寬度和高度，從而可以安排足夠的內(nèi)存來容納位圖數(shù)據(jù)，內(nèi)存緩沖的大小為dwWidth*dwHeight*4。當(dāng)應(yīng)用程序調(diào)用此函數(shù)后，SDK會(huì)馬上抓取圖片至pBuffer，然后通知應(yīng)用程序。因此，應(yīng)用程序應(yīng)當(dāng)在調(diào)用此函數(shù)之前注冊(cè)通知大事(JVS_RegisterNotify)，并在應(yīng)用程序中編寫處理函數(shù)。具體請(qǐng)參見DEMO演示。抓圖至文件BOOLJVS_GetBitmapToFile(intnChannel,PUCAHRpCapBmpFile,BOOLbWaitForCap);輸入?yún)?shù)：nChannel：通道號(hào)pCapBmpFile：要保存的抓圖文件名bWaitForCap：是否等待抓圖完成返回值：成功返回TRUE，失敗返回FALSE。導(dǎo)致失敗的緣由可能是資源缺乏或抓圖時(shí)特別。說明：本函數(shù)供給了區(qū)分于JVS_GetBitmap的圖片直接保存為32位的BMP文件。壓縮初始化壓縮資源BOOLJVS_InitCompress;返回值：TRUE，失敗返回FALSE。說明：該函數(shù)應(yīng)在翻開通道之前調(diào)用。當(dāng)不再使用壓縮資源后應(yīng)調(diào)用JVS_ReleaseCompress來釋放資源。釋放壓縮資源voidJVS_ReleaseCompress返回值：無說明：當(dāng)不再使用壓縮資源時(shí)調(diào)用本函數(shù)來釋放壓縮資源。設(shè)定視頻壓縮模式void JVS_SetQualityMode(intnChannel,DWORDdwQualityMode,DWORDdwMBPH,DWORDdwAlgorithm);輸入?yún)?shù)：nChannel：通道號(hào)。dwQualityMode：視頻壓縮模式，取值0-2，默認(rèn)1。dwMBPH：設(shè)定的每小時(shí)的碼流大小。單位為MB。算法最簡單，速度最慢，質(zhì)量最好。默認(rèn)值為1說明：當(dāng)dwQualityMode=0時(shí)表示互聯(lián)網(wǎng)模式，這種模式具有占用資源少、壓縮速度快、生成數(shù)據(jù)小的特點(diǎn)，當(dāng)計(jì)算機(jī)性能較差或者需要互聯(lián)網(wǎng)傳輸時(shí)建議承受此模式。在區(qū)分率模式為CIF時(shí)建議dwMBPH為50MBPH。當(dāng)dwQualityMode=1時(shí)表示標(biāo)準(zhǔn)模式，這種模式為標(biāo)準(zhǔn)的全實(shí)時(shí)壓縮模式，適用于一般監(jiān)控，在區(qū)分率模式為CIF時(shí)建議dwMBPH設(shè)為120MBPH。當(dāng)dwQualityMode=2時(shí)表示優(yōu)質(zhì)模式，使用該模式后，在其他條件一樣CIF時(shí)建議dwMBPH設(shè)為120MBPH。該模式更適合于本地錄像。假設(shè)計(jì)算機(jī)的性能強(qiáng)勁，建議將dwAlgorithm設(shè)置為3，該等級(jí)的算法壓縮出的碼流最小、質(zhì)量最好。只有當(dāng)計(jì)算機(jī)性能較差時(shí)才建議將算法簡單度設(shè)置為0，該等級(jí)的壓縮速度是3級(jí)的2倍以上。3級(jí)算法簡單度可以壓縮出0級(jí)算法則占用的CPU資源最少。設(shè)定關(guān)鍵幀周期void JVS_SetKeyFramePeriod ( int nChannel, DWORDdwKeyFramePeriod);輸入?yún)?shù)：nChannel：通道號(hào)。默認(rèn)100。說明：關(guān)鍵幀〔I幀〕是指可以用來馬上解碼的幀。開頭壓縮void JVS_StartCompress(intnChannel);輸入?yún)?shù)：nChannel：通道句柄。返回值：無說明：開頭壓縮。在壓縮之前，必需編寫壓縮回調(diào)函數(shù)并注冊(cè)，具體參見出的數(shù)據(jù)。停頓壓縮void JVS_StopCompress(intnChannel,BOOLbWaitForStop);輸入?yún)?shù)：nChannel：通道號(hào)。bWaitForStop：是否壓縮完畢后返回返回值：無說明：為真時(shí)，本函數(shù)調(diào)用后將處于等待狀態(tài)直到壓縮線程完全完畢后才返回。為假時(shí)則馬上返回。插入一個(gè)關(guān)鍵幀void JVS_InsertKeyFrame(intnChannel);輸入?yún)?shù)：nChannel：通道號(hào)返回值：無說明：關(guān)鍵幀開頭，所以，在開頭寫文件或網(wǎng)絡(luò)傳送時(shí)馬上插入一個(gè)關(guān)鍵幀可以有效削減延遲解碼的發(fā)生。啟用/關(guān)閉音頻壓縮BOOLJVS_SetAudioCompress(intnChannel,BOOLbCompress);輸入?yún)?shù)：nChannel：通道號(hào)bCompress：是否壓縮音頻返回值：說明：啟或關(guān)閉而無需重啟視頻壓縮。4.3.12獵取本地壓縮的頭數(shù)據(jù)BOOLJVS_GetHeaderData(int nChannel, PJVS_FILE_HEADERpheaderData);輸入?yún)?shù)：nChannel：通道號(hào)pheaderData：指向JVS_FILE_HEADER構(gòu)造的指針。返回值：TRUE，失敗返回FALSE。說明：文件后應(yīng)當(dāng)首先寫入此頭數(shù)據(jù)。4.3.12獵取網(wǎng)絡(luò)壓縮的頭數(shù)據(jù)BOOLJVS_GetHeaderData2(int nChannel, PJVS_FILE_HEADERpheaderData);輸入?yún)?shù)：nChannel：通道號(hào)pheaderData：指向JVS_FILE_HEADER構(gòu)造的指針。返回值：TRUE，失敗返回FALSE。說明：則應(yīng)當(dāng)發(fā)送本函數(shù)取得的壓縮頭數(shù)據(jù)。當(dāng)沒有啟用子碼流時(shí)，網(wǎng)絡(luò)碼流的頭數(shù)據(jù)等同于本地碼流，即JVS_GetHeaderData2與JVS_GetHeaderData得到的參數(shù)一樣。視頻開啟/關(guān)閉OSD功能void JVS_SetOSD(intnChannel,DWORDdwOsdMode,PCHARpText,BOOLbEnable);輸入?yún)?shù)：nChannel：通道句柄dwOsdMode：OSD模式，0表示在左上角顯示，1表示在左下角顯示。pText：OSD文本，最大16字節(jié)。bEnable：開啟/關(guān)閉OSD返回值：說明：OSDOnScreenDisplay，用來實(shí)現(xiàn)在視頻畫面上疊加時(shí)間和文字。pText為NULL時(shí)不疊加文字。設(shè)置視頻顏色參數(shù)void JVS_SetVideoPara(intnChannel,intnBrightness,intnContrast,intnSatuation,intnHue);輸入?yún)?shù)：nChannel：通道號(hào)nBrightness：亮度，取值0到255，默認(rèn)值：128nContrast:比照度，取值0到255，默認(rèn)值：1280到255，默認(rèn)值：128nHue：色度，取值0到255，默認(rèn)值：128返回值：無說明：無4.4.5設(shè)置視頻去黑邊VoidJVS_SetVideoCrop(intnChannel,DWORDdwPixelCroped);輸入?yún)?shù)：nChannel：通道號(hào)dwPixelCroped：作為黑邊去除的像素?cái)?shù)。返回值：無說明：由于某些攝像機(jī)輸出的視頻可能存在黑邊現(xiàn)象，通過本函數(shù)可以去除該黑邊。dwPixelCroped=0表示不去除黑邊，其他值為要去除黑邊的像素?cái)?shù)，一般為8或者12。設(shè)置是否啟用D1預(yù)覽voidJVS_EnablePreviewD1(intnChannel,BOOLbEnableD1);輸入?yún)?shù)：nChannel：通道號(hào)bEnableD1：是否啟用D1預(yù)覽，TRUE表示啟用。返回值：無說明：該函數(shù)僅在視頻區(qū)分率模式為CIF模式時(shí)有效，即本地錄像區(qū)分率為CIF時(shí)可以選擇是否啟用D1預(yù)覽，啟用了D1預(yù)覽后，在畫面放大時(shí)預(yù)覽圖像會(huì)更清楚。對(duì)于PCI-E接口的采集卡，由于本身不存在帶寬問題建議始終開啟D1預(yù)覽。設(shè)置是否啟用子碼流voidJVS_EnableSubStream(intnChannel,BOOLbEnableSubStream);輸入?yún)?shù)：nChannel：通道號(hào)bEnableSubStream：是否啟用D1預(yù)覽，TRUE表示啟用。返回值：無啟用子碼流，子碼流的區(qū)分率為CIF，即D1的四分之一，從而可以實(shí)現(xiàn)本地D1碼流，網(wǎng)絡(luò)CIF碼流。運(yùn)動(dòng)檢測(cè)啟停運(yùn)動(dòng)檢測(cè)功能void JVS_SetMovDetect(intnChannel,intnScenecutGrade,intnScenecutThreshold,intnScenecutCoeff,intnRectNumber,RECT*pScenecutRect);輸入?yún)?shù)：nChannel：通道號(hào)nScenecutGrade：檢測(cè)靈敏度等級(jí)，取值0-100，0表示不檢測(cè)。nScenecutThreshold：檢測(cè)靈敏度閾值，取值0-100nScenecutCoeff：靈敏度系數(shù)，取值1-100nRectNumber：移動(dòng)偵測(cè)區(qū)域的個(gè)數(shù)。pScenecutRect：指向移動(dòng)偵測(cè)區(qū)域數(shù)組的指針。返回值：無說明：nScenecutGrade=0時(shí)不啟用運(yùn)動(dòng)檢測(cè)，>0時(shí)表示啟用并代表了檢測(cè)靈敏度等級(jí)。值為1時(shí)最靈敏，值為100時(shí)最不靈敏。檢測(cè)靈敏度閾值是運(yùn)動(dòng)猛烈度上限，該值越大靈敏度20-50靈敏度，值越小越靈敏。綜合來說，當(dāng)進(jìn)展移動(dòng)偵測(cè)時(shí)，靈敏度等級(jí)、靈敏度閾值以及靈敏度系SDK覺察靈敏度符合設(shè)置要求時(shí)就會(huì)在應(yīng)用程序設(shè)置的回調(diào)函數(shù)GetDataCallBack中將bMov置為TRUE通知應(yīng)用程序檢測(cè)到運(yùn)動(dòng)了。pScenecutRect是一個(gè)指向具有nRectNumber個(gè)檢測(cè)區(qū)域數(shù)組的指針。在nScenecutGrad