ADLINK Technology HDV62A User manual

Advance Technologies; Automate the World.
HDV62A
High-Definition Video/Audio Capture Card
Function Library Reference
Revision: 2.00
Revision Date: Nov.23, 2012
Part No: 50-11248-1000

ii
Revision History
Revision Release Date Description of Change(s)
2.00 Nov. 23, 2012 Initial Release

Preface iii
HDV62A-FLR
Preface
Copyright 2012 ADLINK Technology, Inc.
This document contains proprietary information protected by copy-
right. All rights are reserved. No part of this manual may be repro-
duced by any mechanical, electronic, or other means in any form
without prior written permission of the manufacturer.
Disclaimer
The information in this document is subject to change without prior
notice in order to improve reliability, design, and function and does
not represent a commitment on the part of the manufacturer.
In no event will the manufacturer be liable for direct, indirect, spe-
cial, incidental, or consequential damages arising out of the use or
inability to use the product or documentation, even if advised of
the possibility of such damages.
Environmental Responsibility
ADLINK is committed to fulfill its social responsibility to global
environmental preservation through compliance with the Euro-
pean Union's Restriction of Hazardous Substances (RoHS) direc-
tive and Waste Electrical and Electronic Equipment (WEEE)
directive. Environmental protection is a top priority for ADLINK.
We have enforced measures to ensure that our products, manu-
facturing processes, components, and raw materials have as little
impact on the environment as possible. When products are at their
end of life, our customers are encouraged to dispose of them in
accordance with the product disposal and/or recovery programs
prescribed by their nation or company.
Trademarks
Product names mentioned herein are used for identification pur-
poses only and may be trademarks and/or registered trademarks
of their respective companies.

iv Preface
Conventions
Take note of the following conventions used throughout this
reference to make sure that users perform certain tasks and
instructions properly.
NOTE:
NOTE:
Additional information, aids, and tips that help users perform
tasks.
CAUTION:
Information to prevent minor physical injury, component dam-
age, data loss, and/or program corruption when trying to com-
plete a task.
WARNING:
Information to prevent serious physical injury, component
damage, data loss, and/or program corruption when trying to
complete a specific task.

Table of Contents v
HDV62A-FLR
Table of Contents
Revision History ......................................................................ii
Preface.................................................................................... iii
List of Figures........................................................................ ix
List of Tables.......................................................................... xi
1 Introduction ........................................................................ 1
1.1 Overview.............................................................................. 1
1.2 Features............................................................................... 1
2 Function Library................................................................. 3
2.1 List of Functions................................................................... 3
2.2 Setting Up the Build Environment........................................ 6
2.2.1 Include Files ............................................................... 6
2.2.2 Library Files ................................................................ 6
2.2.3 DLL Files .................................................................... 7
2.3 Device Control Functions..................................................... 7
2.3.1 Device Count .............................................................. 7
2.3.2 Device Open............................................................... 8
2.3.3 Device Close .............................................................. 8
2.3.4 Device Vendor Name ................................................. 9
2.3.5 Device Model Name ................................................. 10
2.3.6 Device Version ......................................................... 11
2.3.7 Device Firmware Version ......................................... 12
2.3.8 Driver Version........................................................... 13
2.3.9 Library Version ......................................................... 14
2.3.10 Device ID .................................................................. 14
2.3.11 Device Reset ............................................................ 15
2.4 Image Format Control Functions ....................................... 16

vi Table of Contents
2.4.1 Channel .................................................................... 16
2.4.2 Sensor Format .......................................................... 17
2.4.3 Sensor Width ............................................................ 22
2.4.4 Sensor Height ........................................................... 23
2.4.5 Width ........................................................................ 24
2.4.6 Height ....................................................................... 25
2.4.7 X Offset..................................................................... 26
2.4.8 Y Offset..................................................................... 27
2.4.9 Output Format........................................................... 28
2.4.10 HDelay ...................................................................... 31
2.4.11 Contrast .................................................................... 32
2.4.12 Hue ........................................................................... 32
2.4.13 Saturation ................................................................. 33
2.4.14 Brightness................................................................. 34
2.4.15 HdmiSensorResolution ............................................. 35
2.4.16 SDSensorResolution ................................................ 36
2.4.17 AnalogSensorResolution .......................................... 37
2.4.18 Video Capabilities ..................................................... 39
2.4.19 Image Orientaton ...................................................... 43
2.5 Event and Callback Functions ........................................... 46
2.5.1 Event Selector .......................................................... 46
2.5.2 Event Handle ............................................................ 47
2.5.3 CallbackSelector....................................................... 49
2.5.4 Callback .................................................................... 50
2.6 Acquisition Control Functions ............................................ 51
2.6.1 Acquisition Frame Count .......................................... 51
2.6.2 Acquisition Start........................................................ 52
2.6.3 Acquisition Stop ........................................................ 52
2.6.4 One Shot .................................................................. 53
2.6.5 Image Stream ........................................................... 54
2.6.6 Acquisition Status ..................................................... 54
2.6.7 Acquisition Statistics ................................................. 55

Table of Contents vii
HDV62A-FLR
2.6.8 Sensor Status ........................................................... 56
2.6.9 Save Image .............................................................. 57
2.6.10 Audio Stream............................................................ 58
2.7 Other Functions ................................................................. 59
2.7.1 Error Text.................................................................. 59
2.8 EDID Functions.................................................................. 60
2.8.1 Ready Status ............................................................ 60
2.8.2 Access Permission ................................................... 62
2.8.3 Write Protection ........................................................ 63
2.8.4 ROM Selector ........................................................... 64
2.8.5 ROM Read/Write ...................................................... 65
2.9 Audio Format Control Functions ........................................ 66
2.9.1 Audio Input ............................................................... 66
2.9.2 Audio Channels ........................................................ 67
2.9.3 Samples Per Second................................................ 68
2.9.4 Bits Per Sample........................................................ 69
2.9.5 Audio Capabilties...................................................... 70
Important Safety Instructions.............................................. 73
Getting Service...................................................................... 75

viii Table of Contents
This page intentionally left blank.

List of Figures ix
HDV62A-FLR
List of Figures
Figure 2-1: Image Layout............................................................ 23
Figure 2-2: Bottom-up Image Orientation ................................... 45
Figure 2-3: Top-down Image Orienation ..................................... 46
Figure 2-4: EDID ROM Architecture ........................................... 62

xListofFigures
This page intentionally left blank.

List of Tables xi
HDV62A-FLR
List of Tables
Table 2-1: API Functions .................................................................. 6

xii List of Tables
This page intentionally left blank.

Introduction 1
HDV62A-FLR
1 Introduction
1.1 Overview
The HDV62A full HD video/audio capture card, based on the PCI
Express®x4 interface, enables acquisition of video and digital
audio streams from both HD (high-definition) and SD (stan-
dard-definition) video at up to 170 MHz DVI input.
ADLINK's HDV62A not only delivers superior quality high-defini-
tion video data from DVI or HDMI, suitable for medical, scientific
imaging and multi media device testing, but also provides an ana-
log video decoder comprehensively supporting CVBS, S-video,
analog RGB, and Component signal capture.
Equipped with a FPGA (field programmable gate array) and a 512
MB memory buffer, the HDV62A enables image streaming of
specified target areas to a host PC, as well as real-time hardware
color space conversion to offload repetitive tasks from the host
CPU.
The HDV62A is equipped with the ViewCreator Pro®utility,
enabling setup, configuration, testing, and system debugging with-
out requiring any software programming. As well, ADLINK's WDM
driver is compatible with Microsoft® Directshow to reduce engi-
neering effort and accelerate time to market.
1.2 Features
XUncompressed 1920 x 1080p, 60 fps video stream
XSupport for CVBS, S-video, RGB and component video
input
XSupport for HDMI and DVI video input
XSupport for HDMI, S/PDIF audio input
XPCI Express® x4 interface
XHardware color spacezRAM frame buffer
XConfigurable EDID
XDirect SDK support

2Introduction
This page intentionally left blank.

Function Library 3
HDV62A-FLR
2 Function Library
This chapter describes the API (Application Programming Inter-
face) for the HDV62A, for development of application programs
within Visual C++, C#, Visual Basic.Net, Delphi, and Borland C++
Builder.
While the HDV62 API is based on DirectShow technologies, com-
plexity of DirectShow programming has been eliminated in favor of
simple API functions requiring no familiarity with DirectShow pro-
gramming.
DirectShow technologies can alternativerly be utilized, as
described in the HDV62A User’s Manual, to program applications.
Please note that the API and DirectShow programming cannot be
combined to access a single HDV62A card at the same time.
2.1 List of Functions
Category Function Name
Device Control Hdv62_GetDeviceCount
Hdv62_DeviceOpen
Hdv62_DeviceClose
Hdv62_GetDeviceVendorName
Hdv62_GetDeviceModelName
Hdv62_GetDeviceVersion
Hdv62_GetDeviceFirmwareVersion
Hdv62_GetDriverVersion
Hdv62_GetLibraryVersion
Hdv62_GetDeviceID
Hdv62_DeviceReset

4 Function Library
Category Function Name
Image Format
Control
Hdv62_SetChannel
Hdv62_GetChannel
Hdv62_SetSensorFormat
Hdv62_GetSensorFormat
Hdv62_GetSensorWidth
Hdv62_GetSensorHeight
Hdv62_SetWidth
Hdv62_GetWidth
Hdv62_SetHeight
Hdv62_GetHeight
Hdv62_SetXOffset
Hdv62_GetXOffset
Hdv62_SetYOffset
Hdv62_GetYOffset
Hdv62_SetOutputFormat
Hdv62_GetOutputFormat
Hdv62_SetHDelay
Hdv62_GetHDelay
Hdv62_SetContrast
Hdv62_GetContrast
Hdv62_SetHue
Hdv62_GetHue
Hdv62_SetSaturation
Hdv62_GetSaturation
Hdv62_SetBrightness
Hdv62_GetBrightness
Hdv62_GetDetectedSensorFormat
Hdv62_GetHdmiSensorResolution
Hdv62_GetSDSensorResolution
Hdv62_GetAnalogSensorResolution
Hdv62_GetVideoCapabilities
Hdv62_SetImageOrientation
Hdv62_GetImageOrientation

Function Library 5
HDV62A-FLR
Category Function Name
Event & Callback Hdv62_SetEventSelector
Hdv62_GetEventSelector
Hdv62_SetEventHandle
Hdv62_GetEventHandle
Hdv62_SetCallbackSelector
Hdv62_GetCallbackSelector
Hdv62_SetCallback
Acquisition Control Hdv62_SetAcquisitionFrameCount
Hdv62_GetAcquisitionFrameCount
Hdv62_AcquisitionStart
Hdv62_AcquisitionStop
Hdv62_OneShot
Hdv62_GetImageStream
Hdv62_GetAcquisitionStatus
Hdv62_GetAcquisitionStatistics
Hdv62_GetSensorStatus
Hdv62_SaveImage
Hdv62_GetAudioStream
Others Hdv62_GetErrorText
EDID Hdv62_SetEdidReadyStatus
Hdv62_GetEdidReadyStatus
Hdv62_SetEdidAccessPermission
Hdv62_GetEdidAccessPermission
Hdv62_SetEdidWriteProtection
Hdv62_GetEdidWriteProtection
Hdv62_SetEdidRomSelector
Hdv62_GetEdidRomSelector
Hdv62_SetEdidRom
Hdv62_GetEdidRom

6 Function Library
Table 2-1: API Functions
2.2 Setting Up the Build Environment
2.2.1 Include Files
All applications using API are required to include the following
files.
2.2.2 Library Files
All C/C++ applications using API require the following library files.
Audio Format
Control
Hdv62_SetAudioInput
Hdv62_GetAudioInput
Hdv62_SetAudioChannels
Hdv62_GetAudioChannels
Hdv62_SetAudioSamplesPerSec
Hdv62_GetAudioSamplesPerSec
Hdv62_SetAudioBitsPerSample
Hdv62_GetAudioBitsPerSample
Hdv62_GetAudioCapabilities
Include File
Hdv62.h The header file required for all C/C++
applications.
Hdv62.vb The function definitions required for all
VB.Net applications.
Hdv62.cs The function definitions required for all C#
applications.
Category Function Name

Function Library 7
HDV62A-FLR
2.2.3 DLL Files
All applications using API require the following DLL files.
.
All files are located in the directory \ADLINK\hdv62\Include
2.3 Device Control Functions
2.3.1 Device Count
Returns the total number of HDV62A devices in the system,
with a maximum of 16 devices detectable.
Syntax
C/C++
int Hdv62_GetDeviceCount(UINT &Count)
C#
int GetDeviceCount(out uint Count)
VB.Net
GetDeviceCount (ByRef Count as UInteger) As
Integer
Library File
Hdv62.lib Exports API function definitions.
Required for all Visual C/C++
applications..
Hdv62_bcb.lib Exports API function definitions.
Required for all Borland C++ Builder
applications.
DLL File
Hdv62.dll Dynamic link library. Required for all
applications.

8 Function Library
Parameter(s)
Count
The total number of devices installed.
Return Value
No error occurs if return value ≥0; if a negative value,
please refer to Other Functions for return code error informa-
tion.
2.3.2 Device Open
Initializes a specified device. Should be called before other
functions except those with no Number parameter.
Syntax
C/C++
int Hdv62_DeviceOpen (UINT Number)
C#
int DeviceOpen (uint Number)
VB.Net
DeviceOpen (ByVal Number As UInteger) As Inte-
ger
Parameter(s)
Number
The number of the device to be opened, with allowed values
from 0 to 15.
Return Value
No error occurs if return value ≥0; if a negative value,
please refer to Other Functions for return code error informa-
tion.
2.3.3 Device Close
Closes the device and releases all allocated resources, this
function should be called before terminating the application.