ntv2vpidfromspec.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef NTV2VPIDFROMSPEC_H
#define NTV2VPIDFROMSPEC_H

#include "ajaexport.h"
#include "ntv2publicinterface.h"


typedef struct
{
    NTV2VideoFormat         videoFormat;            
    NTV2FrameBufferFormat   pixelFormat;            
    bool                    isRGBOnWire;            
    bool                    isOutputLevelA;         
    bool                    isOutputLevelB;         
    bool                    isDualLink;             
    bool                    isTwoSampleInterleave;  
    bool                    useChannel;             
    VPIDChannel             vpidChannel;            
    bool                    isStereo;               
    bool                    isRightEye;             
    VPIDAudio               audioCarriage;          
    bool                    isOutput6G;             
    bool                    isOutput12G;            
    bool                    enableBT2020;           
    NTV2VPIDTransferCharacteristics transferCharacteristics;    
    NTV2VPIDColorimetry     colorimetry;            
    NTV2VPIDLuminance       luminance;              
    NTV2VPIDRGBRange        rgbRange;               
    bool                    isMultiLink;            
} VPIDSpec;

typedef enum
{
    dualStreamFlag = BIT(0),
    output3GFlag = BIT(1),
    output3GbFlag = BIT(2),
    SMPTE425Flag = BIT(3),
    DC4KInPath = BIT(4),
    CSCInPath = BIT(5),
    KeySignal = BIT(6)
} VPIDFlags;

typedef struct
{
    VPIDSpec        vpidSpec;
    ULWord          deviceNumber;
    NTV2Channel     videoChannel;
    ULWord          frameStoreIndex;
    VPIDFlags       flags;
    bool            is3G;
    bool            isDS2;
    bool            isComplete;
    ULWord          value;
    bool            isDS1;
    bool            isML1;
    bool            isML2;
    bool            isML3;
    bool            isML4;
} VPIDControl;

#if defined(__cplusplus) && defined(NTV2_BUILDING_DRIVER)
extern "C"
{
#endif
AJAExport   bool    SetVPIDFromSpec (ULWord * const         pOutVPID,
                                     const VPIDSpec * const pInVPIDSpec);

#if defined(__cplusplus) && defined(NTV2_BUILDING_DRIVER)
}
#endif

#endif  // NTV2VPIDFROMSPEC_H