AJA NTV2 SDK  18.1.0.2262
NTV2 SDK 18.1.0.2262
ntv42message.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ntv42_message_header_t
 
struct  ntv42_message_trailer_t
 
struct  ntv42_message_device_info_t
 
struct  ntv42_message_regio_t
 

Macros

#define NTV42_MESSAGE_VERSION   1
 
#define NTV42_MESSAGE_TAG   0x6e657642
 
#define NTV42_MESSAGE_INIT(MSG, TYPE, FLAGS)
 
#define NTV42_HEADER_VERIFY(MSG)
 
#define NTV42_MESSAGE_VERIFY(MSG, TYPE)
 
#define NTV42_MESSAGE_FLAG_RW   0x00000001
 
#define NTV42_MESSAGE_SUCCESS   0
 
#define NTV42_MESSAGE_FAIL   1
 
#define NTV42_DEVICE_INFO_TYPE   1
 
#define NTV42_DEVICE_INFO_INIT(MSG)   NTV42_MESSAGE_INIT((MSG), (NTV42_DEVICE_INFO_TYPE), NTV42_MESSAGE_FLAG_RW)
 
#define NTV42_DEVICE_INFO_VERIFY(MSG)   NTV42_MESSAGE_VERIFY((MSG), (NTV42_DEVICE_INFO_TYPE))
 
#define NTV42_DEVICE_INFO_NAME_MAX   16
 
#define NTV42_DEVICE_INFO_DESC_MAX   32
 
#define NTV42_REGIO_TYPE   2
 
#define NTV42_REGIO_INIT(MSG)   NTV42_MESSAGE_INIT((MSG), (NTV42_REGIO_TYPE), NTV42_MESSAGE_FLAG_RW)
 
#define NTV42_REGIO_VERIFY(MSG)   NTV42_MESSAGE_VERIFY((MSG), (NTV42_REGIO_TYPE))
 
#define NTV42_REGIO_FLAG_READ   0x00000001
 
#define NTV42_REGIO_FLAG_WRITE   0x00000002
 
#define NTV42_REGIO_FLAG_32BIT   0x00000100
 

Typedefs

typedef struct ntv42_message_header_t ntv42_message_header_t
 
typedef struct ntv42_message_trailer_t ntv42_message_trailer_t
 
typedef struct ntv42_message_device_info_t ntv42_message_device_info_t
 
typedef struct ntv42_message_regio_t ntv42_message_regio_t
 

Macro Definition Documentation

◆ NTV42_DEVICE_INFO_DESC_MAX

#define NTV42_DEVICE_INFO_DESC_MAX   32

Definition at line 64 of file ntv42message.h.

◆ NTV42_DEVICE_INFO_INIT

#define NTV42_DEVICE_INFO_INIT (   MSG)    NTV42_MESSAGE_INIT((MSG), (NTV42_DEVICE_INFO_TYPE), NTV42_MESSAGE_FLAG_RW)

Definition at line 60 of file ntv42message.h.

◆ NTV42_DEVICE_INFO_NAME_MAX

#define NTV42_DEVICE_INFO_NAME_MAX   16

Definition at line 63 of file ntv42message.h.

◆ NTV42_DEVICE_INFO_TYPE

#define NTV42_DEVICE_INFO_TYPE   1

device info message

Definition at line 59 of file ntv42message.h.

◆ NTV42_DEVICE_INFO_VERIFY

#define NTV42_DEVICE_INFO_VERIFY (   MSG)    NTV42_MESSAGE_VERIFY((MSG), (NTV42_DEVICE_INFO_TYPE))

Definition at line 61 of file ntv42message.h.

◆ NTV42_HEADER_VERIFY

#define NTV42_HEADER_VERIFY (   MSG)
Value:
(((MSG)->tag == NTV42_MESSAGE_TAG) && \
((MSG)->version == NTV42_MESSAGE_VERSION))
#define NTV42_MESSAGE_TAG
Definition: ntv42message.h:17
#define NTV42_MESSAGE_VERSION
Definition: ntv42message.h:16

Definition at line 28 of file ntv42message.h.

◆ NTV42_MESSAGE_FAIL

#define NTV42_MESSAGE_FAIL   1

Definition at line 56 of file ntv42message.h.

◆ NTV42_MESSAGE_FLAG_RW

#define NTV42_MESSAGE_FLAG_RW   0x00000001

generic message header

Definition at line 39 of file ntv42message.h.

◆ NTV42_MESSAGE_INIT

#define NTV42_MESSAGE_INIT (   MSG,
  TYPE,
  FLAGS 
)
Value:
do { \
(MSG)->header.tag = NTV42_MESSAGE_TAG; \
(MSG)->header.version = NTV42_MESSAGE_VERSION; \
(MSG)->header.type = (TYPE); \
(MSG)->header.size = sizeof(MSG); \
(MSG)->header.flags = (FLAGS); \
(MSG)->header.status = 0; \
(MSG)->trailer.size = sizeof(MSG); \
} while (0);
#define NTV42_MESSAGE_TAG
Definition: ntv42message.h:17
#define NTV42_MESSAGE_VERSION
Definition: ntv42message.h:16

Definition at line 18 of file ntv42message.h.

◆ NTV42_MESSAGE_SUCCESS

#define NTV42_MESSAGE_SUCCESS   0

Definition at line 55 of file ntv42message.h.

◆ NTV42_MESSAGE_TAG

#define NTV42_MESSAGE_TAG   0x6e657642

Definition at line 17 of file ntv42message.h.

◆ NTV42_MESSAGE_VERIFY

#define NTV42_MESSAGE_VERIFY (   MSG,
  TYPE 
)
Value:
(((MSG)->header.tag == NTV42_MESSAGE_TAG) && \
((MSG)->header.version == NTV42_MESSAGE_VERSION) && \
((MSG)->header.type == (TYPE)) && \
((MSG)->header.size == sizeof(MSG)) && \
((MSG)->trailer.size == sizeof(MSG)))
#define NTV42_MESSAGE_TAG
Definition: ntv42message.h:17
#define NTV42_MESSAGE_VERSION
Definition: ntv42message.h:16

Definition at line 31 of file ntv42message.h.

◆ NTV42_MESSAGE_VERSION

#define NTV42_MESSAGE_VERSION   1

Definition at line 16 of file ntv42message.h.

◆ NTV42_REGIO_FLAG_32BIT

#define NTV42_REGIO_FLAG_32BIT   0x00000100

Definition at line 82 of file ntv42message.h.

◆ NTV42_REGIO_FLAG_READ

#define NTV42_REGIO_FLAG_READ   0x00000001

Definition at line 80 of file ntv42message.h.

◆ NTV42_REGIO_FLAG_WRITE

#define NTV42_REGIO_FLAG_WRITE   0x00000002

Definition at line 81 of file ntv42message.h.

◆ NTV42_REGIO_INIT

#define NTV42_REGIO_INIT (   MSG)    NTV42_MESSAGE_INIT((MSG), (NTV42_REGIO_TYPE), NTV42_MESSAGE_FLAG_RW)

Definition at line 77 of file ntv42message.h.

◆ NTV42_REGIO_TYPE

#define NTV42_REGIO_TYPE   2

register io message

Definition at line 76 of file ntv42message.h.

◆ NTV42_REGIO_VERIFY

#define NTV42_REGIO_VERIFY (   MSG)    NTV42_MESSAGE_VERIFY((MSG), (NTV42_REGIO_TYPE))

Definition at line 78 of file ntv42message.h.

Typedef Documentation

◆ ntv42_message_device_info_t

◆ ntv42_message_header_t

◆ ntv42_message_regio_t

◆ ntv42_message_trailer_t

generic message trailer