d8/d0f/ntv2devicefeatures_8h_source.html

/* SPDX-License-Identifier: MIT */

#ifndef NTV2DEVICEFEATURES_H

#define NTV2DEVICEFEATURES_H


#if defined(AJALinux) || defined(AJA_LINUX)

    // For size_t

    #ifdef __KERNEL__

        #include <linux/stddef.h>

    #else

        #include <stddef.h>

    #endif

#endif

#include "ajaexport.h"

#include "ajatypes.h"

#include "ntv2enums.h"

#if defined(__CPLUSPLUS__) || defined(__cplusplus)

#elif !defined(NTV2_BUILDING_DRIVER)

    #define false (0)

    #define true (!false)

#endif


typedef enum _NTV2BoolParamID

{

    kNTV2BoolParam_FIRST        = 0,

    kDeviceCanChangeEmbeddedAudioClock = kNTV2BoolParam_FIRST,

    kDeviceCanChangeFrameBufferSize,

    kDeviceCanDisableUFC,

    kDeviceCanDo2KVideo,

    kDeviceCanDo3GLevelConversion,

    kDeviceCanDoRGBLevelAConversion,

    kDeviceCanDo425Mux,

    kDeviceCanDo4KVideo,

    kDeviceCanDoAESAudioIn,

    kDeviceCanDoAnalogAudio,

    kDeviceCanDoAnalogVideoIn,

    kDeviceCanDoAnalogVideoOut,

    kDeviceCanDoAudio2Channels,

    kDeviceCanDoAudio6Channels,

    kDeviceCanDoAudio8Channels,

    kDeviceCanDoAudio96K,

    kDeviceCanDoAudioDelay,

    kDeviceCanDoBreakoutBox,

    kDeviceCanDoCapture,

    kDeviceCanDoColorCorrection,

    kDeviceCanDoCustomAnc,

    kDeviceCanDoDSKOpacity,

    kDeviceCanDoDualLink,

    kDeviceCanDoDVCProHD,

    kDeviceCanDoEnhancedCSC,

    kDeviceCanDoFrameStore1Display,

    kDeviceCanDoFreezeOutput,

    kDeviceCanDoHDMIOutStereo,

    kDeviceCanDoHDV,

    kDeviceCanDoHDVideo,

    kDeviceCanDoIsoConvert,

    kDeviceCanDoLTC,

    kDeviceCanDoLTCInOnRefPort,

    kDeviceCanDoMSI,

    kDeviceCanDoMultiFormat,

    kDeviceCanDoPCMControl,

    kDeviceCanDoPCMDetection,

    kDeviceCanDoPIO,

    kDeviceCanDoPlayback,

    kDeviceCanDoProgrammableCSC,

    kDeviceCanDoProgrammableRS422,

    kDeviceCanDoProRes,

    kDeviceCanDoQREZ,

    kDeviceCanDoQuarterExpand,

    kDeviceCanDoRateConvert,

    kDeviceCanDoRGBPlusAlphaOut,

    kDeviceCanDoRP188,

    kDeviceCanDoSDVideo,

    kDeviceCanDoSDIErrorChecks,

    kDeviceCanDoStackedAudio,

    kDeviceCanDoStereoIn,

    kDeviceCanDoStereoOut,

    kDeviceCanDoThunderbolt,

    kDeviceCanDoVideoProcessing,

    kDeviceCanMeasureTemperature,

    kDeviceCanReportFrameSize,

    kDeviceHasBiDirectionalSDI,

    kDeviceHasColorSpaceConverterOnChannel2,

    kDeviceHasNWL,

    kDeviceHasPCIeGen2,

    kDeviceHasRetailSupport,

    kDeviceHasSDIRelays,

    kDeviceHasSPIFlash,

    kDeviceHasSPIFlashSerial,

    kDeviceHasSPIv2,

    kDeviceHasSPIv3,

    kDeviceHasSPIv4,

    kDeviceIs64Bit,

    kDeviceIsDirectAddressable,

    kDeviceIsExternalToHost,

    kDeviceIsSupported,

    kDeviceNeedsRoutingSetup,

    kDeviceSoftwareCanChangeFrameBufferSize,

    kDeviceCanThermostat,

    kDeviceHasHEVCM31,

    kDeviceHasHEVCM30,

    kDeviceCanDoVITC2,

    kDeviceCanDoHDMIHDROut,

    kDeviceCanDoJ2K,

    kDeviceCanDo12gRouting,

    kDeviceCanDo12GSDI,

    kDeviceCanDo2110,

    kDeviceCanDo8KVideo,

    kDeviceCanDoAudio192K,

    kDeviceCanDoAudioMixer,

    kDeviceCanDoCustomAux,

    kDeviceCanDoFramePulseSelect,

    kDeviceCanDoHDMIMultiView,

    kDeviceHasMultiRasterWidget,

    kDeviceCanDoHFRRGB,

    kDeviceCanDoIP,

    kDeviceCanDoMultiLinkAudio,

    kDeviceCanDoWarmBootFPGA,

    kDeviceCanReportFailSafeLoaded,

    kDeviceCanReportRunningFirmwareDate,

    kDeviceHasAudioMonitorRCAJacks,

    kDeviceHasBiDirectionalAnalogAudio,

    kDeviceHasGenlockv2,

    kDeviceHasGenlockv3,

    kDeviceHasHeadphoneJack,

    kDeviceHasLEDAudioMeters,

    kDeviceHasRotaryEncoder,

    kDeviceHasSPIv5,

    kDeviceHasXilinxDMA,

    kDeviceHasMicrophoneInput,

    kDeviceCanDoBreakoutBoard,

    kDeviceHasBreakoutBoard,

    kDeviceAudioCanWaitForVBI,

    kDeviceHasNTV4FrameStores,

    kDeviceHasXptConnectROM,

    kNTV2BoolParam_LAST,

    kNTV2BoolParam_COUNT    = kNTV2BoolParam_LAST-kNTV2BoolParam_FIRST,

    kDeviceCanDo_INVALID    = kNTV2BoolParam_LAST

} NTV2BoolParamID;


#define NTV2_IS_VALID_BOOLPARAMID(__x__)        ((__x__) >= kNTV2BoolParam_FIRST  &&  (__x__) < kNTV2BoolParam_LAST)


typedef enum _NTV2NumericParamID

{

    kNTV2NumericParam_FIRST     = 2000,

    kDeviceGetActiveMemorySize  = kNTV2NumericParam_FIRST,

    kDeviceGetDACVersion,

    kDeviceGetDownConverterDelay,

    kDeviceGetHDMIVersion,

    kDeviceGetLUTVersion,

    kDeviceGetMaxAudioChannels,

    kDeviceGetMaxRegisterNumber,

    kDeviceGetMaxTransferCount,

    kDeviceGetNumDMAEngines,

    kDeviceGetNumVideoChannels,

    kDeviceGetPingLED,

    kDeviceGetUFCVersion,

    kDeviceGetNum4kQuarterSizeConverters,

    kDeviceGetNumAESAudioInputChannels,

    kDeviceGetNumAESAudioOutputChannels,

    kDeviceGetNumAnalogAudioInputChannels,

    kDeviceGetNumAnalogAudioOutputChannels,

    kDeviceGetNumAnalogVideoInputs,

    kDeviceGetNumAnalogVideoOutputs,

    kDeviceGetNumAudioSystems,

    kDeviceGetNumCrossConverters,

    kDeviceGetNumCSCs,

    kDeviceGetNumDownConverters,

    kDeviceGetNumEmbeddedAudioInputChannels,

    kDeviceGetNumEmbeddedAudioOutputChannels,

    kDeviceGetNumFrameStores,

    kDeviceGetNumFrameSyncs,

    kDeviceGetNumHDMIAudioInputChannels,

    kDeviceGetNumHDMIAudioOutputChannels,

    kDeviceGetNumHDMIVideoInputs,

    kDeviceGetNumHDMIVideoOutputs,

    kDeviceGetNumInputConverters,

    kDeviceGetNumLUTs,

    kDeviceGetNumMixers,

    kDeviceGetNumOutputConverters,

    kDeviceGetNumReferenceVideoInputs,

    kDeviceGetNumSerialPorts,

    kDeviceGetNumUpConverters,

    kDeviceGetNumVideoInputs,

    kDeviceGetNumVideoOutputs,

    kDeviceGetNum2022ChannelsSFP1,

    kDeviceGetNum2022ChannelsSFP2,

    kDeviceGetNumLTCInputs,

    kDeviceGetNumLTCOutputs,

    kDeviceGetNumMicInputs,

    kDeviceGetNumLUTBanks,

    kDeviceGetTotalNumAudioSystems,

    kDeviceGetNumBufferedAudioSystems,

    kDeviceGetNumTSIMuxers,

    kNTV2NumericParam_LAST,

    kNTV2NumericParam_COUNT = kNTV2NumericParam_LAST-kNTV2NumericParam_FIRST,

    kDeviceGetNum_INVALID   = kNTV2NumericParam_LAST

} NTV2NumericParamID;


#define NTV2_IS_VALID_NUMPARAMID(__x__)     ((__x__) >= kNTV2NumericParam_FIRST  &&  (__x__) < kNTV2NumericParam_LAST)


typedef enum _NTV2EnumsID

{

    kNTV2EnumsID_FIRST,

    kNTV2EnumsID_DeviceID = kNTV2EnumsID_FIRST,

    kNTV2EnumsID_Standard,

    kNTV2EnumsID_PixelFormat,

    kNTV2EnumsID_FrameGeometry,

    kNTV2EnumsID_FrameRate,

    kNTV2EnumsID_ScanGeometry,

    kNTV2EnumsID_VideoFormat,

    kNTV2EnumsID_Mode,

    kNTV2EnumsID_InputSource,

    kNTV2EnumsID_OutputDest,

    kNTV2EnumsID_Channel,

    kNTV2EnumsID_RefSource,

    kNTV2EnumsID_AudioRate,

    kNTV2EnumsID_AudioSource,

    kNTV2EnumsID_WidgetID,

    kNTV2EnumsID_ConversionMode,

    kNTV2EnumsID_DSKMode,

    kNTV2EnumsID_LAST,

    kNTV2EnumsID_COUNT      = kNTV2EnumsID_LAST-kNTV2EnumsID_FIRST,

    kNTV2EnumsID_INVALID    = kNTV2EnumsID_LAST,

} NTV2EnumsID;


#define NTV2_IS_VALID_ENUMSID(__x__)        ((__x__) >= kNTV2EnumsID_FIRST  &&  (__x__) < kNTV2EnumsID_LAST)


//  Most of the device features functions are generated from a Python script.

//  The script writes the implementations into 'ntv2devicefeatures.hpp', and the declarations into 'ntv2devicefeatures.hh'...

#include "ntv2devicefeatures.hh"


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

extern "C"

{

#endif

/*

    @return True if the device having the given ID can do audio output;  otherwise false.

    @param[in]  inDeviceID  Specifies the NTV2DeviceID of the device of interest.

*/

AJAExport bool NTV2DeviceCanDoAudioOut(const NTV2DeviceID inDeviceID);

/*

    @return True if the device having the given ID can do audio input;  otherwise false.

    @param[in]  inDeviceID  Specifies the NTV2DeviceID of the device of interest.

*/

AJAExport bool NTV2DeviceCanDoAudioIn(const NTV2DeviceID inDeviceID);


AJAExport bool NTV2DeviceCanDo292Out(NTV2DeviceID boardID, UWord index0);

AJAExport bool NTV2DeviceCanDo3GOut (NTV2DeviceID boardID, UWord index0);

AJAExport bool NTV2DeviceCanDo12GOut(NTV2DeviceID boardID, UWord index0);

AJAExport bool NTV2DeviceCanDo292In(NTV2DeviceID boardID, UWord index0);

AJAExport bool NTV2DeviceCanDo3GIn(NTV2DeviceID boardID, UWord index0);

AJAExport bool NTV2DeviceCanDo12GIn(NTV2DeviceID boardID, UWord index0);

AJAExport bool NTV2DeviceCanDoLTCEmbeddedN (NTV2DeviceID boardID, UWord index0);


AJAExport bool NTV2DeviceCanDoOutputDestination (const NTV2DeviceID inDeviceID, const NTV2OutputDestination inOutputDest);


AJAExport UWord Get8MBFrameSizeFactor (const NTV2FrameGeometry inFG, const NTV2FrameBufferFormat inFBF);


AJAExport bool NTV2DeviceCanDoColorCorrection (const NTV2DeviceID inDeviceID);


AJAExport bool NTV2DeviceCanDoProgrammableCSC (const NTV2DeviceID inDeviceID);


// Overloading not supported by the ANSI C compiler used for Linux drivers.

//

// TODO: Audit all platforms and switch all the original calls to the _Ex

// versions.

#if (defined(__CPLUSPLUS__) || defined(__cplusplus)) && !defined(NTV2_BUILDING_DRIVER)

    AJAExport ULWord NTV2DeviceGetFrameBufferSize(NTV2DeviceID boardID);        //  Revisit for 2MB granularity

    AJAExport ULWord NTV2DeviceGetNumberFrameBuffers(NTV2DeviceID boardID);     //  Revisit for 2MB granularity

    AJAExport ULWord NTV2DeviceGetAudioFrameBuffer(NTV2DeviceID boardID);       //  Revisit for 2MB granularity

    AJAExport ULWord NTV2DeviceGetAudioFrameBuffer2(NTV2DeviceID boardID);      //  Revisit for 2MB granularity

#else

    AJAExport ULWord NTV2DeviceGetFrameBufferSize_Ex(NTV2DeviceID boardID);     //  Revisit for 2MB granularity

    AJAExport ULWord NTV2DeviceGetNumberFrameBuffers_Ex(NTV2DeviceID boardID);  //  Revisit for 2MB granularity

    AJAExport ULWord NTV2DeviceGetAudioFrameBuffer_Ex(NTV2DeviceID boardID);    //  Revisit for 2MB granularity

#endif


AJAExport ULWord NTV2DeviceGetNumberVideoFrameBuffers(NTV2DeviceID inDeviceID, NTV2FrameGeometry inFrameGeometry, NTV2Framesize inFramesize);

AJAExport ULWord NTV2DeviceGetFrameBufferSize(NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat);    //  Revisit for 2MB granularity

AJAExport ULWord NTV2DeviceGetNumberFrameBuffers(NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat); //  Revisit for 2MB granularity

AJAExport ULWord NTV2DeviceGetAudioFrameBuffer(NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat);   //  Revisit for 2MB granularity

AJAExport ULWord NTV2DeviceGetAudioFrameBuffer2(NTV2DeviceID boardID, NTV2FrameGeometry frameGeometry, NTV2FrameBufferFormat frameFormat);  //  Revisit for 2MB granularity


AJAExport bool NTV2DeviceGetVideoFormatFromState (  NTV2VideoFormat *       pOutValue,

                                                    const NTV2FrameRate     inFrameRate,

                                                    const NTV2FrameGeometry inFrameGeometry,

                                                    const NTV2Standard      inStandard,

                                                    const ULWord            inIsSMPTE372Enabled);


AJAExport bool NTV2DeviceGetVideoFormatFromState_Ex (   NTV2VideoFormat *       pOutValue,

                                                        const NTV2FrameRate     inFrameRate,

                                                        const NTV2FrameGeometry inFrameGeometry,

                                                        const NTV2Standard      inStandard,

                                                        const ULWord            inIsSMPTE372Enabled,

                                                        const bool              inIsProgressivePicture);


AJAExport bool NTV2DeviceGetVideoFormatFromState_Ex2 (  NTV2VideoFormat *       pOutValue,

                                                        const NTV2FrameRate     inFrameRate,

                                                        const NTV2FrameGeometry inFrameGeometry,

                                                        const NTV2Standard      inStandard,

                                                        const ULWord            inIsSMPTE372Enabled,

                                                        const bool              inIsProgressivePicture,

                                                        const bool              inIsSquareDivision);

#if !defined(NTV2_DEPRECATE_17_0)

    //  In SDK 17.0, these were all replaced by NTV2DeviceGetSPIFlashVersion:

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasSPIv2(const NTV2DeviceID inDeviceID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasSPIv3(const NTV2DeviceID inDeviceID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasSPIv4(const NTV2DeviceID inDeviceID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasSPIv5(const NTV2DeviceID inDeviceID);)


    //  In SDK 17.0, these were replaced by NTV2DeviceGetGenlockVersion...

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasGenlockv2(const NTV2DeviceID devID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasGenlockv3(const NTV2DeviceID devID);)


    //  In SDK 17.0, this was replaced by NTV2DeviceCanDoWidget(NTV2_WgtCSC2)...

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceHasColorSpaceConverterOnChannel2(const NTV2DeviceID devID);)


    //  In SDK 17.0, these were replaced by NTV2GetMaxNumAudioChannels:

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoAudio2Channels(const NTV2DeviceID devID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoAudio6Channels(const NTV2DeviceID devID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoAudio8Channels(const NTV2DeviceID devID);)


    //  These have been marked deprecated for some time. In SDK 17.0, it's official.

    AJAExport NTV2_DEPRECATED_f(UWord NTV2DeviceGetNumAudioStreams(const NTV2DeviceID devID);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoAudioN(const NTV2DeviceID devID, UWord index0);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoLTCOutN(const NTV2DeviceID devID, UWord index0);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoLTCInN(const NTV2DeviceID devID, UWord index0);)

    AJAExport NTV2_DEPRECATED_f(bool NTV2DeviceCanDoRS422N(const NTV2DeviceID devID, const NTV2Channel ch);)

#endif  //  NTV2_DEPRECATE_17_0


bool work_around_erroneous_compiler_warning (void); //  This declaration stops erroneous deprecation warnings for NTV2DeviceCanDoTCIndex (immediately below)

AJAExport bool NTV2DeviceCanDoTCIndex (const NTV2DeviceID inDeviceID, const NTV2TCIndex inTCIndex);

AJAExport bool NTV2DeviceCanDoInputTCIndex (const NTV2DeviceID inDeviceID, const NTV2TCIndex inTCIndex);

AJAExport NTV2AudioSystem NTV2DeviceGetAudioMixerSystem(const NTV2DeviceID inDeviceID);

AJAExport NTV2AudioSystem NTV2DeviceGetHostAudioSystem(const NTV2DeviceID inDeviceID);

AJAExport bool NTV2DeviceROMHasBankSelect (const NTV2DeviceID inDeviceID);


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

}

#endif


#endif  //  NTV2DEVICEFEATURES_H