AJA NTV2 SDK  17.1.1.1245
NTV2 SDK 17.1.1.1245
ntv2vpidfromspec.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: MIT */
9 #ifndef NTV2VPIDFROMSPEC_H
10 #define NTV2VPIDFROMSPEC_H
11 
12 #include "ajaexport.h"
13 #include "ntv2publicinterface.h"
14 
19 
22 typedef struct
23 {
26  bool isRGBOnWire;
29  bool isDualLink;
31  bool useChannel;
33  bool isStereo;
34  bool isRightEye;
36  bool isOutput6G;
37  bool isOutput12G;
38  bool enableBT2020;
43  bool isMultiLink;
44 } VPIDSpec;
45 
46 typedef enum
47 {
52  DC4KInPath = 16,
53  CSCInPath = 32
54 } VPIDFlags;
55 
56 typedef struct
57 {
63  bool is3G;
64  bool isDS2;
65  bool isComplete;
67  bool isDS1;
68  bool isML1;
69  bool isML2;
70  bool isML3;
71  bool isML4;
72 } VPIDControl;
73 
80 #if defined(__cplusplus) && defined(NTV2_BUILDING_DRIVER)
81 extern "C"
82 {
83 #endif
84 AJAExport bool SetVPIDFromSpec (ULWord * const pOutVPID,
85  const VPIDSpec * const pInVPIDSpec);
86 
87 #if defined(__cplusplus) && defined(NTV2_BUILDING_DRIVER)
88 }
89 #endif
90 
91 #endif // NTV2VPIDFROMSPEC_H
92 
VPIDControl::isDS2
bool isDS2
Definition: ntv2vpidfromspec.h:64
VPIDControl::frameStoreIndex
ULWord frameStoreIndex
Definition: ntv2vpidfromspec.h:61
ajaexport.h
Defines the import/export macros for producing DLLs or LIBs.
VPIDSpec::transferCharacteristics
NTV2VPIDTransferCharacteristics transferCharacteristics
Describes the transfer characteristics.
Definition: ntv2vpidfromspec.h:39
dualStreamFlag
@ dualStreamFlag
Definition: ntv2vpidfromspec.h:48
VPIDSpec::isMultiLink
bool isMultiLink
If true, the video stream is 12G -> 3G multi-link.
Definition: ntv2vpidfromspec.h:43
VPIDSpec::videoFormat
NTV2VideoFormat videoFormat
Specifies the format of the video stream.
Definition: ntv2vpidfromspec.h:24
SMPTE425Flag
@ SMPTE425Flag
Definition: ntv2vpidfromspec.h:51
NTV2Channel
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They're also commonly use...
Definition: ntv2enums.h:1305
CSCInPath
@ CSCInPath
Definition: ntv2vpidfromspec.h:53
VPIDControl::deviceNumber
ULWord deviceNumber
Definition: ntv2vpidfromspec.h:59
VPIDSpec::isOutputLevelA
bool isOutputLevelA
If true, the video stream will leave the device as a level A signal.
Definition: ntv2vpidfromspec.h:27
NTV2VPIDLuminance
NTV2VPIDLuminance
Definition: ntv2enums.h:4178
VPIDSpec::isTwoSampleInterleave
bool isTwoSampleInterleave
If true, the video stream is in SMPTE 425-3 two sample interleave format.
Definition: ntv2vpidfromspec.h:30
NTV2FrameBufferFormat
NTV2FrameBufferFormat
Identifies a particular video frame buffer format. See Device Frame Buffer Formats for details.
Definition: ntv2enums.h:207
VPIDSpec::luminance
NTV2VPIDLuminance luminance
Describes the luminance and color difference.
Definition: ntv2vpidfromspec.h:41
VPIDSpec::isStereo
bool isStereo
If true, the video stream is part of a stereo pair.
Definition: ntv2vpidfromspec.h:33
VPIDControl::flags
VPIDFlags flags
Definition: ntv2vpidfromspec.h:62
VPIDSpec
Contains all the information needed to generate a valid VPID.
Definition: ntv2vpidfromspec.h:22
VPIDControl::is3G
bool is3G
Definition: ntv2vpidfromspec.h:63
VPIDSpec::vpidChannel
VPIDChannel vpidChannel
Specifies the channel number of the video stream.
Definition: ntv2vpidfromspec.h:32
VPIDControl::isDS1
bool isDS1
Definition: ntv2vpidfromspec.h:67
VPIDControl::isML2
bool isML2
Definition: ntv2vpidfromspec.h:69
SetVPIDFromSpec
bool SetVPIDFromSpec(ULWord *const pOutVPID, const VPIDSpec *const pInVPIDSpec)
Generates a VPID based on the supplied specification.
Definition: ntv2vpidfromspec.cpp:25
output3GbFlag
@ output3GbFlag
Definition: ntv2vpidfromspec.h:50
VPIDFlags
VPIDFlags
Definition: ntv2vpidfromspec.h:46
VPIDSpec::isOutputLevelB
bool isOutputLevelB
If true, the video stream will leave the device as a level B signal.
Definition: ntv2vpidfromspec.h:28
ULWord
uint32_t ULWord
Definition: ajatypes.h:253
VPIDControl::vpidSpec
VPIDSpec vpidSpec
Definition: ntv2vpidfromspec.h:58
VPIDControl::videoChannel
NTV2Channel videoChannel
Definition: ntv2vpidfromspec.h:60
output3GFlag
@ output3GFlag
Definition: ntv2vpidfromspec.h:49
VPIDControl::isML4
bool isML4
Definition: ntv2vpidfromspec.h:71
NTV2VPIDColorimetry
NTV2VPIDColorimetry
Definition: ntv2enums.h:4170
VPIDControl::isML1
bool isML1
Definition: ntv2vpidfromspec.h:68
VPIDSpec::isDualLink
bool isDualLink
If true, the video stream is part of a SMPTE 372 dual link signal.
Definition: ntv2vpidfromspec.h:29
VPIDSpec::enableBT2020
bool enableBT2020
If true, the VPID will insert BT.2020 data.
Definition: ntv2vpidfromspec.h:38
VPIDSpec::isRightEye
bool isRightEye
If true, the video stream is the right eye of a stereo pair.
Definition: ntv2vpidfromspec.h:34
VPIDSpec::isOutput12G
bool isOutput12G
If true, the transport on the wire is 12G.
Definition: ntv2vpidfromspec.h:37
VPIDSpec::rgbRange
NTV2VPIDRGBRange rgbRange
Describes the RGB range as full or SMPTE.
Definition: ntv2vpidfromspec.h:42
VPIDAudio
VPIDAudio
Definition: ntv2enums.h:4066
VPIDSpec::pixelFormat
NTV2FrameBufferFormat pixelFormat
Specifies the pixel format of the source of the video stream.
Definition: ntv2vpidfromspec.h:25
AJAExport
#define AJAExport
Definition: export.h:33
NTV2VideoFormat
enum _NTV2VideoFormat NTV2VideoFormat
Identifies a particular video format.
VPIDSpec::colorimetry
NTV2VPIDColorimetry colorimetry
Describes the Colorimetry.
Definition: ntv2vpidfromspec.h:40
VPIDSpec::isRGBOnWire
bool isRGBOnWire
If true, the transport on the wire is RGB.
Definition: ntv2vpidfromspec.h:26
NTV2VPIDTransferCharacteristics
NTV2VPIDTransferCharacteristics
Definition: ntv2enums.h:4162
VPIDControl::isComplete
bool isComplete
Definition: ntv2vpidfromspec.h:65
NTV2VPIDRGBRange
NTV2VPIDRGBRange
Definition: ntv2enums.h:4184
VPIDSpec::isOutput6G
bool isOutput6G
If true, the transport on the wire is 6G.
Definition: ntv2vpidfromspec.h:36
DC4KInPath
@ DC4KInPath
Definition: ntv2vpidfromspec.h:52
ntv2publicinterface.h
Declares enums and structs used by all platform drivers and the SDK.
VPIDControl::value
ULWord value
Definition: ntv2vpidfromspec.h:66
VPIDControl::isML3
bool isML3
Definition: ntv2vpidfromspec.h:70
VPIDSpec::audioCarriage
VPIDAudio audioCarriage
Specifies how audio is carried in additional channels.
Definition: ntv2vpidfromspec.h:35
VPIDControl
Definition: ntv2vpidfromspec.h:56
VPIDChannel
VPIDChannel
Definition: ntv2enums.h:4025
VPIDSpec::useChannel
bool useChannel
If true, the following vpidChannel value should be inserted into th VPID.
Definition: ntv2vpidfromspec.h:31