Adlink PCIe-2602 Manuel d'utilisateur

Advance Technologies; Automate the World.Manual Rev.: 2.00Revision Date: Nov. 13, 2013Part No: 50-11252-1000PCIe-26023G-SDI Audio/Video Capture Car

xList of TablesThis page intentionally left blank.

Introduction 1PCIe-2602-FLR1 Introduction1.1 OverviewThe PCIe-2602 3G-SDI Audio/Video Capture Card, based on thePCI Express® x4 interface, enables ac

2Introductiona wide variety of applications, including medical imaging and intel-ligent video surveillance or analytics.

Function Library 3PCIe-2602-FLR2 Function LibraryThis describes details of the API (Application Programming Inter-face) for the PCIe-2602, developing

4 Function Library2.2 List of FunctionsCategory FunctionDevice Control Device CountDevice OpenDevice CloseDevice Vendor NameDevice Model NameDevice Ve

Function Library 5PCIe-2602-FLRTable 2-1: API FunctionsAcquisition Control Acquisition Frame CountAcquisition StartAcquisition StopOne ShotImage Str

6 Function Library2.3 Setting Up the Build Environment2.3.1 Include FilesAll applications using API are required to include the followingfiles.2.3.2 L

Function Library 7PCIe-2602-FLR2.4 API Functions2.4.1 Device Control FunctionsDevice CountReturns the total number of supported devices in the sys-te

8 Function LibraryDeviceOpen (ByVal Number As UInteger) As Inte-gerParameter(s)NumberThe number of SDI channels to be opened, with allowedvalue from 0

Function Library 9PCIe-2602-FLRSyntaxC/C++int Sdi_GetDeviceVendorName (char *Name)C#string GetDeviceVendorName ()VB.NetGetDeviceVendorName () As Stri

iiRevision HistoryRevision Release Date Description of Change(s)2.00 Nov. 13, 2013 Initial release

10 Function LibraryGetDeviceModelName (ByVal Number as UInteger)As StringParameter(s)NumberThe number of the SDI channel, with allowed values from 0to

Function Library 11PCIe-2602-FLRParameter(s)NumberThe number of the SDI channel, with allowed values from 0to 31.VersionPoints to a user-allocated bu

12 Function LibraryVersionPoints to a user-allocated buffer into which the versionstring is entered in “Year/Month/Day Hour:Minute” format. Theversion

Function Library 13PCIe-2602-FLRPoints to a user-allocated buffer into which the versionstring is entered in a “n.n.n.n” format. The version is NULL-

14 Function LibraryReturn ValueC/C++No error occurs if return value >= 0; if negative, refer toOther Functions for return code error information.C#

Function Library 15PCIe-2602-FLRReturn ValueNo error occurs if return value ≥ 0; if a negative value,please refer to Other Functions for return code

16 Function Library2.4.2 Image Format FunctionsSensor FormatSets or retrieves image format of source input, with formatdiffering according to the inpu

Function Library 17PCIe-2602-FLR6: 720p 59.94/60 fps (1280 x 720 progressive),7: 1080i 25 fps (1920 x 1080 interlace, in fps),8: 1080i 29.97/30 fps (

18 Function LibraryParameter(s)NumberThe number of the SDI channel, with allowed values from 0to 31.WidthThe image width of source input.Return ValueN

Function Library 19PCIe-2602-FLRReturn ValueNo error occurs if return value ≥ 0; if a negative value,please refer to Other Functions for return code

Preface iiiPCIe-2602-FLRPrefaceCopyright 2013 ADLINK Technology, Inc.This document contains proprietary information protected by copy-right. All righ

20 Function LibraryFormatPixel output format, one of (wherein x denotes neutral bit):0: 16bit YCbCr 4:2:2 (YUY2) – 8bit Y + 8bit Cb/Cr1: 24bit YCbCr 4

Function Library 21PCIe-2602-FLR4: 30bit YCbCr 4:4:4 – 10bit Y + 10bit Cb + 10bit Cr5: 30bit RGB (BGR30) – 8bit R + 8bit G + 8bit B6: 24bit YCbCr 4:2

22 Function Library7: 36bit YCbCr 4:4:4 – 12bit Y + 12bit Cb + 12bit Cr8: 36bit RGB – 12bit R + 12bit G + 12bit BDWORDPixel Data [31:0][31:24] [23:16]

Function Library 23PCIe-2602-FLRReturn ValueNo error occurs if return value ≥ 0; if a negative value,please refer to Other Functions for return code

24 Function LibraryParameter(s)NumberThe number of the SDI channel, with allowed values from 0to 31.SDI_RESOLUTION_CAPABILITIESA structure of resoluti

Function Library 25PCIe-2602-FLR public uint Width; public uint Height; public uint FrameRate; public uint Interlace;}struct RESOLUTION_C

26 Function LibraryReturn ValueNo error occurs if return value ≥ 0; if a negative value,please refer to Other Functions for return code error informa-

Function Library 27PCIe-2602-FLRDetected Output FormatAcquires the output format of the currently selected videochannel, reading back color space fro

28 Function LibraryImage OrientationSets or retrieves orientation of images in memory.SyntaxC/C++int Sdi_SetImageOrientation (UINT Number, UINTValue)i

Function Library 29PCIe-2602-FLRValueIndicates the image orientation, as one of:0: Bottom-up, in which the image buffer starts with the bot-tom row o

iv PrefaceConventionsTake note of the following conventions used throughout thismanual to make sure that users perform certain tasks andinstructions p

30 Function Library1: Top-down, in which order of the rows is reversed, with thetop row the first row in memory, followed by the next row down,with th

Function Library 31PCIe-2602-FLRSyntaxC/C++int Sdi_SetEventSelector (UINT Number, UINTMode)int Sdi_GetEventSelector (UINT Number, UINT &Mode)C#in

32 Function LibraryEvent HandleSets or retrieves event handle, with event and callbackdetermining recovery of video frame or audio information.SyntaxC

Function Library 33PCIe-2602-FLRGetImageStream to acquire the pointer of frame buffer GetAudioStream to acquire audio data pointer and size.Return Va

34 Function Library2: Audio data callbackReturn ValueNo error occurs if return value ≥ 0; if a negative value, please referto Other Functions for retu

Function Library 35PCIe-2602-FLRFunPointer for callback routine, in which a callback functionmust be declared and set as the parameter. In the callba

36 Function LibraryGetAcquisitionFrameCount (ByVal Number as UIn-teger, ByRef Count as UInteger) As IntegerParameter(s)NumberThe number of the SDI cha

Function Library 37PCIe-2602-FLRThe number of the SDI channel, with allowed values from 0to 31.Return ValueNo error occurs if return value ≥ 0; if a

38 Function LibraryC#int OneShot (uint Number, uint Timeout)VB.NetOneShot (ByVal Number as UInteger, ByVal Time-out as UInteger) As IntegerParameter(s

Function Library 39PCIe-2602-FLRThe number of the SDI channel, with allowed values from 0to 31.BufferImage buffer pointer.Return ValueNo error occurs

vPCIe-2602-FLRTable of ContentsRevision History... iiPreface...

40 Function LibraryAcquisition StatisticsAcquires the number of frames captured since AcquisitionStart.SyntaxC/C++int Sdi_GetAcquisitionStatistics (UI

Function Library 41PCIe-2602-FLRint GetSensorStatus (uint Number, out uintLocked)VB.NetGetSensorStatus (ByVal Number as UInteger,ByRef Locked as UInt

42 Function LibrarySaveImage (ByVal Number as UInteger, ByValFileNamet as String) As IntegerParameter(s)NumberThe number of the SDI channel, with allo

Function Library 43PCIe-2602-FLRParameter(s)NumberThe number of the SDI channel, with allowed values from 0to 31.StreamInfoStructure of audio data an

44 Function LibraryDropped Frame CountAcquires the total number of frames dropped since Acquisi-tion Start, as a result of:Z The buffer queue is full

Function Library 45PCIe-2602-FLROverflow Frame CountAcquires the number of frames dropped since AcquisitionStart, resulting from:Z Full buffer queue

46 Function LibrarySyntaxC/C++int Sdi_GetMismatchFrameCount (UINT Number,UINT &Count)C#int GetMismatchFrameCount (uint Number, outuint Count)VB.Ne

Function Library 47PCIe-2602-FLRint SetDigitalIOSelector (uint Number, uintChannel)int GetDigitalIOSelector (uint Number, outuint Channel)VB.NetSetDi

48 Function LibraryThe number of the SDI channel, with allowed values from 0to 31.Value1. State of the DI channel if SetDigitalIOSelector chan-nel is

Function Library 49PCIe-2602-FLRParameter(s)NumberThe number of the SDI channel, with allowed values from 0to 31.ValueState of the DO channel of SetD

vi3.1.1 Source Filters... 543.1.2 Example Graphs ...

50 Function Libraryint GetAudioBitsPerSample (uint Number, outuint Value)VB.NetSetAudioBitsPerSample (ByVal Number As UInte-ger, ByVal Value As UInteg

Function Library 51PCIe-2602-FLRint Sdi_SetAudioClockPhaseDataBypass (UINTNumber, UINT Status)int Sdi_GetAudioClockPhaseDataBypass (UINTNumber, UINT&

52 Function LibrarySyntaxC/C++int Sdi_GetErrorText (int code, char *Text)C#string GetErrorText (int code)VB.NetGetErrorText (ByVal code As Integer) As

DirectShow Programming Guide 53PCIe-2602-FLR3 DirectShow Programming Guide.The goal when writing a DirectShow Application is to construct afilter gra

54 DirectShow Programming Guide3.1.1 Source FiltersADLINK SDI CaptureA WDM Streaming Capture Device, it is actually a kernel-modeKsProxy plug-in. An a

DirectShow Programming Guide 55PCIe-2602-FLRa graph, and two filters’ pins can be selected by dragging from oneoutput pin to another. An arrow will b

56 DirectShow Programming GuideExample GraphTo generate an example graph:1. Open GraphEdit.exe.2. Select ‘Insert a filter into the graph’ from the too

DirectShow Programming Guide 57PCIe-2602-FLRFigure 3-2: GraphEdit Interface3.2 Driver ControlThe ADLINK SDI Capture filter provides control of video

58 DirectShow Programming Guide OleCreatePropertyFrame( NULL, // Parent window 0, // x (Reserved) 0, // y (Reserved) FilterInfo.achName,

DirectShow Programming Guide 59PCIe-2602-FLRCompression (FOURCC code) is ‘YUV8’ and GUID is 38565559-0000-0010-8000-00AA00389B71MEDIASUBTYPE_RGB24 -

List of Figures viiPCIe-2602-FLRList of FiguresFigure 2-1: Bottom-up Image Orientation ... 29Figure 2-2: Top-down Ima

60 DirectShow Programming GuideCompression (FOURCC code) is ‘YU10’ and GUID is 30315559-0000-0010-8000-00AA00389B71MEDIASUBTYPE_YUV10 - 30bit YCbCr 4:

DirectShow Programming Guide 61PCIe-2602-FLRCompression (FOURCC code) is ‘YU12’ and GUID is 32315559-0000-0010-8000-00AA00389B71MEDIASUBTYPE_YUV12 -

62 DirectShow Programming GuideCompression (FOURCC code) is ‘RGBC’ and GUID is 43424752-0000-0010-8000-00AA00389B713.4 Proprietary Interfaces The foll

DirectShow Programming Guide 63PCIe-2602-FLR CUSTOM_PROPERTY_GET_CHANNEL_NUMBER = 15, CUSTOM_PROPERTY_XET_SENSOR_FORMAT = 20,CUSTOM_PROPERTY_GE

64 DirectShow Programming Guide&Version, sizeof(ULONG), &dwReturn); 2. CUSTOM_PROPERTY_GET_FIRMWARE_VERSION The property allows retrieval of t

DirectShow Programming Guide 65PCIe-2602-FLRm_pKsPropertySet->Get(PROPSETID_AVS260X_CUSTOM, CUSTOM_PROPERTY_GET_DRIVER_VERSION, NULL, 0, &Vers

66 DirectShow Programming Guide&id, sizeof(ULONG), &dwReturn); 6. CUSTOM_PROPERTY_GET_CHANNEL_NUMBER The property allows acquisition of the ha

DirectShow Programming Guide 67PCIe-2602-FLREXAMPLE #01: Retrieve the format valueULONG Format; DWORD dwReturn;m_pKsPropertySet->Get( PROPSETID_AV

68 DirectShow Programming Guidem_pKsPropertySet->Get( PROPSETID_AVS260X_CUSTOM, CUSTOM_PROPERTY_GET_DETECTED_SENSOR_FORMAT, NULL, 0, &Format, s

DirectShow Programming Guide 69PCIe-2602-FLROutput format can be detected and reported to the application,with supported formats as described, where

viii List of FiguresThis page intentionally left blank.

70 DirectShow Programming GuideEXAMPLE #01: Retrieves all DO statusULONG State; DWORD dwReturn;m_pKsPropertySet->Get( PROPSETID_AVS260X_CUSTOM, CUS

DirectShow Programming Guide 71PCIe-2602-FLRThe property retrieves the number of frames dropped sincestart capture due to:The buffer queue is full an

72 DirectShow Programming Guide3.5 Build Environment Settings3.5.1 Include FilesApplications must include the files as shown.3.5.2 Library FilesApplic

DirectShow Programming Guide 73PCIe-2602-FLR3.5.3 Microsoft Visual C++For VC++, the build environment must be set up prior to building,as follows.1.

74 DirectShow Programming GuideThis page intentionally left blank.

Important Safety Instructions 75PCIe-2602-FLRImportant Safety InstructionsFor user safety, please read and follow all instructions,WARNINGS, CAUTION

76 Important Safety InstructionsX Never attempt to fix the equipment. Equipment should only be serviced by qualified personnel.A Lithium-type battery

Getting Service 77PCIe-2602-FLRGetting ServiceContact us should you require any service or assistance. ADLINK Technology, Inc. Address: 9F, No.166

78 Getting ServiceADLINK Technology, Inc. (French Liaison Office) Address: 15 rue Emile Baudot, 91300 Massy CEDEX, France Tel: +33 (0) 1 60 12 3

List of Tables ixPCIe-2602-FLRList of TablesTable 2-1: API Functions ................. 5