IEI Integration HDC-4x-SDK User Manual
IEI Technology Corp.
User Manual
HDC-4x Series SDK (Windows)
MODEL:
HDC-4x Series SDK (Windows)
A SDK software development kit for the HDC-4x Series
Rev. 2.00 – 3 October, 2012
Page 1
Date Version Changes
3 October, 2012 2.00 Updated for software version v2.00
21 June, 2011 1.00 Initial release
HDC-4x Series SDK (Windows)
Revision
Page 2
HDC-4x Series SDK (Windows)
COPYRIGHT NOTICE
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, special, 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.
This document contains proprietary information protected by copyright. All rights are
Copyright
reserved. No part of this manual may be reproduced by any mechanical, electronic, or
other means in any form without prior written permission of the manufacturer.
TRADEMARKS
All registered trademarks and product names mentioned herein are used for identification
purposes only and may be trademarks and/or registered trademarks of their respective
owners.
Page 3
HDC-4x Series SDK (Windows)
Table of Contents
1 DRIVER AND SDK INSTALLATION........................................................................ 6
1.1 OVERVIEW.................................................................................................................. 7
1.2 DRIVER INSTALLATION............................................................................................... 8
1.2.1 Uninstall Driver................................................................................................11
1.3 SOFTWARE INSTALLATION .........................................................................................11
1.3.1 System Requirements.........................................................................................11
1.3.2 HDCapture SDK Installation........................................................................... 12
1.3.3 Uninstall HDCapture SDK..............................................................................15
2 HDCAPTURE SDK APPLICATION.........................................................................17
2.1 HDCAPTURE SDK OVERVIEW................................................................................. 18
2.2 VIDEO CAPTURE....................................................................................................... 18
2.3 VIDEO DECODING .................................................................................................... 21
2.4 VIDEO BYPASS ......................................................................................................... 22
3 API INTRODUCTION................................................................................................ 24
3.1 BUILD ENVIRONMENT.............................................................................................. 25
3.2 API INTRODUCTION.................................................................................................. 25
3.2.1 DeviceMan API Introduction........................................................................... 26
3.2.2 CPLDMan API Introduction............................................................................ 28
3.2.3 Mb86H55rebDll API Introduction................................................................... 32
3.2.4 Role of Mb86H55rebDll API ...........................................................................32
3.2.5 Using Mb86H55rebDll API............................................................................. 32
3.2.6 Mb86H55rebDll API Description....................................................................35
3.3 DIRECTSHOW GRAPH............................................................................................... 41
3.3.1 Encoding Graph............................................................................................... 41
3.4 ARCHITECTURE OF SDK........................................................................................... 42
4 FAQ ............................................................................................................................... 43
A ERROR CODE............................................................................................................ 45
A.1 ERROR CODE OVERVIEW......................................................................................... 46
Page 4
HDC-4x Series SDK (Windows)
A.2 ERROR_MODULE[7:0]........................................................................................ 46
A.3 ERROR_STATUS[23:0] ........................................................................................ 47
A.3.1 IDLE................................................................................................................47
A.3.2 ENC ................................................................................................................. 48
A.3.3 DEC................................................................................................................. 52
Page 5
HDC-4x Series SDK (Windows)
Chapter
1
1 Driver and SDK
Installation
Page 6
HDC-4x Series SDK (Windows)
1.1 Overview
A CD is shipped with the video capture card. The CD contains a driver for the video
capture controllers on the card. When the video capture card is installed on the system,
the driver must be installed. Failure to install the driver means that that video capture card
cannot be detected by the system.
This manual includes SDK information for the HDC-4x Series, which includes:
HDC-401
HDC-401E
NOTE:
The Found New Hardware Wizard will automatically start when the
system detects the video capture card (see the image below). Click
Cancel to exit the wizard and follow the steps described in this chapter
to install the driver and the HDCapture SDK.
Page 7
1.2 Driver Installation
To install the HDC-4x Series SDK (Windows) driver, please follow the steps below: If the
HDC-4x Series SDK (Windows)
HDC-4x Series SDK (Windows) driver is already installed, please refer to Section
uninstall the driver first.
NOTE:
If the User Access Control dialog box appears during installation,
click Yes to continue.
Step 1: Make sure to log in the system as the administrator.
Step 2: Insert the driver CD.
Step 3: Locate the “Driverinstaller.bat” file in the driver CD. Double click it.
Step 4: A confirmatio n wind ow appears. Click Install.
1.2.1 to
Page 8
Figure 1-1: Windows Security
Step 5: If the following window appears, click Install this driver software Anyway.
HDC-4x Series SDK (Windows)
Figure 1-2: Windows Warning Window
Step 6: The Device Driver Installation Wizard appears. Click Next to start.
Figure 1-3: Device Driver Installation Wizard
Step 7: The driver starts to install a nd the screen in
Figure 1-4 appears.
Page 9
HDC-4x Series SDK (Windows)
Figure 1-4: Driver Installing
Step 8: When the driver installation is complete, the screen in
the Finish button to finish driver installation.
Figure 1-5: Driver Installation Complete
Figure 1-5 appears. Click
Page 10
Step 9: Check the device manager in the Windows control panel to ensure the driver
(MB86H55-REB PCI and WinDriver) has been properly installed (
Figure 1-6).
HDC-4x Series SDK (Windows)
Figure 1-6: Device Manager
1.2.1 Uninstall Driver
To uninstall the driver, please follow the steps below.
Step 1: Make sure to login the system as the administrator.
Step 2: Locate the “Driveruninstaller.bat” file in the driver CD. Double click it to uninstall
the driver.
Step 3: The console window pop-up and all drivers will be uninstalled.
1.3 Software Installation
The HDC-4x Series SDK (Windows) comes with a video capture application – HDCapture
SDK. This section describes how to install the application in Windows environment.
1.3.1 System Requirements
The supported OS versions are listed below:
Microsoft Windows XP SP2 32-bit
Page 11
Microsoft Windows 7 32-bit
After installing the driver, the following programs must be installed in order to use the
HDCapture SDK:
Microsoft .NET Framework 3.0/3.5/4.0
Microsoft DirectX 9.0c
Win7DSFilterTweaker tool (for Windows 7 OS only)
Visual C++ 2005 & 2008 Redistributable
Please download the setup files of these programs from the official websites and install
these programs in the system. For detailed setup procedures for some of the above
programs, please refer to Appendix A.
1.3.2 HDCapture SDK Installation
HDC-4x Series SDK (Windows)
To install the HDCapture SDK, please follow the steps below.
Step 1: Insert the driver CD.
Step 2: Locate the HDCaptureSDK_x86_Vxxxx.msi file in the driver CD
(HDCaptureSDK_x86_VxxxxR.msi R: released version;
HDCaptureSDK_x86_VxxxxD.msi D: debug version). Double click the setup file
to start the installation. The user ca n also download the latest setup file from IEI
website.
Step 3: The HDCapture Setup Wizard welcome window appears. Click Next to start.
Page 12
HDC-4x Series SDK (Windows)
Figure 1-7: HDCapture Setup Wizard
Step 4: Select a folder for HDCapture installation in
Figure 1-8. Click Next to continue.
Figure 1-8: Select Installation Folder
Step 5: The following screen appears. Click Next to confirm the installation.
Page 13
HDC-4x Series SDK (Windows)
Figure 1-9: Confirm Installation
Step 6: The system starts installing the HDCapture.
Step 7: If an error happens during the installation (as shown in
Continue to continue the installation.
Figure 1-10: Installation Error Messages
Figure 1-10), click
Page 14
HDC-4x Series SDK (Windows)
NOTE:
Since "DumpFile.dll" and "PushFileSource2.dll " are DirectShow filters,
the user must register them before use. If the error described in Step 7
occurs, please use one of the following methods to register after the
HDCapture SDK installation:
1. Start Menu -> Programs -> HDCapture SDK V1.01 -> InstallFilter.
or
2. Go to the installation folder and click InstallFilter.bat.
Step 8: When the HDCapture is successfully installed, the following window appears.
Click Close to exit. Step 0:
Figure 1-11: Installation Complete
1.3.3 Uninstall HDCapture SDK
To uninstall the HDCapture SDK, follow the steps below.
Step 1: Select Control Panel Æ Programs Æ Programs and Features.
Step 2: Select HDCapture SDK and click the Uninstall button to uninstall the
HDCapture SDK (
Figure 1-12).
Page 15
HDC-4x Series SDK (Windows)
Figure 1-12: Uninstall HDCapture SDK
Step 3: A confirmatio n wind ow appears. Click Yes to uninstall the HDCapture SDK.
Page 16
HDC-4x Series SDK (Windows)
2 HDCapture SDK
Chapter
2
Application
Page 17
Loading...