ntv2macpublicinterface.h File Reference

Declares MacOS-only enums used by the Mac driver and the SDK. More...

#include <IOKit/IOKitLib.h>
#include "ntv2virtualregisters.h"

Include dependency graph for ntv2macpublicinterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	AUDIO_MAX_SAMPLING_RATE_PER_MS   48

Enumerations
enum	UserClientCommandCodes {   kDriverReadRegister = 0, kDriverWriteRegister = 1, kDriverGetDrvrVersion = 2, kDriverStartDriver = 3,   kDriverAcquireStreamForApplication = 4, kDriverReleaseStreamForApplication = 5, kDriverSetStreamForApplication = 6, kDriverGetStreamForApplication = 7,   kDriverLockFormat = 8, kDriverSetAVSyncPattern = 9, kDriverTriggerAVSync = 10, kDriverWaitForInterrupt = 11,   kDriverGetInterruptCount = 12, kDriverWaitForChangeEvent = 13, kDriverGetTime = 14, kDriverDMATransfer = 15,   kDriverRestoreProcAmpRegisters = 16, kDriverSetBitFileInformation = 17, kDriverGetBitFileInformation = 18, kDriverSetDebugFilterStrings = 19,   kDriverGetDebugFilterStrings = 20, kDriverAutoCirculateControl = 21, kDriverAutoCirculateStatus = 22, kDriverAutoCirculateTransfer = 23,   kDriverAutoCirculateFramestamp = 24, kDriverSetDefaultDeviceForPID = 25, kDriverIsDefaultDeviceForPID = 26, kDriverSystemControl = 27,   kDriverSystemStatus = 28, kDriverDMATransferEx = 29, kDriverAcquireStreamForApplicationWithReference = 30, kDriverReleaseStreamForApplicationWithReference = 31,   kDriverKernelLog = 32, kDriverReadAudioBuffer = 33, kDriverNTV2Message = 34, kNumberUserClientCommands }
enum	MemoryType { kRegisterMemory, kFrameBufferMemory, kXena2FlashMemory, kNumberMemoryType }
enum	InterruptType {   kInterruptOutputVertical = 1, kInterruptInput1Vertical, kInterruptInput2Vertical, kInterruptAudio,   kInterruptAudioOutWrap, kInterruptAudioInWrap, kInterruptDMA1, kInterruptDMA2,   kInterruptDMA3, kInterruptDMA4 }
enum	DMAEngine {   kDMANone = 0, kDMA1 = 1, kDMA2 = 2, kDMA3 = 3,   kDMA4 = 4, kDMAAuto = 99 }
enum	{   kRegIoHDGlobalStatus = 2048, kRegIoHDGlobalControl = 2049, kRegLocalRegBaseAddrHi = 2050, kRegLocalRegBaseAddrLo = 2051,   kRegIsochVideoCh1Status = 2052, kRegIsochVideoCh1Control = 2053, kRegIsochVideoCh1Packets = 2054, kRegIsochAudioCh1Status = 2056,   kRegIsochAudioCh1Control = 2057, kRegIsochAudioCh1Packets = 2058, kRegIsochAudioCh2Status = 2060, kRegIsochAudioCh2Control = 2061,   kRegIsochAudioCh2Packets = 2062, kRegFireWireErrors = 2064, kRegAudioBufferSize = 2065, kRegAudioPlaybackControl = 2066,   kRegAVBitFileCSR = 2068, kRegBitFileBusy = 2069, kRegGetBitFileInfoSelect = 2070, kRegUserState1 = 2071,   kRegVideoDelay = 2072, kRegUpdateControl = 2112, kRegUpdateBitFileCommand = 2115, kRegUpdateCRC = 2116,   kRegUpdateStatus = 2117, kRegSerialNumber = 2118, kRegUpdateData = 2120, kRegIoHDLast = 2624 }
enum	IsochStreamType { kIsochVideoStream = 0, kIsochAudioPlaybackStream = 1, kIsochAudioCaptureStream = 2, kIsochMaxStreams = 3 }
enum	{   kStandAloneNormalStatus = 0, kStandAloneBusyStatus = 1, kStandAloneNoOp = 0, kStandAloneFactoryBurn = 1,   kStandAloneUserBurn = 2, kStandAlonePatternBurn = 4 }

Variables
const IOReturn	kNTV2DriverBadDMA = 0x04430011
const IOReturn	kNTV2DriverDMABusy = 0x04430012
const IOReturn	kNTV2DriverParamErr = 0x04430013
const IOReturn	kNTV2DriverPgmXilinxErr = 0x04430014
const IOReturn	kNTV2DriverNotReadyErr = 0x04430015
const IOReturn	kNTV2DriverPrepMemErr = 0x04430016
const IOReturn	kNTV2DriverPgmPPCErr = 0x04430017
const IOReturn	kNTV2DriverDMATooLarge = 0x04430018
const IOReturn	kNTV2DriverBadHeaderTag = 0x04430019
const IOReturn	kNTV2UnknownStructType = 0x0443001A
const IOReturn	kNTV2HeaderVersionErr = 0x0443001B
const IOReturn	kNTV2DriverBadTrailerTag = 0x0443001C
const IOReturn	kNTV2DriverMapperErr = 0x0443001D
const IOReturn	kNTV2DriverUnmapperErr = 0x0443001E
const IOReturn	kNTV2DriverMsgConvErr = 0x0443001F

Detailed Description

Declares MacOS-only enums used by the Mac driver and the SDK.

Copyright

(C) 2012-2022 AJA Video Systems, Inc. All rights reserved.

Definition in file ntv2macpublicinterface.h.

Macro Definition Documentation

AUDIO_MAX_SAMPLING_RATE_PER_MS

#define AUDIO_MAX_SAMPLING_RATE_PER_MS   48

Definition at line 117 of file ntv2macpublicinterface.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kRegIoHDGlobalStatus
kRegIoHDGlobalControl
kRegLocalRegBaseAddrHi
kRegLocalRegBaseAddrLo
kRegIsochVideoCh1Status
kRegIsochVideoCh1Control
kRegIsochVideoCh1Packets
kRegIsochAudioCh1Status
kRegIsochAudioCh1Control
kRegIsochAudioCh1Packets
kRegIsochAudioCh2Status
kRegIsochAudioCh2Control
kRegIsochAudioCh2Packets
kRegFireWireErrors
kRegAudioBufferSize
kRegAudioPlaybackControl
kRegAVBitFileCSR
kRegBitFileBusy
kRegGetBitFileInfoSelect
kRegUserState1
kRegVideoDelay
kRegUpdateControl
kRegUpdateBitFileCommand
kRegUpdateCRC
kRegUpdateStatus
kRegSerialNumber
kRegUpdateData
kRegIoHDLast

Definition at line 120 of file ntv2macpublicinterface.h.

anonymous enum

anonymous enum

Enumerator
kStandAloneNormalStatus
kStandAloneBusyStatus
kStandAloneNoOp
kStandAloneFactoryBurn
kStandAloneUserBurn
kStandAlonePatternBurn

Definition at line 181 of file ntv2macpublicinterface.h.

DMAEngine

enum DMAEngine

Enumerator
kDMANone
kDMA1
kDMA2
kDMA3
kDMA4
kDMAAuto

Definition at line 103 of file ntv2macpublicinterface.h.

InterruptType

enum InterruptType

Enumerator
kInterruptOutputVertical
kInterruptInput1Vertical
kInterruptInput2Vertical
kInterruptAudio
kInterruptAudioOutWrap
kInterruptAudioInWrap
kInterruptDMA1
kInterruptDMA2
kInterruptDMA3
kInterruptDMA4

Definition at line 88 of file ntv2macpublicinterface.h.

IsochStreamType

enum IsochStreamType

Enumerator
kIsochVideoStream
kIsochAudioPlaybackStream
kIsochAudioCaptureStream
kIsochMaxStreams

Definition at line 172 of file ntv2macpublicinterface.h.

MemoryType

enum MemoryType

Enumerator
kRegisterMemory
kFrameBufferMemory
kXena2FlashMemory
kNumberMemoryType

Definition at line 79 of file ntv2macpublicinterface.h.

UserClientCommandCodes

enum UserClientCommandCodes

Enumerator
kDriverReadRegister
kDriverWriteRegister
kDriverGetDrvrVersion
kDriverStartDriver
kDriverAcquireStreamForApplication
kDriverReleaseStreamForApplication
kDriverSetStreamForApplication
kDriverGetStreamForApplication
kDriverLockFormat
kDriverSetAVSyncPattern
kDriverTriggerAVSync
kDriverWaitForInterrupt
kDriverGetInterruptCount
kDriverWaitForChangeEvent
kDriverGetTime
kDriverDMATransfer
kDriverRestoreProcAmpRegisters
kDriverSetBitFileInformation
kDriverGetBitFileInformation
kDriverSetDebugFilterStrings
kDriverGetDebugFilterStrings
kDriverAutoCirculateControl
kDriverAutoCirculateStatus
kDriverAutoCirculateTransfer
kDriverAutoCirculateFramestamp
kDriverSetDefaultDeviceForPID
kDriverIsDefaultDeviceForPID
kDriverSystemControl
kDriverSystemStatus
kDriverDMATransferEx
kDriverAcquireStreamForApplicationWithReference
kDriverReleaseStreamForApplicationWithReference
kDriverKernelLog
kDriverReadAudioBuffer
kDriverNTV2Message
kNumberUserClientCommands

Definition at line 36 of file ntv2macpublicinterface.h.

Variable Documentation

kNTV2DriverBadDMA

const IOReturn kNTV2DriverBadDMA = 0x04430011

Definition at line 17 of file ntv2macpublicinterface.h.

kNTV2DriverBadHeaderTag

const IOReturn kNTV2DriverBadHeaderTag = 0x04430019

Definition at line 26 of file ntv2macpublicinterface.h.

kNTV2DriverBadTrailerTag

const IOReturn kNTV2DriverBadTrailerTag = 0x0443001C

Definition at line 29 of file ntv2macpublicinterface.h.

kNTV2DriverDMABusy

const IOReturn kNTV2DriverDMABusy = 0x04430012

Definition at line 18 of file ntv2macpublicinterface.h.

kNTV2DriverDMATooLarge

const IOReturn kNTV2DriverDMATooLarge = 0x04430018

Definition at line 24 of file ntv2macpublicinterface.h.

kNTV2DriverMapperErr

const IOReturn kNTV2DriverMapperErr = 0x0443001D

Definition at line 30 of file ntv2macpublicinterface.h.

kNTV2DriverMsgConvErr

const IOReturn kNTV2DriverMsgConvErr = 0x0443001F

Definition at line 32 of file ntv2macpublicinterface.h.

kNTV2DriverNotReadyErr

const IOReturn kNTV2DriverNotReadyErr = 0x04430015

Definition at line 21 of file ntv2macpublicinterface.h.

kNTV2DriverParamErr

const IOReturn kNTV2DriverParamErr = 0x04430013

Definition at line 19 of file ntv2macpublicinterface.h.

kNTV2DriverPgmPPCErr

const IOReturn kNTV2DriverPgmPPCErr = 0x04430017

Definition at line 23 of file ntv2macpublicinterface.h.

kNTV2DriverPgmXilinxErr

const IOReturn kNTV2DriverPgmXilinxErr = 0x04430014

Definition at line 20 of file ntv2macpublicinterface.h.

kNTV2DriverPrepMemErr

const IOReturn kNTV2DriverPrepMemErr = 0x04430016

Definition at line 22 of file ntv2macpublicinterface.h.

kNTV2DriverUnmapperErr

const IOReturn kNTV2DriverUnmapperErr = 0x0443001E

Definition at line 31 of file ntv2macpublicinterface.h.

kNTV2HeaderVersionErr

const IOReturn kNTV2HeaderVersionErr = 0x0443001B

Definition at line 28 of file ntv2macpublicinterface.h.

kNTV2UnknownStructType

const IOReturn kNTV2UnknownStructType = 0x0443001A

Definition at line 27 of file ntv2macpublicinterface.h.