/home/sn3d/devel/aja-ml/aja-lib/src/aja_types.h File Reference

Go to the source code of this file.

Namespaces
namespace	aja
Defines
#define	_AJA_TYPES_H_
#define	BYTE_MAX   0xFF
#define	NUMBER16_MAX   0x0000FFFF
#define	NUMBER24_MAX   0x00FFFFFF
#define	TERMINATOR   0x00
#define	ITEMTYPE_MASK   0xF0
#define	ELEMENTTYPE_MASK   0x0F
#define	ATTRIBUTETYPE_MASK   0x0F
#define	SIZE_ITEM_START   1
#define	SIZE_ELM_ID   3
#define	SIZE_ELM_ATTR_COUNT   1
#define	SIZE_ELM_CRC   2
#define	SIZE_ELM_DATA_LEN   4
#define	SIZE_ELM_STR_LEN   2
#define	SIZE_ELM_PARENT_LEN   4
#define	SIZE_ELM_DATA_LEN   4
#define	SIZE_ELM_HEADER   SIZE_ITEM_START + SIZE_ELM_ID + SIZE_ELM_ATTR_COUNT
#define	SIZE_ATTR_ID   8
#define	SIZE_ATTR_DATA_LEN   2
#define	SIZE_ATTR_STRING_LEN   2
#define	SIZE_ATTR_HEADER   SIZE_ITEM_START + SIZE_ATTR_ID
#define	SIZE_NUMBER   4
#define	SIZE_TERMINATOR   1
#define	ELEMENT_HEADER_ROOT   1
#define	ELEMENT_VALUE   2
#define	ELEMENT_TRANS_TABLE   3
#define	ELEMENT_TT_ELEMENT   4
#define	ELEMENT_TT_ATTRIBUTE   5
#define	ATTRIBUTE_VALUE_NAME   1
#define	ATTRIBUTE_ELEMENT_ID   1
#define	ATTRIBUTE_ELEMENT_NAME   2
#define	ATTRIBUTE_ELEMENT_DESC   3
#define	ATTRIBUTE_ATTRIBUTE_ID   1
#define	ATTRIBUTE_ATTRIBUTE_NAME   2
#define	ATTRIBUTE_ATTRIBUTE_DESC   3
#define	AJA_VERSION_1_0   0x10
#define	AJA_VALID_VERSION(ver)   (ver == AJA_VERSION_1_0)
#define	IS_ELEMENT_TYPE(value)   ( ((value > 0x00) && (value <= 0x03)) || (value == 0x0F) )
#define	IS_ATTRIBUTE_TYPE(value)   ((value > 0x00) && (value <= 0x03))
#define	IS_ITEM_TYPE(value)   ((value > 0x00) && (value <= 0x03))
Typedefs
typedef unsigned char	aja::byte_t
	this type representing 8 bit unsigned number
typedef unsigned short	aja::dbyte_t
	this type representing 16 bit unsigned number
typedef unsigned int	aja::number_t
	this type representing 32 bit unsigned number
typedef byte_t *	aja::buffer_t
	this type representing pointer to array of bytes
Enumerations
enum	aja::elementType_t {   aja::ELM_UNDEFINED = 0x00, aja::ELM_DATA = 0x01, aja::ELM_NUMBER = 0x02, aja::ELM_STRING = 0x03,   aja::ELM_PARENT = 0x0F }
	This enumeration type contain all element types. More...
enum	aja::attributeType_t { aja::ATTR_UNDEFINED = 0x00, aja::ATTR_DATA = 0x01, aja::ATTR_NUMBER = 0x02, aja::ATTR_STRING = 0x03 }
	This enumeration type contain all atribute types. More...
enum	aja::itemType_t { aja::ITM_UNDEFINED = 0x00, aja::ITM_ELEMENT = 0x01, aja::ITM_ATTRIBUTE = 0x02, aja::ITM_DOCUMENTHEADER = 0x0A }
	This enumeration type contain all basic items. More...

---

Detailed Description

Author:

Zdenko Vrabel(sn3d@users.sourceforge.net)

Version:

v1.0

Date:

26.11.2006

In this file are all elemtar enumerations, types, structures and macro-functions for types used in aja library.

---

Define Documentation

#define _AJA_TYPES_H_

#define AJA_VALID_VERSION (  ver   )     (ver == AJA_VERSION_1_0)

#define AJA_VERSION_1_0   0x10

#define ATTRIBUTE_ATTRIBUTE_DESC   3

#define ATTRIBUTE_ATTRIBUTE_ID   1

#define ATTRIBUTE_ATTRIBUTE_NAME   2

#define ATTRIBUTE_ELEMENT_DESC   3

#define ATTRIBUTE_ELEMENT_ID   1

#define ATTRIBUTE_ELEMENT_NAME   2

#define ATTRIBUTE_VALUE_NAME   1

#define ATTRIBUTETYPE_MASK   0x0F

#define BYTE_MAX   0xFF

#define ELEMENT_HEADER_ROOT   1

#define ELEMENT_TRANS_TABLE   3

#define ELEMENT_TT_ATTRIBUTE   5

#define ELEMENT_TT_ELEMENT   4

#define ELEMENT_VALUE   2

#define ELEMENTTYPE_MASK   0x0F

#define IS_ATTRIBUTE_TYPE (  value   )     ((value > 0x00) && (value <= 0x03))

#define IS_ELEMENT_TYPE (  value   )     ( ((value > 0x00) && (value <= 0x03)) || (value == 0x0F) )

#define IS_ITEM_TYPE (  value   )     ((value > 0x00) && (value <= 0x03))

#define ITEMTYPE_MASK   0xF0

#define NUMBER16_MAX   0x0000FFFF

#define NUMBER24_MAX   0x00FFFFFF

#define SIZE_ATTR_DATA_LEN   2

#define SIZE_ATTR_HEADER   SIZE_ITEM_START + SIZE_ATTR_ID

#define SIZE_ATTR_ID   8

#define SIZE_ATTR_STRING_LEN   2

#define SIZE_ELM_ATTR_COUNT   1

#define SIZE_ELM_CRC   2

#define SIZE_ELM_DATA_LEN   4

#define SIZE_ELM_DATA_LEN   4

#define SIZE_ELM_HEADER   SIZE_ITEM_START + SIZE_ELM_ID + SIZE_ELM_ATTR_COUNT

#define SIZE_ELM_ID   3

#define SIZE_ELM_PARENT_LEN   4

#define SIZE_ELM_STR_LEN   2

#define SIZE_ITEM_START   1

#define SIZE_NUMBER   4

#define SIZE_TERMINATOR   1

#define TERMINATOR   0x00

---