types.h File Reference

Declares common types used in the ajabase library. More...

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

Go to the source code of this file.

Macros
#define	AJA_USE_CPLUSPLUS11
#define	NULL_PTR   (0)
#define	AJA_FCC(a)
#define	AJA_FOURCC(a, b, c, d)
#define	AJA_FOURCC_2(a)   (AJA_FOURCC(a,0,0,0))
#define	AJA_SUCCESS(_status_)   (_status_ >= 0)
#define	AJA_FAILURE(_status_)   (_status_ < 0)
#define	AJA_UNUSED(_x_)   (void)_x_;
#define	AJA_CHECK_NULL(_ptr_, _res_)   { if (__ptr__ == NULL) { return _res_; } }
#define	AJA_RETURN_STATUS(_status_)   { const AJAStatus s = _status_; if (s != AJA_STATUS_SUCCESS) { return s; } }
#define	NUMELMS(aa)   (sizeof(aa)/sizeof((aa)[0]))
#define	AJA_ENDIAN_SWAP16(_data_)
#define	AJA_ENDIAN_SWAP32(_data_)
#define	AJA_ENDIAN_SWAP64(_data_)

Enumerations
enum	AJAStatus {   AJA_STATUS_TRUE = 1, AJA_STATUS_SUCCESS = 0, AJA_STATUS_FAIL =-1, AJA_STATUS_UNKNOWN =-2,   AJA_STATUS_TIMEOUT =-3, AJA_STATUS_RANGE =-4, AJA_STATUS_INITIALIZE =-5, AJA_STATUS_NULL =-6,   AJA_STATUS_OPEN =-7, AJA_STATUS_IO =-8, AJA_STATUS_DISABLED =-9, AJA_STATUS_BUSY =-10,   AJA_STATUS_BAD_PARAM =-11, AJA_STATUS_FEATURE =-12, AJA_STATUS_UNSUPPORTED =-13, AJA_STATUS_READONLY =-14,   AJA_STATUS_WRITEONLY =-15, AJA_STATUS_MEMORY =-16, AJA_STATUS_ALIGN =-17, AJA_STATUS_FLUSH =-18,   AJA_STATUS_NOINPUT =-19, AJA_STATUS_SURPRISE_REMOVAL =-20, AJA_STATUS_NOT_FOUND =-21, AJA_STATUS_NOBUFFER =-100,   AJA_STATUS_INVALID_TIME =-101, AJA_STATUS_NOSTREAM =-102, AJA_STATUS_TIMEEXPIRED =-103, AJA_STATUS_BADBUFFERCOUNT =-104,   AJA_STATUS_BADBUFFERSIZE =-105, AJA_STATUS_STREAMCONFLICT =-106, AJA_STATUS_NOTINITIALIZED =-107, AJA_STATUS_STREAMRUNNING =-108,   AJA_STATUS_REBOOT = -109, AJA_STATUS_POWER_CYCLE = -110 }

Detailed Description

Declares common types used in the ajabase library.

Copyright

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

Definition in file types.h.

Macro Definition Documentation

AJA_CHECK_NULL

#define AJA_CHECK_NULL	(		_ptr_,
			_res_
	)		{ if (__ptr__ == NULL) { return _res_; } }

Definition at line 426 of file types.h.

AJA_ENDIAN_SWAP16

#define AJA_ENDIAN_SWAP16

(

_data_

)

Value:

                                    ( ((uint16_t(_data_) <<  8) & uint16_t(0xff00)) | \
                                    ((uint16_t(_data_) >>  8) & uint16_t(0x00ff))   )

Definition at line 433 of file types.h.

AJA_ENDIAN_SWAP32

#define AJA_ENDIAN_SWAP32

(

_data_

)

Value:

                                    ( ((uint32_t(_data_) << 24) & uint32_t(0xff000000)) | \
                                    ((uint32_t(_data_) <<  8) & uint32_t(0x00ff0000)) | \
                                    ((uint32_t(_data_) >>  8) & uint32_t(0x0000ff00)) | \
                                    ((uint32_t(_data_) >> 24) & uint32_t(0x000000ff))   )

Definition at line 435 of file types.h.

AJA_ENDIAN_SWAP64

#define AJA_ENDIAN_SWAP64

(

_data_

)

Value:

                                    ( ((uint64_t(_data_) << 56) & uint64_t(0xff00000000000000)) | \
                                    ((uint64_t(_data_) << 40) & uint64_t(0x00ff000000000000)) | \
                                    ((uint64_t(_data_) << 24) & uint64_t(0x0000ff0000000000)) | \
                                    ((uint64_t(_data_) <<  8) & uint64_t(0x000000ff00000000)) | \
                                    ((uint64_t(_data_) >>  8) & uint64_t(0x00000000ff000000)) | \
                                    ((uint64_t(_data_) >> 24) & uint64_t(0x0000000000ff0000)) | \
                                    ((uint64_t(_data_) >> 40) & uint64_t(0x000000000000ff00)) | \
                                    ((uint64_t(_data_) >> 56) & uint64_t(0x00000000000000ff))   )

Definition at line 439 of file types.h.

AJA_FAILURE

#define AJA_FAILURE

(

_status_

)

(_status_ < 0)

Definition at line 371 of file types.h.

AJA_FCC

#define AJA_FCC

(

a

)

Value:

( ((uint32_t)(((uint8_t *)(a))[0]) << 0)  + \
  ((uint32_t)(((uint8_t *)(a))[1]) << 8)  + \
  ((uint32_t)(((uint8_t *)(a))[2]) << 16) + \
  ((uint32_t)(((uint8_t *)(a))[3]) << 24) )

Macro to define a FourCC. Example: AJA_FCC("dvc ")

Definition at line 339 of file types.h.

AJA_FOURCC

#define AJA_FOURCC	(		a,
			b,
			c,
			d
	)

Value:

( (((uint32_t)(a)) <<  0)  + \
  (((uint32_t)(b)) <<  8)  + \
  (((uint32_t)(c)) << 16)  + \
  (((uint32_t)(d)) << 24) )

Macro to define a FourCC. Example: AJA_FOURCC('d','v','c',' ') AJA_FOURCC_2(0x24)

Definition at line 357 of file types.h.

AJA_FOURCC_2

#define AJA_FOURCC_2

(

a

)

(AJA_FOURCC(a,0,0,0))

Definition at line 363 of file types.h.

AJA_RETURN_STATUS

#define AJA_RETURN_STATUS

(

_status_

)

{ const AJAStatus s = _status_; if (s != AJA_STATUS_SUCCESS) { return s; } }

Definition at line 427 of file types.h.

AJA_SUCCESS

#define AJA_SUCCESS

(

_status_

)

(_status_ >= 0)

Standard api return code

Definition at line 370 of file types.h.

AJA_UNUSED

#define AJA_UNUSED

(

_x_

)

(void)_x_;

Definition at line 424 of file types.h.

AJA_USE_CPLUSPLUS11

#define AJA_USE_CPLUSPLUS11

Definition at line 25 of file types.h.

NULL_PTR

#define NULL_PTR   (0)

Definition at line 325 of file types.h.

NUMELMS

#define NUMELMS

(

aa

)

(sizeof(aa)/sizeof((aa)[0]))

Definition at line 430 of file types.h.