Transcript
HANDBOOK
Picolo HD MultiCam for Picolo HD Driver 3.3 1841 Picolo HD 3G
© EURESYS s.a. 2016 - Document version 3.3.519 built on 2016-09-29
EURESYS s.a. shall retain all property rights, title and interest of the documentation of the hardware and the soware, and of the trademarks of EURESYS s.a. All the names of companies and products mentioned in the documentation may be the trademarks of their respective owners. The licensing, use, leasing, loaning, translation, reproduction, copying or modification of the hardware or the soware, brands or documentation of EURESYS s.a. contained in this book, is not allowed without prior notice. EURESYS s.a. may modify the product specification or change the information given in this documentation at any time, at its discretion, and without prior notice. EURESYS s.a. shall not be liable for any loss of or damage to revenues, profits, goodwill, data, information systems or other special, incidental, indirect, consequential or punitive damages of any kind arising in connection with the use of the hardware or the soware of EURESYS s.a. or resulting of omissions or errors in this documentation.
Contents 1841 Picolo HD 3G Handbook
Contents Description..............................................................................................................................................................................7 Description................................................................................................................................................................................... 7 Product Composition.................................................................................................................................................................. 8 System Requirements................................................................................................................................................................. 8
Mechanical Specification.......................................................................................................................................... 10 Product Pictures........................................................................................................................................................................ 10 Dimensions and Weight............................................................................................................................................................ 10 Connectors................................................................................................................................................................................. 11 Connectors Location................................................................................................................................................................. 15
Electrical Specification............................................................................................................................................... 16 Power Requirements................................................................................................................................................................. 16 Audio/Video Inputs.................................................................................................................................................................... 16 SDI Digital Audio/Video Input............................................................................................................................................... 16 HDMI Digital Audio/Video Input............................................................................................................................................17 DVI-D Digital Video Input...................................................................................................................................................... 17 DVI-A Analog Video Inputs.................................................................................................................................................... 18 YPbPr Analog Video Inputs................................................................................................................................................... 18 Analog Audio Inputs.............................................................................................................................................................. 19 General Purpose I/O.................................................................................................................................................................. 19 Watchdog Switch....................................................................................................................................................................... 20
Environmental Specification..................................................................................................................................21 Storage Conditions.................................................................................................................................................................... 21 Operating Conditions................................................................................................................................................................ 21 Compliance................................................................................................................................................................................ 21
Functional Specification............................................................................................................................................23 Audio/Video Source Selection.................................................................................................................................................. 23 Audio/Video Interfaces.............................................................................................................................................................. 23 SDI Audio/Video Interface..................................................................................................................................................... 24 HDMI Audio/Video Interface..................................................................................................................................................25 DVI-D Video Interface.............................................................................................................................................................25 DVI-A Video Interface.............................................................................................................................................................26 YPbPr Analog Video Interface............................................................................................................................................... 26
iii
1841 Picolo HD 3G Handbook Contents Analog Audio Interface..........................................................................................................................................................27 Audio/Video Delivery................................................................................................................................................................. 27 I/O Functional Specifications....................................................................................................................................................29 Watchdog................................................................................................................................................................................... 29
Soware Specification................................................................................................................................................ 30 MultiCam for Picolo HD Driver..................................................................................................................................................30
MultiCam for Picolo HD API.................................................................................................................................... 31 MCHD C API – Functions Groups.............................................................................................................................................. 31 Initialize/terminate Functions Group....................................................................................................................................... 31 MchdInitialize()...................................................................................................................................................................... 31 MchdTerminate()....................................................................................................................................................................32 Board Functions Group............................................................................................................................................................. 32 MchdCreateBoard()................................................................................................................................................................32 MchdDeleteBoard()................................................................................................................................................................ 33 MchdGetBoardType().............................................................................................................................................................34 MchdSetOemKey()................................................................................................................................................................. 34 MchdCheckOemKey()............................................................................................................................................................ 35 Video Acquisition Functions Group.......................................................................................................................................... 35 MchdCreateVideoChannel()...................................................................................................................................................36 MchdCreateSogVideoChannel...............................................................................................................................................37 MchdDeleteVideoChannel()...................................................................................................................................................38 MchdRegisterVideoChannelCallback()................................................................................................................................. 38 MchdGetVideoChannelResolution()......................................................................................................................................39 MchdGetVideoChannelColorFormat().................................................................................................................................. 40 MchdGetVideoChannelInput()...............................................................................................................................................40 MchdGetVideoChannelSignalState.......................................................................................................................................41 MchdGetVideoChannelSyncOnGreenState.......................................................................................................................... 42 MchdGetVideoChannelFrameRate()..................................................................................................................................... 42 MchdSetVideoChannelHue()................................................................................................................................................. 43 MchdGetVideoChannelHue().................................................................................................................................................44 MchdSetVideoChannelSaturation()...................................................................................................................................... 44 MchdGetVideoChannelSaturation()......................................................................................................................................45 MchdSetVideoChannelGamma()...........................................................................................................................................45 MchdGetVideoChannelGamma().......................................................................................................................................... 46 MchdSetVideoChannelContrast()..........................................................................................................................................46 MchdGetVideoChannelContrast()......................................................................................................................................... 47 MchdSetVideoChannelBrightness()...................................................................................................................................... 48 MchdGetVideoChannelGamma().......................................................................................................................................... 48 MchdSetVideoChannelSharpness()...................................................................................................................................... 49 MchdGetVideoChannelSharpness()...................................................................................................................................... 49 MchdGetVideoChannelVideoPresence................................................................................................................................. 50 MchdStartVideoChannel()..................................................................................................................................................... 51 MchdStopVideoChannel()......................................................................................................................................................51
iv
Contents 1841 Picolo HD 3G Handbook MchdSaveSurfaceToJpegFile().............................................................................................................................................. 52 Audio Acquisition Functions Group..........................................................................................................................................52 MchdCreateAudioChannel().................................................................................................................................................. 53 MchdDeleteAudioChannel().................................................................................................................................................. 53 MchdRegisterAudioChannelCallback()................................................................................................................................. 54 MchdGetAudioChannelInput().............................................................................................................................................. 55 MchdGetAudioChannelSampleRate()................................................................................................................................... 55 MchdStartAudioChannel().....................................................................................................................................................56 MchdStopAudioChannel()..................................................................................................................................................... 56 I/O Functions Group.................................................................................................................................................................. 57 MchdGetIoDirection()............................................................................................................................................................ 57 MchdSetIoDirection().............................................................................................................................................................58 MchdGetIoState()................................................................................................................................................................... 59 MchdSetIoState()................................................................................................................................................................... 60 Types Definitions....................................................................................................................................................................... 60 MCHD_AUDIO_CALLBACK......................................................................................................................................................60 MCHD_AUDIO_CALLBACK_INFO........................................................................................................................................... 61 MCHD_AUDIO_CHANNEL.......................................................................................................................................................61 MCHD_AUDIO_FRAME............................................................................................................................................................61 MCHD_AUDIO_INPUT............................................................................................................................................................ 62 MCHD_AUDIO_SAMPLE_RATE............................................................................................................................................... 62 MCHD_BOARD........................................................................................................................................................................ 62 MCHD_BOARD_TYPE..............................................................................................................................................................62 MCHD_IO_DIRECTION............................................................................................................................................................63 MCHD_IO_STATE.................................................................................................................................................................... 63 MCHD_STATUS....................................................................................................................................................................... 63 MCHD_VIDEO_CALLBACK...................................................................................................................................................... 64 MCHD_VIDEO_CALLBACK_INFO............................................................................................................................................ 64 MCHD_VIDEO_CHANNEL....................................................................................................................................................... 64 MCHD_VIDEO_CHANNEL_VIDEO_PRESENCE....................................................................................................................... 65 MCHD_VIDEO_COLOR_FORMAT............................................................................................................................................ 65 MCHD_VIDEO_INPUT............................................................................................................................................................. 66 MCHD_VIDEO_PRESENCE......................................................................................................................................................66 MCHD_VIDEO_RESOLUTION..................................................................................................................................................66 MCHD_VIDEO_SIGNAL_STATE............................................................................................................................................... 67 MCHD_VIDEO_SURFACE........................................................................................................................................................ 67 MCHD_VIDEO_SYNC_ON_GREEN_STATE............................................................................................................................. 68
Kernel Streaming API...................................................................................................................................................69 Board Identifiers........................................................................................................................................................................ 69 Property Access Procedure....................................................................................................................................................... 69 Custom Property Identifiers......................................................................................................................................................70 De-interlacing.........................................................................................................................................................................70 Video Input.............................................................................................................................................................................70 Frame Rate............................................................................................................................................................................. 71 Resolution.............................................................................................................................................................................. 71
v
1841 Picolo HD 3G Handbook Contents Denoising................................................................................................................................................................................72 Video Flexible Resolution......................................................................................................................................................72 Sync On Green....................................................................................................................................................................... 73 Analog Audio Input Type...................................................................................................................................................... 73 H.264 Encoder Bit Rate......................................................................................................................................................... 74 H.264 Encoder Bit Rate Mode...............................................................................................................................................74 H.264 Encoder Profile............................................................................................................................................................74 Privacy Mask.......................................................................................................................................................................... 75 H.264 OSD Text Path............................................................................................................................................................. 75 I/O Direction...........................................................................................................................................................................76 I/O State................................................................................................................................................................................. 76
Appendix................................................................................................................................................................................ 78 MultiCam for Picolo HD Driver Installation..............................................................................................................................78 DirectShow Filter Graph Setup Example................................................................................................................................. 79 Precautions for Use of Board Products................................................................................................................................... 81
vi
Description 1841 Picolo HD 3G Handbook
Description Description Picolo HD Cards Overview The Picolo HD cards, namely Picolo HD One, Picolo HD 3G, Picolo HD H.264 and Picolo HD 3G DVI, are PCI Express capture cards capable of acquiring audio and video from one audio/video source using various types of audio/video interfaces. Picolo HD One, Picolo HD 3G, and Picolo HD H.264 offer the following audio/video interfaces: • • • •
SDI and HDMI for connecting a high-definition digital audio/video source DVI-D for connecting a high-definition digital video source DVI-A and Y/Pb/Pr for connecting a high-definition analog video source L/R for connecting a line-level analog stereo audio source
Picolo HD 3G DVI offers the following audio/video interfaces: • • • • •
DVI-D for connecting a high-definition digital video source DVI-A and Y/Pb/Pr for connecting a high-definition analog video source S-Video for connecting a standard-definition analog Y/C video source CVBS for connecting a standard-definition analog composite video source L/R for connecting a line-level analog stereo audio source
The Picolo HD cards support the following image resolutions and frame rates: • • • • •
HD 1080p up to 30fps HD 1080i up to 60 fps HD 1080p up to 60fps (for Picolo HD 3G and Picolo HD 3G DVI only) HD 720p up to 60 fps SD 525i60 and 625i50 (for Picolo HD 3G DVI only)
Picolo HD H.264 implements the following exclusive features: • • • •
H.264 Baseline and Main Profile video compression Multi-stream video delivery: 2 compressed video streams + 1 uncompressed video Video de-interlacing and de-noising On-screen display
The Picolo HD cards also feature: • Two-channel high-quality (16-bit, 32/44.1/48 kHz) audio capture. • 16 general purpose I/O lines • A watchdog reset switch The Picolo HD cards come with a Microso Windows driver named MultiCam for Picolo HD. It provides: • A DirectShow API offering compatibility with third-party applications based on DirectShow. • An easy-to-use proprietary C API
7
1841 Picolo HD 3G Handbook Description
Product Composition The product is commercially referenced as:
Product Code 1841
Product Designation Picolo HD 3G
Deliverables The product is delivered in a single carton box including the following elements:
Quantity 1
Short Description Picolo HD 3G card Cable set including:
1
• 1 Y/Pb/Pr/L+R analog audio/video cable • 1 Watchdog cable
1
Picolo HD Series Installation Guide
System Requirements Software requirements Picolo HD Product
MCHD Driver Version
PC1840 Picolo HD One (S/N up to PHO01435)
1.0 or higher
PC1840 Picolo HD One (S/N PHO01436 and higher)
3.0 or higher
PC1841 Picolo HD 3G
1.0 or higher
PC1842 Picolo HD H.264
1.0 or higher
PC1843 Picolo HD 3G DVI
3.0 or higher
Hardware Requirements
8
Minimum
Recommended
Processors
Core 2 Duo or better
Intel 2nd/ 3rd Generation Core i3/i5/i7 processors
System Memory
2GB DDR3
4GB DDR3 (dual channel) or better
Graphic Card
Supports DirectX 9 or higher
Intel HD2000/2500/3000/4000 or better
Description 1841 Picolo HD 3G Handbook
Operating Systems Operating System Version / Service Pack
Processor Architecture
MCHD Driver Version
Microso Windows XP / SP3
x86 (32-bit)
1.0 or higher
Microso Windows 7 / SP1
x86 (32-bit)
1.0 or higher
Microso Windows 7 / SP1
x86-64 (64-bit)
1.0 or higher
Microso Windows Server 2008 R2 / SP1
x86-64 (64-bit)
1.0 or higher
Microso Windows 8
x86 (32-bit)
2.0 or higher
Microso Windows 8
x86-64 (64-bit)
2.0 or higher
Microso Windows Server 2012
x86-64 (64-bit)
2.0 or higher
Note: Refer to the MultiCam for Picolo HD 3.3 - Release Notes for an up-to-date list of supported operated systems.
9
1841 Picolo HD 3G Handbook Mechanical Specification
Mechanical Specification Product Pictures
Figure 1: Picolo HD 3G
Dimensions and Weight Dimensions
Value [mm]
Value [inches]
Card length (excluding bracket and bracket connectors)
135
5.31
Card height (including PCI Express connector)
101
3.98 3.98
Y/Pb/Pr/L/R component cable length
200
7.87
S-Video/CVBS/L/R component cable length
N/A
N/A
Characteristic
10
Mechanical Specification 1841 Picolo HD 3G Handbook
Value [mm]
Value [inches]
350
13.78
Value [g]
Value [lb]
Picolo HD 3G weight
107
0.236
Bypass module weight
N/A
N/A
Y/Pb/Pr/L/R component cable weight
40
0.088
S-Video/CVBS/L/R component cable weight
N/A
N/A
4
0.009
Characteristic Watchdog cable length Weight
Characteristic
Watchdog cable weight
Connectors Y/Pb/Pr/L+R analog audio/video cable: Y Input Connector
Figure 2: Green 2-pin female receptacle, cable-mount, RCA connector
Pin
Signal
Usage
Center
Y IN
Y component analog video input
Outer
GND
Signal ground
Y/Pb/Pr/L+R analog audio/video cable: Pb Input Connector
Figure 3: Blue 2-pin female receptacle, cable-mount, RCA connector
Pin
Signal
Usage
Center
Pb IN
Pb component analog video input
Outer
GND
Signal ground
Y/Pb/Pr/L+R analog audio/video cable: Pr Input Connector
Figure 4: Red 2-pin female receptacle, cable-mount, RCA connector
Pin
Signal
Center
Pr IN
Usage Pr component analog video input
11
1841 Picolo HD 3G Handbook Mechanical Specification
Pin
Signal
Outer
GND
Usage Signal ground
Y/Pb/Pr/L/R Components Cable: Audio Left + Right Inputs Connector
Figure 5: Twin white and red 2-pin female receptacle, cable-mount, RCA connectors
Pin
Signal
Usage
White Center
L IN
Le channel analog audio input
White Outer
GND
Signal ground
Red Center
R IN
Right channel analog audio input
Red Outer
GND
Signal ground
SDI Input Connector outer center
Figure 6: 2-pin female receptacle, right-angled PCB-mount, BNC connector
Pin
Signal
Center
SDI IN
Outer
GND
Usage SD/HD/3G-SDI serial digital video input Chassis ground
HDMI Input Connector
Figure 7: HDMI type A (full size) receptacle (female) connector
12
Pin
Signal
Usage
1
TMDS Data2 +
2
TMDS Data2 Shield
3
TMDS Data2-
Digital audio/video input TMDS data lane 2
4
TMDS Data1+
Digital audio/video input TMDS data lane 1
5
TMDS Data1 Shield
6
TMDS Data1-
Digital audio/video input TMDS data lane 1
7
TMDS Data0+
Digital audio/video input TMDS data lane 0
8
TMDS Data0 Shield
9
TMDS Data0-
Digital audio/video input TMDS data lane 2 Shield
Shield
Shield Digital audio/video input TMDS data lane 0
Mechanical Specification 1841 Picolo HD 3G Handbook
Pin
Signal
Usage
10
TMDS Clock+
11
TMDS Clock Shield
12
TMDS Clock-
13
-
14
-
15
SCL
DDC serial clock
16
SDA
DDC serial data
17
Ground
18
+5V
19
HPD
Shell
Chassis ground
Digital audio/video input TMDS clock lane Shield Digital audio/video input TMDS clock lane
DDC Ground
Hot Plug Detect Shield
DVI-I Input Connector
Figure 8: DVI-I socket(female) connector
Pin
Signal
Usage
1
TMDS Data2-
Digital red video input
2
TMDS Data2+
Digital red video input
3
TMDS Data 2/4 Shield
4
TMDS Data4-
Digital green video input (link 2)
5
TMDS Data4+
Digital green video input (link 2)
6
SCL
DDC serial clock
7
SDA
DDC serial data
8
VSYNC
Analog vertical sync input
9
TMDS Data1-
Digital green video input
10
TMDS Data1+
Digital green video input
11
TMDS Data 1/3 Shield
12
TMDS Data3-
Digital blue video input (link 2)
13
TMDS Data3+
Digital blue video input (link 2)
14
-
15
Ground
16
HPD
Shield
Shield
Ground Hot Plug Detect
13
1841 Picolo HD 3G Handbook Mechanical Specification
Pin
Signal
Usage
17
TMDS Data0-
Digital blue video input and digital sync
18
TMDS Data0+
Digital blue video input and digital sync
19
TMDS Data 0/5 Shield
20
TMDS Data5-
Digital red video input (link 2)
21
TMDS Data5+
Digital red video input (link 2)
22
TMDS Clock Shield
23
TMDS Clock+
Digital video clock
24
TMDS Clock-
Digital video clock
C1
R
Analog red video input
C2
G
Analog green video input
C3
B
Analog blue video input
C4
HSYNC
Analog horizontal sync
C5
AGND
Analog Ground
Shell
Chassis ground
Shield
Shield
I/O Connector 2
20
1
19
Figure 9: 20-pin dual-row 0.1" pitch pin header without shrouding
14
Pin
Signal
Usage
1
GND
Signal ground
2
GND
Signal ground
3
IO09
General Purpose I/O
4
IO01
General Purpose I/O
5
IO10
General Purpose I/O
6
IO02
General Purpose I/O
7
IO11
General Purpose I/O
8
IO03
General Purpose I/O
9
IO12
General Purpose I/O
10
IO04
General Purpose I/O
11
IO13
General Purpose I/O
12
IO05
General Purpose I/O
13
IO14
General Purpose I/O
Mechanical Specification 1841 Picolo HD 3G Handbook
Pin
Signal
Usage
14
IO06
General Purpose I/O
15
IO15
General Purpose I/O
16
IO07
General Purpose I/O
17
IO16
General Purpose I/O
18
IO08
General Purpose I/O
19
GND
Signal ground
20
GND
Signal ground
WATCHDOG-1 Connector 2 1
Figure 10: 2-pin 0.1" pitch pin header without shrouding
Pin
Signal
Usage
1
WATCHDOG RESET A
Watchdog reset switch
2
WATCHDOG RESET B
Watchdog reset switch
WATCHDOG-2 Connector 2 1
Figure 11: 2-pin 0.1" pitch pin header without shrouding
Pin
Signal
Usage
1
WATCHDOG RESET A
Watchdog reset switch
2
WATCHDOG RESET B
Watchdog reset switch
Connectors Location COMPONENTS I/O SDI
HDMI
DVI-I WATCHDOG PCIe
15
1841 Picolo HD 3G Handbook Electrical Specification
Electrical Specification Power Requirements The card draws power from the +3V3 and the +12V power rails of the PCI Express connector.
Operating characteristics PCI Express +3.3 V supply voltage
Min.
Typ.
Max.
Unit
3.0
3.3
3.6
V
PCI Express +3.3 V supply current PCI Express +12 V supply voltage
0.865 11
A
12
PCI Express +12 V supply current
13
V
0.060
PCI Express power rail requirement
A
3.4
4.1
W
Audio/Video Inputs Audio/video inputs electrical specification topics SDI Digital Audio/Video Input on page 16 HDMI Digital Audio/Video Input on page 17 DVI-D Digital Video Input on page 17 DVI-A Analog Video Inputs on page 18 YPbPr Analog Video Inputs on page 18 Analog Audio Inputs on page 19
SDI Digital Audio/Video Input The SDI input is electrically compatible with HD-SDI, and 3G-SDI specification compliant audio/video sources.
Min.
Typ.
Max.
Unit
Peak-to-peak signal amplitude @1.485 Gbps (short cable)
720
800
950
mV
Peak-to-peak signal amplitude @2.970 Gbps (short cable)
720
800
880
mV
2.970
Gbps
Operating characteristics
Serial data rate Achievable cable length @2.970 Gbps with RG59 coaxial cable
16
100
m
Electrical Specification 1841 Picolo HD 3G Handbook
Min.
Operating characteristics
Typ.
Max.
Unit
Achievable cable length @1.485 Gbps with RG59 coaxial cable
160
m
Input impedance
75
Ω
Return loss measured over the 5MHz to 2.25GHz frequency range Min.
Absolute maximum ratings DC voltage
Typ.
-2.0
-15
dB
Max.
Unit
+2.0
V
Note: Exceeding the above limits may irreversibly damage the product. The usage of DC-coupled video sources outside the above mentioned limits is strictly prohibited. Functional description topic(s) SDI Audio/Video Interface on page 24
HDMI Digital Audio/Video Input The HDMI audio/video input implements a single TMDS link complying with the electrical specifications of the High Definition Multimedia Interface 1.3 for HDMI Sink.
Operating characteristics
Min.
TMDS Clock Rate
25.175
Typ.
Max.
Unit
165
MHz
DVI-D Digital Video Input The DVI-D video input provides a single TMDS link complying with the TMDS electrical specifications of the Digital Visual Interface 1.0.
Operating characteristics
Min.
TMDS Clock Rate
25.175
Typ.
Max.
Unit
165
MHz
Functional description topic(s) HDMI Audio/Video Interface on page 25 Functional description topic(s) DVI-D Video Interface on page 25
17
1841 Picolo HD 3G Handbook Electrical Specification
DVI-A Analog Video Inputs Operating Characteristics Operating characteristics
Min.
Typ.
Max.
Unit
Signal amplitude (R, G, B inputs)
0.5
0.700
1.0
V
Signal amplitude (Hsync)
1.5
V
Signal amplitude (Vsync)
1.5
V
Input impedance
75
Ohm
Pixel sampling rate
25
150
MHz
Max.
Unit
+2.0
V
Note: Sync on green is supported since version 3.3 of MultiCam for Picolo HD.
Absolute Maximum Ratings Absolute maximum ratings
Min.
DC voltage
-2.0
Typ.
Note: Exceeding the above limits may irreversibly damage the product. Functional description topic(s) DVI-A Video Interface on page 26
YPbPr Analog Video Inputs Operating characteristics
Min.
Typ.
Max.
Unit
Signal amplitude (Y input) See note
0.7
1.000
1.4
V
Signal amplitude (Pb, Pr inputs)
0.5
0.700
1.0
V
Input impedance Pixel sampling rate
75 25
Ohm 150
MHz
Max.
Unit
+2.0
V
Note: The signal applied on the Y input is composed of: • a 700 mV Y (luminance) analog video component and, • a 300 mV analog composite sync.
Absolute maximum ratings
Min.
DC voltage
-2.0
Typ.
Note: Exceeding the above limits may irreversibly damage the product.
18
Electrical Specification 1841 Picolo HD 3G Handbook Functional description topic(s) YPbPr Analog Video Interface on page 26
Analog Audio Inputs The analog audio inputs are electrically compatible with line-level analog audio sources.
Operating characteristics
Min.
Typ.
Max.
Unit
Full-scale input voltage
1.0
Vrms
Full-scale input voltage
2.8
Vptp
Input impedance (@ 1 kHz)
11.5
kΩ
32/44.1/48
kHz
Sampling frequency Absolute maximum ratings DC voltage
Min.
Typ.
-10
Input signal level
Max.
Unit
+10
V
2.0
Vptp
Note: Exceeding the above limits may irreversibly damage the product. Functional description topic(s) Analog Audio Interface on page 27
General Purpose I/O The general purpose I/O's are quasi-bidirectional I/O. They can be used as an input or as output ports. When set to the LOW state, the I/O port actively drives the output to the low state. The device is then capable of sinking 10 mA from the load with a voltage drop as little as 1 Volt. When set to the HIGH state, the I/O port stops driving the output to the low state. Instead, a weak-pullup pulls the I/O port towards the 3V3 rail. In that state, the I/O port can be used as an input port. A stronger transient pull-up is temporarily applied when the I/O state changes from LOW to HIGH. This improves the rising time of the output voltage.
Operating characteristics
Min.
Operating voltage range
Max.
Unit
0
PCI 3.3V rail
V
LOW level input voltage
-0.5
1.0
V
HIGH level input voltage
2.4
3.8
V
LOW level output current (VOUT=1 V)
10
HIGH level output current (VOUT=0 V)
30
HIGH level output transient current (VOUT=0 V)
Typ.
mA 300 1
µA mA
19
1841 Picolo HD 3G Handbook Electrical Specification
Operating characteristics
Min.
Maximum allowed input current though protection diodes (VIN outside 0V~3.3V range)
-400
Absolute maximum ratings
Min.
Typ.
Typ.
Max.
Unit
400
µA
Max.
Unit
DC voltage
-0.5
PCI 3.3V rail + 0.5
V
DC current
-20
+20
mA
Note: Clamping diodes start conducting when applying voltage outside the operating voltage range exceeding a 0.5 V margin. Note: Exceeding the above limits may irreversibly damage the product. Functional description topic(s) I/O Functional Specifications on page 29
Watchdog Switch The watchdog switch is a polarity free switch built capable of switching loads operating in the 0V ~ 3.3V range.
Operating characteristics
Min.
Operating voltage range Switch current @ON state
Typ.
Max.
Unit
0
PCI 3.3V rail
V
-75
75
mA
1
µA
Max.
Unit
Leakage current @OFF state Absolute maximum ratings
Min.
Typ.
DC voltage
-0.5
PCI 3.3V rail + 0.5
V
Clamping diodes current (see note)
-20
+20
mA
Note: Clamping diodes start conducting when applying voltage outside the operating voltage range exceeding a 0.5 V margin. Note: Exceeding the above limits may irreversibly damage the product. Functional description topic(s) Watchdog on page 29
20
Environmental Specification 1841 Picolo HD 3G Handbook
Environmental Specification Storage Conditions The following requirements are applicable to Picolo HD 3G when the product is not operating: Requirement during storage conditions
Requirement during storage conditions Temperature range Humidity range
Min.
Max.
Unit
-20
+70
°C
-4
+158
°F
10
90
% Relative Humidity non-condensing
Operating Conditions The following requirements are applicable to Picolo HD 3G during product operation: Requirements
Requirement during operating conditions Ambient air temperature range Ambient humidity range
Min.
Max.
Unit
0
+50
°C
+32
+122
°F
10
90
% RH non-condensing
Compliance Electromagnetic Picolo HD 3G complies with: • The European Council EMC Directive 2004/108/EC • The Unites States FCC rule 47 CFR 15 It has been tested and found to comply with the following standards: Radiated emission
Standard
Limit / Level
EN 55022
Class B
21
1841 Picolo HD 3G Handbook Environmental Specification
Standard
Limit / Level
FCC 47 CFR 15 Sub-part B
Class B
Immunity
Standard
Description
EN 55024
Information technology equipment. Immunity characteristics
EN 61000-4-2
Testing and measurement techniques – Electrostatic discharge immunity test
EN 61000-4-3
Radiated, radio-frequency, electromagnetic field immunity test
EN 61000-4-4
Electrical fast transient/burst immunity test
EN 61000-4-5
Surge immunity test
EN 61000-4-6
Immunity to conducted disturbances, induced by radio-frequency fields
EN 61000-4-8
Testing and measurement techniques – Power frequency magnetic field immunity test
EN 61000-4-11
Voltage dips, short interruptions and voltage variations immunity tests
RoHS Picolo HD 3G is manufactured according to the European Union RoHS 2011/65/EU Directive.
WEEE According the European directive 2012/19/EU (previously 2002/96/EC), Picolo HD 3G must be disposed of separately from normal household waste. It must be recycled according to the local regulations.
22
Functional Specification 1841 Picolo HD 3G Handbook
Functional Specification Audio/Video Source Selection One audio/video source can be connected to the card using any one of the following connection configuration: Audio/video source configurations
Use case
Audio Source
Video Source
SDI Audio/Video
Digital audio embedded into SDI
SDI digital video
HDMI Audio/Video
Digital audio embedded into HDMI
HDMI digital video
SDI + L/R Audio
Line-level analog audio
SDI digital video
HDMI + L/R Audio
Line-level analog audio
HDMI digital video
DVI-D + L/R Audio
Line-level analog audio
DVI digital video
DVI-A + L/R Audio
Line-level analog audio
DVI analog video
Y/Pb/Pr + L/R Audio
Line-level analog audio
Y/Pb/Pr analog video
The audio/video sources attach to connectors mounted on the bracket, possibly using an adapter cable: Audio/video source connections
Audio/video source type
Connector
Adapter
SDI digital audio/video
SDI
N/A
HDMI digital audio/video
HDMI
N/A
DVI-D digital video
DVI-I
N/A
DVI-A analog video
DVI-I
N/A
Y/Pb/Pr analog video
Components
Y/Pb/Pr/L+R analog audio/video cable
L/R Audio
Components
Y/Pb/Pr/L+R analog audio/video cable
Audio/Video Interfaces MCHD C API topic(s) MchdGetVideoChannelInput() on page 40 MchdGetAudioChannelInput() on page 55 Audio/video interfaces topics SDI Audio/Video Interface on page 24 HDMI Audio/Video Interface on page 25
23
1841 Picolo HD 3G Handbook Functional Specification DVI-D Video Interface on page 25 DVI-A Video Interface on page 26 YPbPr Analog Video Interface on page 26 Analog Audio Interface on page 27
SDI Audio/Video Interface The product provides one Serial Digital Interface input. The SDI input can be used for the acquisition of digital video and embedded digital audio. It complies with the following standards: • SMPTE 424M Level A: 3 Gbps Serial Digital Interface (3G-SDI) • SMPTE 292M: 1.5 Gbps High Definition Serial Digital Interface (HD-SDI) Note: The SMPTE 424M Level B (a multiplexing scheme where two streams of 1920 x 1080 interlaced 50 / 60 Hz video is transported over a 3G SDI link) is not supported. Supported 3G-SDI source characteristics
Property Name
Property Value
Serial link bit rates
2.970 Mbps and 2.970/1.001 Mbps
Pixel Encoding
8-bit/10-bit/12-bit YCbCr 4:2:2 only
Image resolution
1920(H) x 1080(V)
Scanning method
Progressive only
Frame rates (1080p)
50, 59.94, 60 fps
Audio channels
Two 16-bit LPCM 48 kHz embedded audio channels
Supported HD-SDI source characteristics
Property Name
Property Value
Serial link bit rates
1.485 Mbps and 1.485/1.001 Mbps
Pixel Encoding
8-bit/10-bit/12-bit YCbCr 4:2:2
Image resolutions
1920(H) x 1080(V) 1280(H) x 720(V)
Scanning methods
Progressive and interlaced
Field rates (1080i)
50, 59.94, 60 fps
Frame rates (1080p)
23.98, 24, 25, 29.97, 30 fps
Frame rates (720p)
25, 29.97, 30, 50, 59.94, 60 fps
Audio channels
Two 16-bit LPCM 48 kHz embedded audio channels
Note: 720p23.98 and 720p24 video sources are not supported. Electrical specification topic(s) SDI Digital Audio/Video Input on page 16
24
Functional Specification 1841 Picolo HD 3G Handbook
HDMI Audio/Video Interface The product provides one High Definition Multimedia Interface input. The HDMI interface can be used for the acquisition of digital video and/or digital audio. It complies with the version 1.0 of the HDMI specification. Supported HDMI source characteristics
Property Name
Property Value
TMDS clock frequency
Up to 165 MHz
Pixel Encoding
24-bit RGB 4:4:4 (default encoding for HDMI)
Image resolutions
1920(H) x 1080(V) 1280(H) x 720(V)
Scanning methods
Progressive and interlaced
Field rates (1080i)
50, 59.94, 60 fps
Frame rates (1080p)
23.98, 24, 25, 29.97, 30, 50, 59.94, 60 fps
Frame rates (720p)
25, 29.97, 30, 50, 59.94, 60 fps
Audio channels
Two 16-bit LPCM 32/44.1/48 kHz embedded audio channels
Note: 720p23.98 and 720p24 video sources are not supported. Note: The card doesn't audio/video from HDCP encrypted sources. When an HDCP encrypted signal is detected, the card delivers a blank image. Electrical specification topic(s) DVI-D Digital Video Input on page 17
DVI-D Video Interface The DVI-I connectorprovides one single-link DVI-D input that can be used for the acquisition of digital video. Supported DVI-D source characteristics
Property Name
Property Value
TMDS clock frequency
Up to 165 MHz
Pixel Encoding
24-bit RGB 4:4:4 (default encoding for HDMI)
Image resolutions
1920(H) x 1080(V) 1280(H) x 720(V)
Scanning methods
Progressive and interlaced
Field rates (1080i)
50, 59.94, 60 fps
25
1841 Picolo HD 3G Handbook Functional Specification
Property Name
Property Value
Frame rates (1080p)
23.98, 24, 25, 29.97, 30, 50, 59.94, 60 fps
Frame rates (720p)
25, 29.97, 30, 50, 59.94, 60 fps
Note: 720p23.98 and 720p24 video sources are not supported. Note: The card doesn't capture audio/video data from HDCP encrypted sources. When an HDCP encrypted signal is detected, the card delivers a blank image. Electrical specification topic(s) DVI-D Digital Video Input on page 17
DVI-A Video Interface The DVI-I connectorprovides one DVI-A input interface that can be used for the acquisition of analog RGB video only. Supported DVI-A source characteristics
Property Name
Property Value
Sampling rate
165 MHz max.
Video signal
Analog RGB video components
Image resolutions
1920(H) x 1080(V) 1280(H) x 720(V)
Scanning methods
Progressive and interlaced
Field rates (1080i)
50, 59.94, 60 fps
Frame rates (1080p)
23.98, 24, 25, 29.97, 30, 50, 59.94, 60 fps
Frame rates (720p)
25, 29.97, 30, 50, 59.94, 60 fps
Note: 720p23.98 and 720p24 video sources are not supported. Electrical specification topic(s) DVI-A Analog Video Inputs on page 18
YPbPr Analog Video Interface The Components connector provides one YPbPr input interface that can be used for the acquisition of Y, Pb, and Pr analog components of a high-definition video source. Supported YPbPr source characteristics
26
Property Name
Property Value
Sampling rate
165 MHz max.
Functional Specification 1841 Picolo HD 3G Handbook
Property Name
Property Value
Video signal
Analog YPbPr video components
Image resolutions
1920(H) x 1080(V) 1280(H) x 720(V)
Scanning methods
Progressive and interlaced
Field rates (1080i)
50, 59.94, 60 fps
Frame rates (1080p)
23.98, 24, 25, 29.97, 30, 50, 59.94, 60 fps
Frame rates (720p)
25, 29.97, 30, 50, 59.94, 60 fps
Note: 720p23.98 and 720p24 video sources are not supported. Electrical specification topic(s) YPbPr Analog Video Inputs on page 18
Analog Audio Interface The Components connector rprovides one audio input interface that can be used for the audio capture from analog linelevel mono and stereo audio sources. Supported Analog Audio source characteristics
Property Name
Property Value
Number of audio channels
2 (Stereo Le and Right)
Signal level
Line-level
Electrical specification topic(s) Analog Audio Inputs on page 19
Audio/Video Delivery Video Delivery Picolo HD 3G delivers a single stream of uncompressed video in the YUY2 video format: YUY2 Video Format Characteristics
Property Name
Property Value
FourCC Code
YUY2
Format class
Packed YUV 4:2:2
Horizontal sampling periods
Y: 1 U: 2 V:2
27
1841 Picolo HD 3G Handbook Functional Specification
Property Name
Property Value
Vertical sampling periods
Y: 1 U: 1 V:1
Component bit depth
8-bits
Byte ordering
Y0, U0, Y1, V0, Y2, U2, Y3, V2
The resolution of the delivered image is, by default,the native resolution of the video source. It can also be set to a lower resolution. Image Resolution Capabilities
Video Source Resolution
Deliverable Video Resolutions (H x V) 1920 x 1080 1280 x 1024, 1280 x 960, 1280 x 720
1920 (H) x 1080(V)
1024 x 768 800 x 600 720 x 576, 720 x 480 640 x 480 1280 x 720
1280 (H) x 720(V)
800 x 600 720 x 576, 720 x 480 640 x 480
The frame rate and the scanning method of the delivered image are identical to the frame rate and the scanning method of the video source.
Audio Delivery The product delivers high-quality digital audio
Property Name
Property value
Number of audio channels
2
Encoding
16-bit Linear PCM
Sampling Rate(s)
32 kHz, 44.1 kHz, and 48 kHz (See note)
Note: The sampling rate of the delivered audio stream is identical to the sampling rate of the audio source. MCHD C API topic(s) MchdCreateVideoChannel() on page 36 MchdGetVideoChannelResolution() on page 39 MCHD_VIDEO_RESOLUTION on page 66
28
Functional Specification 1841 Picolo HD 3G Handbook Video resolution structure definition.
I/O Functional Specifications Property Name
Property Value
Number of General Purpose I/O ports
16
I/O port type
Bidirectional
Change-Of-State signaling
Individually configurable
Electrical specification topic(s) General Purpose I/O on page 19 MCHD C API topic(s) MchdGetIoDirection() on page 57 MchdSetIoDirection() on page 58 MchdGetIoState() on page 59 MchdSetIoState() on page 60
Watchdog Picolo HD 3G provides a hardware watchdog. Its purpose is to monitor the soware application and to restart the PC aer an anomalous inactivity time-out. This ensures a reliable operation of unattended systems. The time-out duration is fixed at 3 minutes. The watchdog behaves as a normally open static switch. It is intended to be wired in parallel with the reset button of the PC. Therefore the product is equipped with two internal 2 pin headers named WATCHDOG-1 and WATCHDOG-2. Both connectors are equivalent and the polarity of the watchdog outputs doesn't matter.
Watchdog Installation Instructions To insert the watchdog switch in parallel to the system reset switch, proceed as follows: • Locate the "reset cable" linking the RESET BUTTON to the RESET INPUT on the motherboard. • Reconnect the motherboard end of the "reset cable" to the WATCHDOG-2 connector. • Using the supplied "watchdog cable", connect the RESET INPUT on the motherboard to the WATCHDOG-1 connector. Electrical specification topic(s) Watchdog Switch on page 20
29
1841 Picolo HD 3G Handbook Soware Specification
Soware Specification MultiCam for Picolo HD Driver The MultiCam for Picolo HD driver enables the operation of Picolo HD cards.
Software requirements Picolo HD Product
MCHD Driver Version
PC1840 Picolo HD One (S/N up to PHO01435)
1.0 or higher
PC1840 Picolo HD One (S/N PHO01436 and higher)
3.0 or higher
PC1841 Picolo HD 3G
1.0 or higher
PC1842 Picolo HD H.264
1.0 or higher
PC1843 Picolo HD 3G DVI
3.0 or higher
Operating Systems Operating System Version / Service Pack
Processor Architecture
MCHD Driver Version
Microso Windows XP / SP3
x86 (32-bit)
1.0 or higher
Microso Windows 7 / SP1
x86 (32-bit)
1.0 or higher
Microso Windows 7 / SP1
x86-64 (64-bit)
1.0 or higher
Microso Windows Server 2008 R2 / SP1
x86-64 (64-bit)
1.0 or higher
Microso Windows 8
x86 (32-bit)
2.0 or higher
Microso Windows 8
x86-64 (64-bit)
2.0 or higher
Microso Windows Server 2012
x86-64 (64-bit)
2.0 or higher
Application Programming Interfaces MultiCam for Picolo HD exposes the following API's: • MCHD: a proprietary C API • A DirectShow API The easy-to-use MCHD C API provides access to all the product functionalities. The driver also comes with customized Audio Capture and Video Capture DirectShow source filters. This allows third-party DirectShow applications to capture audio and video with Picolo HD cards.
30
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
MultiCam for Picolo HD API MCHD C API – Functions Groups Functions Groups Initialize/terminate Functions Group on page 31 Board Functions Group on page 32 Video Acquisition Functions Group on page 35 Audio Acquisition Functions Group on page 52 I/O Functions Group on page 57
Initialize/terminate Functions Group List of Functions Groups MCHD C API – Functions Groups on page 31 Functions Group Members MchdInitialize() on page 31 MchdTerminate() on page 32
MchdInitialize() MCHD_STATUS MCHD_API MchdInitialize();
Description The MchdInitialize() function must be called before any other MCHD API function to initialize the driver. To access the function, your program should include this header file: #include
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Initialize/terminate Functions Group on page 31 Related function(s) MchdTerminate() on page 32 MchdCreateBoard() on page 32
31
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MchdTerminate() MCHD_STATUS MCHD_API MchdTerminate();
Description The MchdTerminate() function must be called once for each call to MchdInitialize(). No more MCHD API function calls can be made aer the last call to MchdTerminate().
Return Value
Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Initialize/terminate Functions Group on page 31 Related function(s) MchdInitialize() on page 31 MchdCreateBoard() on page 32
Board Functions Group List of Functions Groups MCHD C API – Functions Groups on page 31 Functions Group Members MchdCreateBoard() on page 32 MchdDeleteBoard() on page 33 MchdGetBoardType() on page 34 MchdSetOemKey() on page 34 MchdCheckOemKey() on page 35
MchdCreateBoard() MCHD_STATUS MCHD_API MchdCreateBoard(unsigned int n, MCHD_BOARD *board);
Description Get a handle to the nth Picolo HD board in the system. The created board must be deleted by MchdDeleteBoard(). The board is set to MCHD_INVALID_HANDLE in case of error. Note: This function can be used to enumerate the Picolo HD boards that are present in the system. Therefore, increment the value n until the function returns MCHD_INVALID_HANDLE.
32
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Arguments Argument
Description
n
Position of the board in the system (zero-based numbering)
board
Pointer in which the board handle will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Board Functions Group on page 32 Datatype(s) MCHD_BOARD on page 62 Board instance. Related function(s) MchdDeleteBoard() on page 33 MchdGetBoardType() on page 34 MchdCreateVideoChannel() on page 36
MchdDeleteBoard() MCHD_STATUS MCHD_API MchdDeleteBoard(MCHD_BOARD board);
Description Delete a board previously created by MchdCreateBoard().
Arguments Argument
Description
board
Board handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Board Functions Group on page 32 Datatype(s) MCHD_BOARD on page 62 Board instance. Related function(s) MchdCreateBoard() on page 32
33
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MchdGetBoardType() MCHD_STATUS MCHD_API MchdGetBoardType(MCHD_BOARD board, MCHD_BOARD_TYPE *type);
Description Retrieve the board type.
Arguments Argument
Description
board
Board handle
type
Pointer in which the board type will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Board Functions Group on page 32 Datatype(s) MCHD_BOARD on page 62 Board instance. MCHD_BOARD_TYPE on page 62 Board type. Related function(s) MchdCreateBoard() on page 32
MchdSetOemKey() MCHD_STATUS MCHD_API MchdSetOemKey(MCHD_BOARD board, const char oemKey[16]);
Description Set the OEM key.
Arguments Argument
Description
board
Board handle
oemKey[16]
16-characters OEM key
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Board Functions Group on page 32
34
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook Datatype(s) MCHD_BOARD on page 62 Board instance. Related function(s) MchdCheckOemKey() on page 35
MchdCheckOemKey() MCHD_STATUS MCHD_API MchdCheckOemKey(MCHD_BOARD board, const char oemKey[16]);
Description Checks the OEM key. Compares the given OEM key with the actual OEM key previously stored on the board EEPROM with the MchdSetOemKey() function.
Arguments Argument
Description
board
Board handle
oemKey[16]
16-characters OEM key
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully and the OEM key has been checked as correct. Returned value is MCHD_STATUS_INVALID_OEM_KEY when the function executes successfully but the OEM key was not the expected one. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Board Functions Group on page 32 Datatype(s) MCHD_BOARD on page 62 Board instance. Related function(s) MchdSetOemKey() on page 34
Video Acquisition Functions Group List of Functions Groups MCHD C API – Functions Groups on page 31 Functions Group Members MchdCreateVideoChannel() on page 36 MchdCreateSogVideoChannel on page 37 MchdDeleteVideoChannel() on page 38 MchdRegisterVideoChannelCallback() on page 38 MchdGetVideoChannelResolution() on page 39
35
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API MchdGetVideoChannelColorFormat() on page 40 MchdGetVideoChannelInput() on page 40 MchdGetVideoChannelSignalState on page 41 MchdGetVideoChannelSyncOnGreenState on page 42 MchdGetVideoChannelFrameRate() on page 42 MchdSetVideoChannelHue() on page 43 MchdGetVideoChannelHue() on page 44 MchdSetVideoChannelSaturation() on page 44 MchdGetVideoChannelSaturation() on page 45 MchdSetVideoChannelGamma() on page 45 MchdGetVideoChannelGamma() on page 46 MchdSetVideoChannelContrast() on page 46 MchdGetVideoChannelContrast() on page 47 MchdSetVideoChannelBrightness() on page 48 MchdGetVideoChannelGamma() on page 48 MchdSetVideoChannelSharpness() on page 49 MchdGetVideoChannelSharpness() on page 49 MchdGetVideoChannelVideoPresence on page 50 MchdStartVideoChannel() on page 51 MchdStopVideoChannel() on page 51 MchdSaveSurfaceToJpegFile() on page 52
MchdCreateVideoChannel() MCHD_STATUS MCHD_API MchdCreateVideoChannel(MCHD_BOARD board, MCHD_VIDEO_INPUT input, MCHD_VIDEO_RESOLUTION resolution, MCHD_VIDEO_COLOR_FORMAT format, MCHD_VIDEO_CHANNEL *channel);
Description Create a video channel. The created channel must be deleted by MchdDeleteVideoChannel. The channel is set to MCHD_INVALID_HANDLE in case of error.
Arguments Argument
Description
board
Board handle
input
Video input
resolution
Width and height of the delivered video frames, expressed in pixels
format
Data format of the delivered video
channel
Pointer in which the video channel handle will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully.
36
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook For a list of status/error codes, refer to MCHD_STATUS on page 63. Note: When using MCHD_VIDEO_RESOLUTION_NATIVE, if the driver is unable to detect the actual source resolution within a 2 second time-frame, the function returns the MCHD_STATUS_SIGNAL_NOT_DETECTED error value. Functional specification topic Audio/Video Delivery on page 27 Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_INPUT on page 66 Video input. MCHD_VIDEO_RESOLUTION on page 66 Video resolution structure definition. MCHD_VIDEO_COLOR_FORMAT on page 65 Data format of the delivered color video MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdDeleteVideoChannel() on page 38 MchdRegisterVideoChannelCallback() on page 38 MchdStartVideoChannel() on page 51
MchdCreateSogVideoChannel MCHD_STATUS MCHD_API MchdCreateSogVideoChannel(MCHD_BOARD board, MCHD_VIDEO_INPUT input, MCHD_VIDEO_RESOLUTION resolution, MCHD_VIDEO_COLOR_FORMAT format, MCHD_VIDEO_CHANNEL *channel);
Description Create a video channel with "sync on green" support. The created channel must be deleted by MchdDeleteVideoChannel. The channel is set to MCHD_INVALID_HANDLE in case of error. Note: This function applies only to analog high-definition video sources attached to the DVI-A video interface.
Arguments Argument
Description
board
Board handle
input
Video input
resolution
Width and height of the delivered video frames, expressed in pixels
format
Data format of the delivered video
channel
Pointer in which the video channel handle will be returned
37
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_INPUT on page 66 Video input. MCHD_VIDEO_RESOLUTION on page 66 Video resolution structure definition. MCHD_VIDEO_COLOR_FORMAT on page 65 Data format of the delivered color video MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdDeleteVideoChannel() on page 38 MchdRegisterVideoChannelCallback() on page 38 MchdStartVideoChannel() on page 51
MchdDeleteVideoChannel() MCHD_STATUS MCHD_API MchdDeleteVideoChannel(MCHD_VIDEO_CHANNEL channel);
Description Delete a video channel previously created by MchdCreateVideoChannel.
Arguments Argument
Description
channel
Video channel handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdCreateVideoChannel() on page 36
MchdRegisterVideoChannelCallback() MCHD_STATUS MCHD_API MchdRegisterVideoChannelCallback(MCHD_VIDEO_CHANNEL channel, MCHD_VIDEO_CALLBACK callback, void *context);
38
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Description Register a video callback function and user context. Set callback to NULL to unregister.
Arguments Argument
Description
channel
Video channel handle
callback
Function pointer to the function to be used as callback
context
Pointer to the argument to pass to the callback function
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_CALLBACK on page 64 Related function(s) MchdStartVideoChannel() on page 51
MchdGetVideoChannelResolution() MCHD_STATUS MCHD_API MchdGetVideoChannelResolution(MCHD_VIDEO_CHANNEL channel, MCHD_VIDEO_RESOLUTION *resolution);
Description Retrieve the width and the height, expressed in pixels, of the image frames delivered by the video channel.
Arguments Argument
Description
channel
Video channel handle
resolution
Pointer in which the width and the height of the delivered video frames are delivered
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic Audio/Video Delivery on page 27 Functions Group Video Acquisition Functions Group on page 35
39
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_RESOLUTION on page 66 Video resolution structure definition. Related function(s) MchdGetVideoChannelColorFormat() on page 40 MchdGetVideoChannelInput() on page 40 MchdGetVideoChannelFrameRate() on page 42 MchdGetVideoChannelSignalState on page 41
MchdGetVideoChannelColorFormat() MCHD_STATUS MCHD_API MchdGetVideoChannelColorFormat(MCHD_VIDEO_CHANNEL channel, MCHD_VIDEO_COLOR_FORMAT *colorFormat);
Description Retrieve the data format of the video delivered by the video channel.
Arguments Argument
Description
channel
Video channel handle
colorFormat
Pointer in which the data format of the delivered video will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_COLOR_FORMAT on page 65 Data format of the delivered color video Related function(s) MchdGetVideoChannelResolution() on page 39 MchdGetVideoChannelInput() on page 40 MchdGetVideoChannelFrameRate() on page 42 MchdGetVideoChannelSignalState on page 41
MchdGetVideoChannelInput() MCHD_STATUS MCHD_API MchdGetVideoChannelInput(MCHD_VIDEO_CHANNEL channel, MCHD_VIDEO_INPUT *input);
40
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Description Retrieve the input of the video channel.
Arguments Argument
Description
channel
Video channel handle
input
Pointer in which the video input will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic Audio/Video Interfaces on page 23 Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_INPUT on page 66 Video input. Related function(s) MchdGetVideoChannelResolution() on page 39 MchdGetVideoChannelColorFormat() on page 40 MchdGetVideoChannelFrameRate() on page 42 MchdGetVideoChannelSignalState on page 41
MchdGetVideoChannelSignalState MCHD_STATUS MCHD_API MchdGetVideoChannelSignalState(MCHD_VIDEO_CHANNEL channel, MCHD_VIDEO_SIGNAL_STATE *signalState);
Description Retrieve the state of the video signal.
Arguments Argument
Description
channel
Video channel handle
signal
Pointer in which the video signal state will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35
41
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_SIGNAL_STATE on page 67 Video signal state Related function(s) MchdGetVideoChannelVideoPresence on page 50 MchdGetVideoChannelResolution() on page 39 MchdGetVideoChannelColorFormat() on page 40 MchdGetVideoChannelInput() on page 40
MchdGetVideoChannelSyncOnGreenState MCHD_STATUS MCHD_API MchdGetVideoChannelSyncOnGreenState(MCHD_VIDEO_CHANNEL channel, MCHD_VIDEO_SYNC_ON_GREEN_STATE *syncOnGreenState);
Description Retrieve the state of the sync on green.
Arguments Argument
Description
channel
Video channel handle
state
Pointer in which the sync on green state will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_SYNC_ON_GREEN_STATE on page 68 Video Sync on Green State.
MchdGetVideoChannelFrameRate() MCHD_STATUS MCHD_API MchdGetVideoChannelFrameRate(MCHD_VIDEO_CHANNEL channel, long *frameRate);
Description Retrieve the frame rate of the image frames delivered by the video channel.
42
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Arguments Argument
Description
channel
Video channel handle
frameRate
Pointer in which the frame rate value, expressed in fps, will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdGetVideoChannelResolution() on page 39 MchdGetVideoChannelColorFormat() on page 40 MchdGetVideoChannelInput() on page 40 MchdGetVideoChannelSignalState on page 41
MchdSetVideoChannelHue() MCHD_STATUS MCHD_API MchdSetVideoChannelHue(MCHD_VIDEO_CHANNEL handle, long value);
Description Set the hue. Applies exclusively on analog SD video using the NTSC color system.
Arguments Argument
Description
handle
Video channel handle
value
Hue
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdGetVideoChannelHue() on page 44
43
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MchdGetVideoChannelHue() MCHD_STATUS MCHD_API MchdGetVideoChannelHue(MCHD_VIDEO_CHANNEL handle, long *value);
Description Get the hue. Applies exclusively on analog SD video using the NTSC color system.
Arguments Argument
Description
handle
Video channel handle
value
Pointer in which the hue value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelHue() on page 43
MchdSetVideoChannelSaturation() MCHD_STATUS MCHD_API MchdSetVideoChannelSaturation(MCHD_VIDEO_CHANNEL handle, long value);
Description Set the color saturation. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Color saturation
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63.
44
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelSaturation() on page 44
MchdGetVideoChannelSaturation() MCHD_STATUS MCHD_API MchdGetVideoChannelSaturation(MCHD_VIDEO_CHANNEL handle, long *value);
Description Get the color saturation. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Pointer in which the saturation value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelSaturation() on page 44
MchdSetVideoChannelGamma() MCHD_STATUS MCHD_API MchdSetVideoChannelGamma(MCHD_VIDEO_CHANNEL handle, long value);
Description Set the gamma. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
45
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
Argument
Description
value
Gamma value
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelGamma() on page 45
MchdGetVideoChannelGamma() MCHD_STATUS MCHD_API MchdGetVideoChannelGamma(MCHD_VIDEO_CHANNEL handle, long *value);
Description Get the gamma. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Pointer in which the gamma value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelGamma() on page 45
MchdSetVideoChannelContrast() MCHD_STATUS MCHD_API MchdSetVideoChannelContrast(MCHD_VIDEO_CHANNEL handle, long value);
46
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Description Set the Contrast. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Contrast value
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelContrast() on page 46
MchdGetVideoChannelContrast() MCHD_STATUS MCHD_API MchdGetVideoChannelContrast(MCHD_VIDEO_CHANNEL handle, long *value);
Description Get the contrast. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Pointer in which the contrast value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelContrast() on page 46
47
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MchdSetVideoChannelBrightness() MCHD_STATUS MCHD_API MchdSetVideoChannelBrightness(MCHD_VIDEO_CHANNEL handle, long value);
Description Set the brightness. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Brightness value
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelBrightness() on page 48
MchdGetVideoChannelGamma() MCHD_STATUS MCHD_API MchdGetVideoChannelGamma(MCHD_VIDEO_CHANNEL handle, long *value);
Description Get the gamma. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Pointer in which the gamma value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63.
48
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelGamma() on page 45
MchdSetVideoChannelSharpness() MCHD_STATUS MCHD_API MchdSetVideoChannelSharpness(MCHD_VIDEO_CHANNEL handle, long value);
Description Set the sharpness. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
value
Sharpness value
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelSharpness() on page 49
MchdGetVideoChannelSharpness() MCHD_STATUS MCHD_API MchdGetVideoChannelSharpness(MCHD_VIDEO_CHANNEL handle, long *value);
Description Get the sharpness. Applies exclusively on analog SD video.
Arguments Argument
Description
handle
Video channel handle
49
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
Argument
Description
value
Pointer in which the sharpness value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdSetVideoChannelSharpness() on page 49
MchdGetVideoChannelVideoPresence MCHD_STATUS MCHD_API MchdGetVideoChannelVideoPresence(MCHD_VIDEO_CHANNEL handle, MCHD_VIDEO_CHANNEL_VIDEO_PRESENCE *value);
Description Retrieve the video presence indicator of a video signal on at least one video input
Arguments Argument
Description
channel
Video channel handle
value
Pointer in which the video presence indication will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_CHANNEL_VIDEO_PRESENCE on page 65 Video signal prsence. Related function(s) MchdGetVideoChannelColorFormat() on page 40 MchdGetVideoChannelInput() on page 40 MchdGetVideoChannelFrameRate() on page 42 MchdGetVideoChannelSignalState on page 41
50
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
MchdStartVideoChannel() MCHD_STATUS MCHD_API MchdStartVideoChannel(MCHD_VIDEO_CHANNEL channel);
Description Starts the video channel.
Arguments Argument
Description
channel
Video channel handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. Related function(s) MchdStopVideoChannel() on page 51
MchdStopVideoChannel() MCHD_STATUS MCHD_API MchdStopVideoChannel(MCHD_VIDEO_CHANNEL channel);
Description Stops the video channel and waits until the acquisition thread(s) are done. Note: This function cannot be called from the callback function.
Arguments Argument
Description
channel
Video channel handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_VIDEO_CHANNEL on page 64
51
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API Video channel instance. Related function(s) MchdStartVideoChannel() on page 51
MchdSaveSurfaceToJpegFile() MCHD_STATUS MCHD_API MchdSaveSurfaceToJpegFile(const char *fileName, const MCHD_VIDEO_SURFACE *surface, unsigned int quality);
Description Save YUV (YV12 or YUYV) surfaces as JPEG files. Note: This function is based in part on the work of the Independent JPEG Group.
Arguments Argument
Description
fileName
Pointer in which the file name is given
surface
Pointer to the video surface
quality
JPEG quality setting
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Video Acquisition Functions Group on page 35 Datatype(s) MCHD_STATUS on page 63 Success/failure status MCHD_VIDEO_SURFACE on page 67 Video surface structure definition.
Audio Acquisition Functions Group List of Functions Groups MCHD C API – Functions Groups on page 31 Functions Group Members MchdCreateAudioChannel() on page 53 MchdDeleteAudioChannel() on page 53 MchdRegisterAudioChannelCallback() on page 54 MchdGetAudioChannelInput() on page 55 MchdGetAudioChannelSampleRate() on page 55 MchdStartAudioChannel() on page 56 MchdStopAudioChannel() on page 56
52
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
MchdCreateAudioChannel() MCHD_STATUS MCHD_API MchdCreateAudioChannel(MCHD_BOARD board, MCHD_AUDIO_INPUT input, MCHD_AUDIO_SAMPLE_RATE rate, MCHD_AUDIO_CHANNEL *channel);
Description Create an audio channel. The created channel must be deleted by MchdDeleteAudioChannel. The channel is set to MCHD_INVALID_HANDLE in case of error.
Arguments Argument
Description
board
Board handle
input
Audio input
rate
Sampling rate of the delivered digital audio
channel
Pointer in which the audio channel handle will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_BOARD on page 62 Board instance. MCHD_AUDIO_INPUT on page 62 Audio input. MCHD_AUDIO_SAMPLE_RATE on page 62 Audio sample rate. MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. Related function(s) MchdDeleteAudioChannel() on page 53 MchdRegisterAudioChannelCallback() on page 54 MchdStartAudioChannel() on page 56
MchdDeleteAudioChannel() MCHD_STATUS MCHD_API MchdDeleteAudioChannel(MCHD_AUDIO_CHANNEL channel);
53
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
Description Delete a channel previously created by MchdCreateAudioChannel.
Arguments Argument
Description
channel
Audio channel handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. Related function(s) MchdCreateAudioChannel() on page 53
MchdRegisterAudioChannelCallback() MCHD_STATUS MCHD_API MchdRegisterAudioChannelCallback(MCHD_AUDIO_CHANNEL channel, MCHD_AUDIO_CALLBACK callback, void *context);
Description Register an audio callback function and user context. Set callback to NULL to unregister.
Arguments Argument
Description
channel
Audio channel handle
callback
Function pointer to the function to be used as callback
context
Pointer to the argument to pass to the callback function
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. MCHD_AUDIO_CALLBACK on page 60
54
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook Related function(s) MchdStartAudioChannel() on page 56
MchdGetAudioChannelInput() MCHD_STATUS MCHD_API MchdGetAudioChannelInput(MCHD_AUDIO_CHANNEL channel, MCHD_AUDIO_INPUT *input);
Description Retrieve the input of the audio channel.
Arguments Argument
Description
channel
Audio channel handle
input
Pointer in which the audio input value will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic Audio/Video Interfaces on page 23 Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. MCHD_AUDIO_INPUT on page 62 Audio input. Related function(s) MchdGetAudioChannelSampleRate() on page 55
MchdGetAudioChannelSampleRate() MCHD_STATUS MCHD_API MchdGetAudioChannelSampleRate(MCHD_AUDIO_CHANNEL channel, MCHD_AUDIO_SAMPLE_RATE *sampleRate);
Description Retrieve the sample rate of the audio channel.
Arguments Argument
Description
channel
Audio channel handle
sampleRate
Pointer in which the sampling rate of the delivered digital audio will be returned
55
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. MCHD_AUDIO_SAMPLE_RATE on page 62 Audio sample rate. Related function(s) MchdGetAudioChannelInput() on page 55
MchdStartAudioChannel() MCHD_STATUS MCHD_API MchdStartAudioChannel(MCHD_AUDIO_CHANNEL channel);
Description Starts the audio channel.
Arguments Argument
Description
channel
Audio channel handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. Related function(s) MchdStopAudioChannel() on page 56
MchdStopAudioChannel() MCHD_STATUS MCHD_API MchdStopAudioChannel(MCHD_AUDIO_CHANNEL channel);
Description Stops the audio channel and waits until the acquisition thread(s) are done. Note: This function cannot be called from the callback function.
56
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Arguments Argument
Description
channel
Audio channel handle
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functions Group Audio Acquisition Functions Group on page 52 Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. Related function(s) MchdStartAudioChannel() on page 56
I/O Functions Group List of Functions Groups MCHD C API – Functions Groups on page 31 Functions Group Members MchdGetIoDirection() on page 57 MchdSetIoDirection() on page 58 MchdGetIoState() on page 59 MchdSetIoState() on page 60 Functions Group Members MchdGetIoDirection() on page 57 MchdSetIoDirection() on page 58 MchdGetIoState() on page 59 MchdSetIoState() on page 60
MchdGetIoDirection() MCHD_STATUS MCHD_API MchdGetIoDirection(MCHD_BOARD board, unsigned int ioIndex, MCHD_IO_DIRECTION *direction);
Description Retrieve the direction of the designated I/O port.
Arguments Argument
Description
board
Board handle
57
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
Argument
Description
ioIndex
I/O index {0-15}
direction
Pointer in which the I/O direction will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic I/O Functional Specifications on page 29 Functions Group I/O Functions Group on page 57 Functions Group I/O Functions Group on page 57 Datatype(s) MCHD_BOARD on page 62 Board instance. MCHD_IO_DIRECTION on page 63 Direction of the I/O port. Related function(s) MchdSetIoDirection() on page 58
MchdSetIoDirection() MCHD_STATUS MCHD_API MchdSetIoDirection(MCHD_BOARD board, unsigned int ioIndex, MCHD_IO_DIRECTION direction);
Description Set the direction of the designated I/O port.
Arguments Argument
Description
board
Board handle
ioIndex
I/O index {0-15}
direction
I/O direction
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic I/O Functional Specifications on page 29 Functions Group I/O Functions Group on page 57
58
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook Functions Group I/O Functions Group on page 57 Datatype(s) MCHD_BOARD on page 62 Board instance. MCHD_IO_DIRECTION on page 63 Direction of the I/O port. Related function(s) MchdGetIoDirection() on page 57
MchdGetIoState() MCHD_STATUS MCHD_API MchdGetIoState(MCHD_BOARD board, unsigned int ioIndex, MCHD_IO_STATE *state);
Description Retrieve the state of the designated I/O port.
Arguments Argument
Description
board
Board handle
ioIndex
I/O index {0-15}
state
Pointer in which the I/O state will be returned
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic I/O Functional Specifications on page 29 Functions Group I/O Functions Group on page 57 Functions Group I/O Functions Group on page 57 Datatype(s) MCHD_BOARD on page 62 Board instance. MCHD_IO_STATE on page 63 State of the I/O port. Related function(s) MchdSetIoState() on page 60
59
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MchdSetIoState() MCHD_STATUS MCHD_API MchdSetIoState(MCHD_BOARD board, unsigned int ioIndex, MCHD_IO_STATE state);
Description Set the state of the designated I/O port. If the I/O is set as an input, an error will be returned.
Arguments Argument
Description
board
Board handle
ioIndex
I/O index {0-15}
state
I/O state
Return Value Returned value is MCHD_STATUS_NO_ERROR when the function executes successfully. For a list of status/error codes, refer to MCHD_STATUS on page 63. Functional specification topic I/O Functional Specifications on page 29 Functions Group I/O Functions Group on page 57 Functions Group I/O Functions Group on page 57 Datatype(s) MCHD_BOARD on page 62 Board instance. MCHD_IO_STATE on page 63 State of the I/O port. Related function(s) MchdGetIoState() on page 59
Types Definitions MCHD_AUDIO_CALLBACK typedef void (MCHD_CALLING_CONVENTION *MCHD_AUDIO_CALLBACK)(const MCHD_AUDIO_CALLBACK_INFO *);
60
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
MCHD_AUDIO_CALLBACK_INFO Audio callback information structure definition. typedef struct MCHD_AUDIO_CALLBACK_INFO { void *context; MCHD_AUDIO_CHANNEL channel; MCHD_AUDIO_FRAME frame; } MCHD_AUDIO_CALLBACK_INFO;
Structure description
Member
Description
context
Pointer to the context passed as argument in the callback registering function
channel
Audio channel handle
frame
Audio frame
Datatype(s) MCHD_AUDIO_CHANNEL on page 61 Audio channel instance. MCHD_AUDIO_FRAME on page 61 Audio frame structure definition.
MCHD_AUDIO_CHANNEL Audio channel instance. typedef void *MCHD_AUDIO_CHANNEL;
MCHD_AUDIO_FRAME Audio frame structure definition. typedef struct MCHD_AUDIO_FRAME { unsigned char *data; unsigned int size; unsigned long long timestamp; } MCHD_AUDIO_FRAME;
Structure description
Member
Description
data
Pointer to the audio frame data buffer
size
Audio frame data buffer size, in bytes
timestamp
Audio frame time stamp
61
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MCHD_AUDIO_INPUT Audio input. typedef int MCHD_AUDIO_INPUT;
Identifier
Description
MCHD_AUDIO_INPUT_HDMI
Digital audio input on the HDMI connector
MCHD_AUDIO_INPUT_SDI
Digital audio input on the SDI connector
MCHD_AUDIO_INPUT_LINE_IN
Analog audio input on the COMPONENT connector
MCHD_AUDIO_SAMPLE_RATE Audio sample rate. typedef int MCHD_AUDIO_SAMPLE_RATE;
Identifier
Description
MCHD_AUDIO_SAMPLE_RATE_DEFAULT
Default sampling rate
MCHD_AUDIO_SAMPLE_RATE_32000
32 kHz sampling rate
MCHD_AUDIO_SAMPLE_RATE_44100
44.1 kHz sampling rate
MCHD_AUDIO_SAMPLE_RATE_48000
48 kHz sampling rate
MCHD_BOARD Board instance. typedef void *MCHD_BOARD;
MCHD_BOARD_TYPE Board type. typedef int MCHD_BOARD_TYPE;
62
Identifier
Description
MCHD_BOARD_TYPE_PICOLO_HD_ONE
PC 1840 Picolo HD One
MCHD_BOARD_TYPE_PICOLO_HD_3G
PC 1841 Picolo HD 3G
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Identifier
Description
MCHD_BOARD_TYPE_PICOLO_HD_H264
PC 1842 Picolo HD H.264
MCHD_IO_DIRECTION Direction of the I/O port. typedef int MCHD_IO_DIRECTION;
Identifier
Description
MCHD_IO_DIRECTION_IN
Input port
MCHD_IO_DIRECTION_OUT
Output port
MCHD_IO_STATE State of the I/O port. typedef int MCHD_IO_STATE;
Identifier
Description
MCHD_IO_STATE_OPEN
Open
MCHD_IO_STATE_HIGH
High
MCHD_STATUS Success/failure status typedef int MCHD_STATUS;
All functions return an MCHD_STATUS indicating success or failure.
Identifier
Description
MCHD_STATUS_NO_ERROR
No error, the function executed successfully!
MCHD_STATUS_OTHER_ERROR
Internal error
MCHD_STATUS_INITIALIZE_FAILED
The driver initialization failed
MCHD_STATUS_NO_ACCESS
The application lacks access rights to fulfil the command.
MCHD_STATUS_BOARD_NOT_FOUND
No Picolo HD board found in the system
MCHD_STATUS_RESOURCE_IN_USE
The resource is already in use
MCHD_STATUS_CANNOT_START_CHANNEL
The acquisition channel cannot be started
MCHD_STATUS_CANNOT_STOP_CHANNEL
The acquisition channel cannot be stopped
63
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
Identifier
Description
MCHD_STATUS_INVALID_PARAMETER_VALUE
The parameter value is not valid
MCHD_STATUS_INVALID_HANDLE
The handle is invalid
MCHD_STATUS_INVALID_OEM_KEY
The OEM key is invalid
MCHD_STATUS_INVALID_BOARD_TYPE
The Board Type is invalid
MCHD_STATUS_INVALID_COLOR_FORMAT
The Color Format is invalid
MCHD_STATUS_VIDEO_SIGNAL_NOT_DETECTED
The video signal is not detected
MCHD_VIDEO_CALLBACK typedef void (MCHD_CALLING_CONVENTION *MCHD_VIDEO_CALLBACK)(const MCHD_VIDEO_CALLBACK_INFO *);
MCHD_VIDEO_CALLBACK_INFO Video callback information structure definition. typedef struct MCHD_VIDEO_CALLBACK_INFO { void *context; MCHD_VIDEO_CHANNEL channel; MCHD_VIDEO_SURFACE surface; } MCHD_VIDEO_CALLBACK_INFO;
Structure description
Member
Description
context
Pointer to the context passed as argument in the callback registering function
channel
Video channel handle
surface
Video surface
Datatype(s) MCHD_VIDEO_CHANNEL on page 64 Video channel instance. MCHD_VIDEO_SURFACE on page 67 Video surface structure definition.
MCHD_VIDEO_CHANNEL Video channel instance. typedef void *MCHD_VIDEO_CHANNEL;
64
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
MCHD_VIDEO_CHANNEL_VIDEO_PRESENCE Video signal prsence. typedef struct MCHD_VIDEO_CHANNEL_VIDEO_PRESENCE { MCHD_VIDEO_PRESENCE presence; unsigned int timeout; } MCHD_VIDEO_CHANNEL_VIDEO_PRESENCE;
Structure description
Member
Description
presence
Video presence indication
timeout
Datatype(s) MCHD_VIDEO_PRESENCE on page 66 Video signal presence.
MCHD_VIDEO_COLOR_FORMAT Data format of the delivered color video typedef int MCHD_VIDEO_COLOR_FORMAT;
Identifier
Description
MCHD_VIDEO_COLOR_FORMAT_DEFAULT
Default data format (see note)
MCHD_VIDEO_COLOR_FORMAT_YUYV
Uncompressed packed YUV 4:2:2 video FourCC code: YUYV
MCHD_VIDEO_COLOR_FORMAT_YV12
Uncompressed planar YUV 4:2:0 video FourCC code: YV12
MCHD_VIDEO_COLOR_FORMAT_H264
H.264 compressed video
Note: Assigning the MCHD_VIDEO_COLOR_FORMAT_DEFAULT value selects: • The YUYV format for Picolo HD One and Picolo HD 3G • The YV12 format for Picolo HD H.264 Note: Picolo HD One and Picolo HD 3G supports only one format: YUYV. Note: Picolo HD H.264 supports two formats: YV12 and H264.
65
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API
MCHD_VIDEO_INPUT Video input. typedef int MCHD_VIDEO_INPUT;
Identifier
Description
MCHD_VIDEO_INPUT_DEFAULT
Default video input (see note)
MCHD_VIDEO_INPUT_HDMI
HDMI video input
MCHD_VIDEO_INPUT_DVI_D
DVI-D digital video input
MCHD_VIDEO_INPUT_YPBPR
YPbPr analog components high-definition video input
MCHD_VIDEO_INPUT_DVI_A
DVI-A analog video input
MCHD_VIDEO_INPUT_SDI
HD-SDI or 3G-SDI digital video input
Note: Setting MCHD_VIDEO_INPUT_DEFAULT selects the video input on which a valid video signal is applied. Avoid using this value when video signals are applied to more than one input.
MCHD_VIDEO_PRESENCE Video signal presence. typedef int MCHD_VIDEO_PRESENCE;
Identifier
Description
MCHD_VIDEO_PRESENCE_ABSENT
No video signal are present on any video input.
MCHD_VIDEO_PRESENCE_PRESENT
A video signal is present on at least one video input.
MCHD_VIDEO_RESOLUTION Video resolution structure definition. typedef struct MCHD_VIDEO_RESOLUTION { unsigned int width; unsigned int height; } MCHD_VIDEO_RESOLUTION;
Structure description
66
Member
Description
width
Number of pixels per line
MultiCam for Picolo HD API 1841 Picolo HD 3G Handbook
Member
Description
height
Number of lines per frame
Identifier
Description
MCHD_VIDEO_RESOLUTION_NATIVE
The delivered video frames have the same width and the same height as the frames delivered by the video source.
Functional specification topic Audio/Video Delivery on page 27
MCHD_VIDEO_SIGNAL_STATE Video signal state typedef int MCHD_VIDEO_SIGNAL_STATE;
Identifier
Description
MCHD_VIDEO_SIGNAL_STATE_NO_SIGNAL
No or invalid video signal on the selected input.
MCHD_VIDEO_SIGNAL_STATE_PRESENT
Available and valid video signal on the selected input.
MCHD_VIDEO_SURFACE Video surface structure definition. typedef struct MCHD_VIDEO_SURFACE { unsigned char *data[3]; unsigned int size[3]; MCHD_VIDEO_RESOLUTION resolution; unsigned int pitch[3]; unsigned long long timestamp; MCHD_VIDEO_COLOR_FORMAT format; } MCHD_VIDEO_SURFACE;
Structure description
Member
Description
data[3]
Pointers to the video data buffers
size[3]
Size, expressed in bytes, of the video data buffers
resolution
Width and height of the delivered video frames, expressed in pixels
pitch[3]
Pitch, expressed in bytes, of the video data buffers
timestamp
Time stamp, expressed in units of 100 nanoseconds
format
Data format of the delivered video
Note: For YUV Planar video formats, such as YV12, each of the three video data buffers stores one color component. The 3 buffers contain respectively the Y, the V, and the U color components.
67
1841 Picolo HD 3G Handbook MultiCam for Picolo HD API Note: For YUV Packed video formats, such as YUY2, and for H.264 compressed formats, the video data is stored entirely into the first data buffer. The information for the second and third buffers is set to 0/NULL. Datatype(s) MCHD_VIDEO_RESOLUTION on page 66 Video resolution structure definition. MCHD_VIDEO_COLOR_FORMAT on page 65 Data format of the delivered color video
MCHD_VIDEO_SYNC_ON_GREEN_STATE Video Sync on Green State. typedef int MCHD_VIDEO_SYNC_ON_GREEN_STATE;
68
Identifier
Description
MCHD_VIDEO_SYNC_ON_GREEN_STATE_DISABLED
Sync on green is disabled
MCHD_VIDEO_SYNC_ON_GREEN_STATE_ENABLED
Sync on green is enabled
Kernel Streaming API 1841 Picolo HD 3G Handbook
Kernel Streaming API Board Identifiers These identifiers are used to identify a Picolo HD board:
Product
Identifier Name
Identifier Value
GUID_PicoloHDPropertySet
D1E5209F-68FD-4529-BEE0-5E7A1F47921C
GUID_PicoloHD264PropertySet
D1E5209F-68FD-4529-BEE0-5E7A1F47921A
1840 Picolo HD One 1841 Picolo HD 3G 1843 Picolo HD 3G DVI 1842 Picolo HD H.264
Property Access Procedure These steps must be followed to set or get a property of your Picolo HD board: 1. Retrieve the IMoniker representing the Picolo HD board; 2. Retrieve the IKsPorpertySet from the IMoniker (BindToObject with typeof(IKsPropertySet).GUID); 3. Choose the Kernel Streaming Identifier (KSI) corresponding to your board (GUID_PicoloHDPropertySet or GUID_PicoloHD264PropertySet); 4. Choose the right Kernel Streaming Property Identifier (KSPI); 5. Call the IKsPropertySet::Get or IKsPropertySet::Get method.
Get and Set methods
int Get(Guid guidPropSet, int dwPropID, IntPtr pInstanceData, int cbInstanceData, IntPtr pPropData, int cbPropData, out int pcbReturned); int Set(Guid guidPropSet, int dwPropID, IntPtr pInstanceData, int cbInstanceData, IntPtr pPropData, int cbPropData); When calling the Get and Set methods, make sure that parameters pInstanceData and cbInstanceData are set to IntPtr.Zero and 0 respectively. Note: You can find examples of how to call these methods in the PicoloHDIKsWrapper object included with the sample.
69
1841 Picolo HD 3G Handbook Kernel Streaming API
Custom Property Identifiers De-interlacing Property Characteristic Name
Deinterlacing
Identifier
200
Logical Type
Long
PicoloHDIKsWrapper
N/A
Access
RW
Description
De-interlacing mode
Property Value 0
Off
1
Median Weakest
2
Median Weak
3
Median Strong
4
Median Strongest
5
Advanced Median Weakest
6
Advanced Median Weak
7
Advanced Median Strong
8
Advanced Median Strongest
Video Input Property Characteristic
70
Name
Video_Input
Identifier
201
Logical Type
Long
PicoloHDIKsWrapper
PicoloHD_VideoInput
Access
RW
Kernel Streaming API 1841 Picolo HD 3G Handbook
Property Characteristic Description
Video input connector
Property Value -1
Default
0
HDMI
1
DVI D
2
YPBPR
3
DVI A
4
SDI
5
Composite
6
S-Video
Frame Rate Property Characteristic Name
Framerate
Identifier
208
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
R
Description
Frame rate expressed in frames per second
Property Value Up to 60
Depends on the board and resolution
Resolution Property Characteristic Name
Resolution
Identifier
210
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
R
71
1841 Picolo HD 3G Handbook Kernel Streaming API
Property Characteristic Width and height of the image expressed in pixels Description
• Width is coded in the first 16 bits • Height is coded in the last 16 bits
Property Value Up to 1920 * 1080
Depends on the board and frame rate
Denoising Property Characteristic Name
Denoising
Identifier
217
Logical Type
int
PicoloHDIKsWrapper
N/A
Access
RW
Description
Strength of the de-noising filter
Property Value 0
Off
1
Weak
2
Strong
3
Strongest
Video Flexible Resolution Property Characteristic
72
Name
VideoFlexibleResolution
Identifier
220
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
RW
Kernel Streaming API 1841 Picolo HD 3G Handbook
Property Characteristic Description
Enable video resizing
Property Value 1
Enable video resizing
Sync On Green Property Characteristic Name
syncOnGreen
Identifier
234
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
RW
Description
Sync on the green component of the analog video signal (DVI-A input)
Property Value 0
Disable sync on green
1
Enable sync on green
Analog Audio Input Type Property Characteristic Name
AnalogAudioInputType
Identifier
255
Logical Type
int
PicoloHDIKsWrapper
N/A
Access
RW
Description
Type of analog audio input.
Property Value 0
Embedded audio. (Only valid for SDI and HDMI inputs)
1
Line input.
73
1841 Picolo HD 3G Handbook Kernel Streaming API
H.264 Encoder Bit Rate Property Characteristic Name
H264Encoder_BitRate
Identifier
403
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
RW
Description
Encoder bit rate expressed in bits/second.
Property Value 131,072
Minimum value (128 Kbit/s)
12,582,912
Maximum value (12 Mbit/s)
H.264 Encoder Bit Rate Mode Property Characteristic Name
H264Encoder_BRMode
Identifier
407
Logical Type
ulong
PicoloHDIKsWrapper
PicoloHD_EncoderBitRateMode
Access
RW
Description
H.264 encoder bit rate control mode
Property Value 0
Variable Bit Rate
1
Constant Bit Rate
H.264 Encoder Profile Property Characteristic
74
Name
H264Encoder_Profile
Identifier
412
Logical Type
long
Kernel Streaming API 1841 Picolo HD 3G Handbook
Property Characteristic PicoloHDIKsWrapper
PicoloHD_EncoderProfile
Access
RW
Description
H.264 encoder profile
Property Value 0
Main profile
1
Baseline profile
Privacy Mask Property Characteristic Name
PrivacyMask
Identifier
890 Struct { Uint index;
Logical Type
Ushort y; Ushort x; Uint width; Uint height; }
PicoloHDIKsWrapper
PicoloHD_EncoderProfile
Access
RW Privacy mask properties:
Description
• • • • •
Index Y Origin (Aligned on 16 bytes) X Origin (Aligned on 16 bytes) Width (Aligned on 16 bytes) Height (Aligned on 16 bytes)
Property Value 0
If x, y, width, height are all 0, the mask is removed.
H.264 OSD Text Path Property Characteristic Name
H264OSD_Text_Path
Identifier
921, 922, 923, 924
Logical Type
byte[16]
75
1841 Picolo HD 3G Handbook Kernel Streaming API
Property Characteristic PicoloHDIKsWrapper
N/A
Access
W Bytes 1 to 16 of the OSD text path
Description
Bytes 17 to 32 of the OSD text path Bytes 33 to 48 of the OSD text path Bytes 49 to 64 of the OSD text path
To set an OSD text on the image, you have to create a text file that contains the text you want on your image and pass the path to that file to the KsPropertySet. The path can be maximum 63 character long (64 with the null terminated character) and must be passed in chunks of 16 characters each.
Example The text you want to show: “Hello World” The file path containing “Hello World”: “C:\Users\Public\Documents\PicoloHD\OSD File Sample.txt”. Values to pass to each Identifier: 921 : [‘C’, ’:’, ’\’, ‘U’, ‘s’, ‘e’, ‘r’, ‘s, ‘\’, ‘P’, ‘u’, ‘b’, ‘l’, ‘I’, ‘c’, ‘\’] 922 : ['D', 'o', 'c', 'u', 'm', 'e', 'n', 't', 's', '\', 'P', 'i', 'c', 'o', 'l', 'o'] 923 : ['H', 'D', '\', 'O', 'S', 'D', ' ', 'F', 'i', 'l', 'e', ' ', 'S', 'a', 'm', 'p'] 924 : ['l', 'e', '.', 't', 'x', 't', 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
I/O Direction Property Characteristic Name
IODirection
Identifier
940
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
RW
Description
I/O Direction
Property Value 0
Output
1
Input
I/O State Property Characteristic Name
76
IOState
Kernel Streaming API 1841 Picolo HD 3G Handbook
Property Characteristic Identifier
941
Logical Type
uint
PicoloHDIKsWrapper
N/A
Access
RW
Description
I/O Direction
Property Value 0
High
1
Open
77
1841 Picolo HD 3G Handbook Appendix
Appendix MultiCam for Picolo HD Driver Installation Note: Picolo HD 3G DVI and Picolo HD One since S/N PHO01436 require Version 3.0 or higher of the driver. The MultiCam for Picolo HD driver is distributed on the Euresys website: www.euresys.com. The first time access requires a profile creation to obtain a user ID and a password. Once the package is downloaded, run the executable to launch the installer tool. If you have an existing MultiCam for Picolo HD driver already installed, you will be prompted to uninstall it before being able to continue. Otherwise, the tool prompts you for the selection of the destination folder.
Figure 12: Destination Folder Dialog Box Note: The default installation folder is: • C:\Program Files (x86)\Euresys\MultiCamForPicoloHD for 64-bit Windows versions. • C:\Program Files\Euresys\MultiCamForPicoloHD for 32-bit Windows versions. The tool Installs the device driver(s) for all the Picolo HD cards present in the system. However, before effective driver installation, you may have to acknowledge the Windows Security dialog box:
Figure 13: Example of Security Dialog Box for Picolo HD One
78
Appendix 1841 Picolo HD 3G Handbook
DirectShow Filter Graph Setup Example This topic describes the procedure to create a filter graph with 1 audio and 3 video filters for a Picolo HD H.264 card using GraphEdit. 1. Select the "Picolo HD H.264, Video Capture" filter among the WDM Streaming Capture Devices filter list.
Figure 14: Filter selection 2. Insert three instances of the "Picolo HD H.264, Video Capture" filter in the graph. 3. Configure the Properties of each Video Capture Filter instance as follows: a) In the "Custom Properties" tab: select the HDMI Video Input
Figure 15: Video Capture Filter Properties - Custom Properties Tab b) In the "Video Decoder" tab, select the Video Standard. . • For high-definition video sources, select Unknown
79
1841 Picolo HD 3G Handbook Appendix
Figure 16: Video Capture Filter Properties - Video Decoder Tab 4. Configure the Video Capture Pin Properties of each Video Capture Filter instance as follows: a) In the "Stream Format" tab: select the adequate Color Space/Compression setting: • YV12 for the first filter instance • H.264 for the second filter instance • X.264 for the third filter instance
Figure 17: Video Capture Pin Properties - Stream Format Tab - Color space/Compression Box b) In the "Stream Format" tab: select the adequate Output Size setting • 1920 x 1080 for the YV12 and H.264 pins • 960 x 540 for the X264 pin Note: The output size of YV12 and H.264 pin must match the source resolution (1920 x 1080 in this example) Note: The output size of X.264 pin must match the source resolution scaled-down by 2.
80
Appendix 1841 Picolo HD 3G Handbook
Figure 18: Video Capture Pin Properties - Stream Format Tab - Output Size Box 5. Select the "Picolo HD H.264, Audio Capture" filter among the WDM Streaming Capture Devices filter list. 6. Insert one instance of the "Picolo HD H.264, Audio Capture" filter in the graph. 7. Render the 3 video capture pins and the audio capture pin.
Figure 19: Filter Graph
Precautions for Use of Board Products Electrostatic Sensitive Device Boards may be damaged by electrostatic discharges. Follow the procedure hereby described and apply any general procedure aimed at reducing the risk associated with electrostatic discharge. Damage caused by improper handling is not covered by the manufacturer's warranty. Electromagnetic Compatibility Euresys boards are compliant with electromagnetic compatibility regulatory requirements. To ensure this compliance, the card bracket must be secured with the relevant screw in accordance with the procedure described herein.
81
1841 Picolo HD 3G Handbook Appendix
Risk of Electrical Shock Do not operate the computer with any enclosure cover removed. During the hardware installation, ensure the AC power cord is unplugged before touching any internal part of the computer. Heating Device It is normal for a board to dissipate some heat during operation. All enclosure covers, including blank brackets, must be fitted correctly to ensure that the fan cools the computer adequately. Hot Plugging Forbidden Uncontrolled plugging and unplugging of equipment may damage a board. Always switch off the computer and any relevant system device when connecting or disconnecting a cable at the frame grabber or auxiliary board bracket. Failure to do so may damage the card and will void the warranty. Poor Grounding Protection The computer and the camera can be located in distant areas with individual ground connections. Poor ground interconnection, ground loop or ground fault may induce unwanted voltage between equipment, causing excessive current in the interconnecting cables. This faulty situation can damage the frame grabber or the camera electrical interface. The user must follow proper equipment grounding practices at all ends of the interconnecting cables. In addition, the use of cable assemblies with overall shield solidly connected to the conductive shell of all connectors is recommended. Besides the beneficial effect of cable shielding on electromagnetic compatibility, the shield connection can increase the protection level against grounding problems by temporarily absorbing unwanted fault current.
82