IHWIOHelper.h

Go to the documentation of this file.

 
#ifndef IHWIOHelper_h
#define IHWIOHelper_h
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum HWIOChannelModality
{
    HWIOChannelModalityNone = 0,        
    HWIOChannelModalityInput,           
    HWIOChannelModalityOutput,          
    HWIOChannelModalityInputAndOutput   
};
 
enum HWIOChannelConnectorType
{
    HWIOChannelConnectorTypeUnspecified = 0,    
    HWIOChannelConnectorTypeSDI,                
    HWIOChannelConnectorTypeHDMI,               
    HWIOChannelConnectorTypeEthernet            
};
 
enum HWIOChannelActivityStatus
{
    HWIOChannelActivityStatusOff = 0,       
    HWIOChannelActivityStatusOutput = 1,    
    HWIOChannelActivityStatusInput = 2,     
};
 
enum HWIOVideoResolution
{
    HWIOVideoResolutionUnspecified = 0,  
    HWIOVideoResolution720p,             
    HWIOVideoResolution1080p,            
    HWIOVideoResolution2160p             
};
 
enum HWIOVideoFrameRate
{
    HWIOVideoFrameRateUnspecified = 0,  
    HWIOVideoFrameRate25fps,            
    HWIOVideoFrameRate29_97fps,         
    HWIOVideoFrameRate30fps,            
    HWIOVideoFrameRate60fps,            
    HWIOVideoFrameRate50fps,            
    HWIOVideoFrameRate59_94fps,         
};
 
enum HWIOVideoFormat
{
    HWIOVideoFormatUnspecified = 0,     
    HWIOVideoFormatYUV420Limited,       
    HWIOVideoFormatYUV422UYVYLimited    
};
 
enum HWIOAudioSampleRate
{
    HWIOAudioSampleRateUnspecified = 0,     
    HWIOAudioSampleRate48000       = 48000  
};
 
enum HWIOAudioChannels
{
    HWIOAudioChannelsUnspecified = 0,   
    HWIOAudioChannelsMONO        = 1,   
    HWIOAudioChannelsStereo      = 2,   
    HWIOAudioChannelsFour        = 4,   
    HWIOAudioChannelsEight       = 8,   
    HWIOAudioChannelsSixteen     = 16,  
    HWIOAudioChannelsThirtyTwo   = 32   
};
 
enum HWIOAudioFormat
{
    HWIOAudioFormatUnspecified = 0,             
    HWIOAudioFormatLinearPCM16BitInterleaved    
};
 
enum HWIOVideoAssignmentType
{
    HWIOVideoAssignmentTypeUnassigned = 0,          
    HWIOVideoAssignmentTypeOutputFromUser,          
    HWIOVideoAssignmentTypeInputToVirtualInput,     
    HWIOVideoAssignmentTypeOutputTestSignal,        
    HWIOVideoAssignmentTypeOutputScreenShare,       
    HWIOVideoAssignmentTypeOutputActiveSpeaker,     
    HWIOVideoAssignmentTypeOutputPinGroup,          
    HWIOVideoAssignmentTypeOutputSpotlightGroup,    
    HWIOVideoAssignmentTypeOutputGalleryView        
};
 
enum HWIOAudioAssignmentType
{
    HWIOAudioAssignmentTypeUnassigned = 0,          
    HWIOAudioAssignmentTypeOutputFromUser,          
    HWIOAudioAssignmentTypeInputToVirtualInput,     
    HWIOAudioAssignmentTypeOutputMixedMinus         
};
 
enum HWIODeviceManufacturer
{
    HWIODeviceManufacturerUnspecified = 0,  
    HWIODeviceManufacturerBlackMagic,       
    HWIODeviceManufacturerAJA,              
    HWIODeviceManufacturerMagewell,         
    HWIODeviceManufacturerDeltacast         
};
 
enum HWIODeviceConnectionType
{
    HWIODeviceConnectionTypeUnspecified = 0,    
    HWIODeviceConnectionTypeThunderBolt,        
    HWIODeviceConnectionTypePcie,               
    HWIODeviceConnectionTypeUSB                 
};
 
enum HWIODeviceUpdateEventType
{
    HWIODeviceUpdateEventTypeDeviceAdded = 0,               
    HWIODeviceUpdateEventTypeDeviceRemoved = 1,             
    HWIODeviceUpdateEventTypeDeviceChanged = 2,             
    HWIODeviceUpdateEventTypeDeviceActivityStatus = 3,      
    HWIODeviceUpdateEventTypeDeviceDetectedInputSignal = 4, 
};
 
enum HWIODeviceResult
{
    HWIODeviceResultSuccess = 0,                    
    HWIODeviceResultInvalidDeviceID = 1,            
    HWIODeviceResultInvalidChannelID = 2,           
    HWIODeviceResultInvalidConfiguration = 3,       
    HWIODeviceResultInvalidAssignment = 4,          
    HWIODeviceResultDeviceInaccessible = 5,         
    HWIODeviceResultServiceUnavailable = 6,         
    HWIODeviceResultOperationNotAllowed = 7,        
    
    HWIODeviceResultUnknownError = 255              
};
 
enum HWIOVideoConvertPreferenceType
{
    HWIOVideoConvertPreferenceTypeUnknown = -1,     
    HWIOVideoConvertPreferenceTypeZoom = 0,         
    HWIOVideoConvertPreferenceTypeDevice = 1        
};
 
 
struct HWIOVideoSettings
{
    HWIOVideoResolution resolution = HWIOVideoResolutionUnspecified;    
    HWIOVideoFrameRate  frameRate = HWIOVideoFrameRateUnspecified;      
    HWIOVideoFormat     format = HWIOVideoFormatUnspecified;            
};
 
struct HWIOAudioSettings
{
    HWIOAudioSampleRate sampleRate = HWIOAudioSampleRateUnspecified;    
    HWIOAudioChannels   channels = HWIOAudioChannelsUnspecified;        
    HWIOAudioFormat     format = HWIOAudioFormatUnspecified;            
};
 
struct HWIOConfiguration
{
    HWIOVideoSettings videoSettings;    
    HWIOAudioSettings audioSettings;    
};
 
struct HWIODeviceConfiguration
{
    HWIOChannelModality modality = HWIOChannelModalityNone; 
    int32_t             deviceID = 0;                       
    int32_t             channelID = -1;                     
    HWIOConfiguration   configuration;                      
};
 
struct HWIOVideoAssignment
{
    HWIOVideoAssignmentType type = HWIOVideoAssignmentTypeUnassigned;   
    std::string             userGuid;                  
    uint32_t                virtualInputID = 0;        
    uint32_t                testSignalFrameRGB = 0;    
    uint32_t                screenShare = 0;           
    uint32_t                pinGroupScreen = 0;        
    uint32_t                galleryPage = 0;           
    GalleryGridSize         gridSize;                  
};
 
struct HWIOAudioAssignment
{
    HWIOAudioAssignmentType type = HWIOAudioAssignmentTypeUnassigned;   
    std::string             userGuid;              
    uint32_t                virtualInputID = 0;    
};
 
struct HWIOAssignmentStatus
{
    HWIOVideoAssignment videoAssignment;    
    HWIOAudioAssignment audioAssignment;    
};
 
struct HWIOAssignDeviceInfo
{
    int32_t                deviceID = 0;        
    int32_t                channelID = -1;      
    HWIOAssignmentStatus   assignmentStatus;    
};
 
struct HWIOChannelDetectedInputSignal
{
    std::string videoFormat;                    
    bool        videoFormatSupported = false;   
};
 
struct HWIOChannelInfo
{
    uint32_t                       channelID = 0;                       
    HWIOChannelModality            modality = HWIOChannelModalityNone;  
    HWIOChannelConnectorType       connectorType = HWIOChannelConnectorTypeUnspecified; 
    HWIOAssignmentStatus           assignmentStatus;                    
    HWIOConfiguration              inputConfiguration;                  
    HWIOConfiguration              outputConfiguration;                 
    std::vector<HWIOVideoSettings> supportedInputVideoSettings;         
    std::vector<HWIOVideoSettings> supportedOutputVideoSettings;        
    std::vector<HWIOAudioSettings> supportedInputAudioSettings;         
    std::vector<HWIOAudioSettings> supportedOutputAudioSettings;        
    std::string                    name;                                
    HWIOVideoConvertPreferenceType videoConvertPreferenceType = HWIOVideoConvertPreferenceTypeUnknown; 
    HWIOChannelActivityStatus      activityStatus = HWIOChannelActivityStatusOff;   
    HWIOChannelDetectedInputSignal detectedInputSignal;                  
};
 
struct HWIODeviceInfo
{
    uint32_t                     deviceID = 0;          
    HWIODeviceManufacturer       manufacturer = HWIODeviceManufacturerUnspecified;      
    HWIODeviceConnectionType     connectionType = HWIODeviceConnectionTypeUnspecified;  
    std::string                  name;                  
    std::string                  internalIdentifier;    
    std::string                  driverVersion;         
    std::vector<HWIOChannelInfo> channelInfos;          
    bool                         inputSignalDetectionSupported = false;  
    bool                         inputSignalDetectionEnabled = false;    
};
 
struct HWIOInfo
{
    std::vector<uint32_t>         virtualVideoInputIDs;         
    std::vector<uint32_t>         virtualAudioInputIDs;         
    std::vector<HWIODeviceInfo>   deviceInfos;                  
    bool                          isServiceAvailable = false;   
    bool                          isFeatureAllowed = false;     
};
 
struct HWIODeviceUpdate
{
    HWIODeviceUpdateEventType eventType = HWIODeviceUpdateEventTypeDeviceAdded; 
    HWIODeviceInfo            deviceInfo;                                       
    int32_t                   deviceID = 0;                                     
    int32_t                   channelID = -1;                                   
    HWIOChannelActivityStatus activityStatus = HWIOChannelActivityStatusOff;    
    HWIOChannelDetectedInputSignal detectedInputSignal;                         
};
 
struct HWIOVideoConvertPreference
{
    int32_t                        deviceID = 0;      
    int32_t                        channelID = -1;    
    HWIOVideoConvertPreferenceType type = HWIOVideoConvertPreferenceTypeUnknown; 
};
 
struct HWIOInputSignalDetection
{
    int32_t deviceID = 0;           
    bool    enable = false;         
};
 
class IHWIOHelperSink
{
public:
    virtual ~IHWIOHelperSink() {}
 
    virtual void OnHWIOListDevicesResult(int32_t result, const HWIOInfo& info, const std::string& companionZRID) = 0;
 
    virtual void OnHWIOConfigureDeviceResult(int32_t result, const HWIODeviceConfiguration& configuration, const std::string& companionZRID) = 0;
 
    virtual void OnHWIOAssignDeviceResult(int32_t result, const HWIOAssignDeviceInfo& assignDeviceInfo, const std::string& companionZRID) = 0;
 
    virtual void OnHWIODeviceUpdated(const HWIODeviceUpdate& deviceUpdate, const std::string& companionZRID) = 0;
 
    virtual void OnHWIOServiceStatusUpdated(bool isServiceAvailable, bool isFeatureAllowed, const std::string& companionZRID) = 0;
 
    virtual void OnHWIOSetVideoConvertPreferenceResult(int32_t result, const HWIOVideoConvertPreference& preference,
                                                       const std::string& companionZRID) = 0;
 
    virtual void OnHWIOSetInputSignalDetectionResult(int32_t result, const HWIOInputSignalDetection& signalDetection,
                                                     const std::string& companionZRID) = 0;
};
 
class IHWIOHelper
{
public:
    
    virtual ~IHWIOHelper() {}
 
    virtual ZRCSDKError RegisterSink(IHWIOHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IHWIOHelperSink* pSink) = 0;
 
    virtual ZRCSDKError ListHWIODevices(const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError ConfigureHWIODevice(const HWIODeviceConfiguration& configuration, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError AssignHWIODevice(const HWIOAssignDeviceInfo& assignDevice, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError IsHWIOServiceAvailable(bool& available, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError IsHWIOFeatureAllowed(bool& allow) = 0;
    
    virtual ZRCSDKError SetHWIOVideoConvertPreference(const HWIOVideoConvertPreference& preference, const std::string& companionZRID = "") = 0;
 
    virtual ZRCSDKError SetHWIOInputSignalDetection(const HWIOInputSignalDetection& signalDetection, const std::string& companionZRID = "") = 0;
};
 
NS_ZRCSDK_END
 
#endif /* ZRC_IHWIOHELPER_H */