AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
debugshare.h File Reference

Declares the constants used for sharing debug messages. These structures are used to gather debug messages and share them with the applications that report and log. More...

#include "ajabase/common/export.h"
#include <stddef.h>
#include <stdint.h>
#include <string>
#include <vector>
Include dependency graph for debugshare.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _AJADebugMessage
 
class  AJADebugStat
 
struct  _AJADebugShare
 

Macros

#define AJA_DEBUG_DESTINATION_NONE   0
 
#define AJA_DEBUG_DESTINATION_DEBUG   0x00000001
 
#define AJA_DEBUG_DESTINATION_CONSOLE   0x00000002
 
#define AJA_DEBUG_DESTINATION_LOG   0x00000004
 
#define AJA_DEBUG_DESTINATION_DRIVER   0x00000008
 
#define AJA_DEBUG_MAGIC_ID   AJA_FOURCC('D','B','U','G')
 
#define AJA_DEBUG_VERSION   110
 
#define AJA_DEBUG_UNIT_ARRAY_SIZE   65536
 
#define AJA_DEBUG_SEVERITY_ARRAY_SIZE   64
 
#define AJA_DEBUG_MAX_NUM_STATS   256
 
#define AJA_DEBUG_STAT_DEQUE_SIZE   11
 
#define AJA_DEBUG_MESSAGE_MAX_SIZE   512
 
#define AJA_DEBUG_MESSAGE_RING_SIZE   4096
 
#define AJA_DEBUG_FILE_NAME_MAX_SIZE   512
 
#define AJA_DEBUG_SHARE_NAME   "aja-shm-debug"
 
#define AJA_DEBUG_TICK_RATE   1000000
 
#define AJA_DEBUG_STATE_FILE_VERSION   510
 

Typedefs

typedef struct _AJADebugMessage AJADebugMessage
 
typedef enum _AJADebugStats AJADebugStats
 
typedef struct _AJADebugShare AJADebugShare
 

Enumerations

enum  _AJADebugStats {
  AJA_DebugStat_ReadRegister = 0, AJA_DebugStat_WriteRegister, AJA_DebugStat_WaitForInterruptIn1, AJA_DebugStat_WaitForInterruptIn2,
  AJA_DebugStat_WaitForInterruptIn3, AJA_DebugStat_WaitForInterruptIn4, AJA_DebugStat_WaitForInterruptIn5, AJA_DebugStat_WaitForInterruptIn6,
  AJA_DebugStat_WaitForInterruptIn7, AJA_DebugStat_WaitForInterruptIn8, AJA_DebugStat_WaitForInterruptOut1, AJA_DebugStat_WaitForInterruptUartRx1,
  AJA_DebugStat_WaitForInterruptUartTx1, AJA_DebugStat_WaitForInterruptUartRx2, AJA_DebugStat_WaitForInterruptUartTx2, AJA_DebugStat_WaitForInterruptOthers,
  AJA_DebugStat_GetInterruptCount, AJA_DebugStat_DMATransfer, AJA_DebugStat_DMATransferEx, AJA_DebugStat_DMATransferP2P,
  AJA_DebugStat_AutoCirculate, AJA_DebugStat_AutoCirculateXfer, AJA_DebugStat_NTV2Message, AJA_DebugStat_HEVCSendMessage,
  AJA_DebugStat_ACXferRPCEncode, AJA_DebugStat_ACXferRPCDecode, AJA_DebugStat_NUM_STATS
}
 
enum  _AJADebugSeverity {
  AJA_DebugSeverity_Emergency = 0, AJA_DebugSeverity_Alert = 1, AJA_DebugSeverity_Assert = 2, AJA_DebugSeverity_Error = 3,
  AJA_DebugSeverity_Warning = 4, AJA_DebugSeverity_Notice = 5, AJA_DebugSeverity_Info = 6, AJA_DebugSeverity_Debug = 7,
  AJA_DebugSeverity_Size = 8
}
 
typedef enum _AJADebugSeverity AJADebugSeverity
 
enum  _AJADebugUnit {
  AJA_DebugUnit_Unknown = 0, AJA_DebugUnit_Critical = 1, AJA_DebugUnit_DriverGeneric = 2, AJA_DebugUnit_ServiceGeneric = 3,
  AJA_DebugUnit_UserGeneric = 4, AJA_DebugUnit_VideoGeneric = 5, AJA_DebugUnit_AudioGeneric = 6, AJA_DebugUnit_TimecodeGeneric = 7,
  AJA_DebugUnit_AncGeneric = 8, AJA_DebugUnit_RoutingGeneric = 9, AJA_DebugUnit_StatsGeneric = 10, AJA_DebugUnit_Enumeration = 11,
  AJA_DebugUnit_Application = 12, AJA_DebugUnit_QuickTime = 13, AJA_DebugUnit_ControlPanel = 14, AJA_DebugUnit_Watcher = 15,
  AJA_DebugUnit_Plugins = 16, AJA_DebugUnit_CCLine21Decode = 17, AJA_DebugUnit_CCLine21Encode = 18, AJA_DebugUnit_CC608DataQueue = 19,
  AJA_DebugUnit_CC608MsgQueue = 20, AJA_DebugUnit_CC608Decode = 21, AJA_DebugUnit_CC608DecodeChannel = 22, AJA_DebugUnit_CC608DecodeScreen = 23,
  AJA_DebugUnit_CC608Encode = 24, AJA_DebugUnit_CC708Decode = 25, AJA_DebugUnit_CC708Service = 26, AJA_DebugUnit_CC708ServiceBlockQueue = 27,
  AJA_DebugUnit_CC708Window = 28, AJA_DebugUnit_CC708Encode = 29, AJA_DebugUnit_CCFont = 30, AJA_DebugUnit_SMPTEAnc = 31,
  AJA_DebugUnit_AJAAncData = 32, AJA_DebugUnit_AJAAncList = 33, AJA_DebugUnit_Testing = 34, AJA_DebugUnit_PnP = 35,
  AJA_DebugUnit_Persistence = 36, AJA_DebugUnit_Avid = 37, AJA_DebugUnit_DriverInterface = 38, AJA_DebugUnit_AutoCirculate = 39,
  AJA_DebugUnit_NMOS = 40, AJA_DebugUnit_App_DiskRead = 41, AJA_DebugUnit_App_DiskWrite = 42, AJA_DebugUnit_App_Decode = 43,
  AJA_DebugUnit_App_Encode = 44, AJA_DebugUnit_App_DMA = 45, AJA_DebugUnit_App_Screen = 46, AJA_DebugUnit_App_User1 = 47,
  AJA_DebugUnit_App_User2 = 48, AJA_DebugUnit_Anc2110Xmit = 49, AJA_DebugUnit_Anc2110Rcv = 50, AJA_DebugUnit_DemoPlayout = 51,
  AJA_DebugUnit_DemoCapture = 52, AJA_DebugUnit_CSC = 53, AJA_DebugUnit_LUT = 54, AJA_DebugUnit_Cables = 55,
  AJA_DebugUnit_RPCServer = 56, AJA_DebugUnit_RPCClient = 57, AJA_DebugUnit_Firmware = 58, AJA_DebugUnit_App_Alloc = 59,
  AJA_DebugUnit_FirstUnused = 60, AJA_DebugUnit_Unused_60 = AJA_DebugUnit_FirstUnused, AJA_DebugUnit_Unused_61 = 61, AJA_DebugUnit_Unused_62 = 62,
  AJA_DebugUnit_Unused_63 = 63, AJA_DebugUnit_Unused_64 = 64, AJA_DebugUnit_Unused_65 = 65, AJA_DebugUnit_Unused_66 = 66,
  AJA_DebugUnit_Unused_67 = 67, AJA_DebugUnit_Unused_68 = 68, AJA_DebugUnit_Unused_69 = 69, AJA_DebugUnit_Unused_70 = 70,
  AJA_DebugUnit_Unused_71 = 71, AJA_DebugUnit_Unused_72 = 72, AJA_DebugUnit_Unused_73 = 73, AJA_DebugUnit_Unused_74 = 74,
  AJA_DebugUnit_Unused_75 = 75, AJA_DebugUnit_Unused_76 = 76, AJA_DebugUnit_Unused_77 = 77, AJA_DebugUnit_Unused_78 = 78,
  AJA_DebugUnit_Unused_79 = 79, AJA_DebugUnit_Unused_80 = 80, AJA_DebugUnit_Unused_81 = 81, AJA_DebugUnit_Unused_82 = 82,
  AJA_DebugUnit_Unused_83 = 83, AJA_DebugUnit_Unused_84 = 84, AJA_DebugUnit_Size = 85
}
 
typedef enum _AJADebugUnit AJADebugUnit
 

Detailed Description

Declares the constants used for sharing debug messages. These structures are used to gather debug messages and share them with the applications that report and log.

Note
This file is shared with drivers written in c.

Definition in file debugshare.h.

Typedef Documentation

◆ AJADebugMessage

Structure representing the debug message.

◆ AJADebugSeverity

The list of debug message severity codes.

◆ AJADebugShare

typedef struct _AJADebugShare AJADebugShare

Structure representing the shared debug groups and messages.

◆ AJADebugUnit

The list of debug message groups.

Enumeration Type Documentation

◆ _AJADebugSeverity

The list of debug message severity codes.

Enumerator
AJA_DebugSeverity_Emergency 

System is unusable

AJA_DebugSeverity_Alert 

Action must be taken immediately

AJA_DebugSeverity_Assert 

Assert conditions

AJA_DebugSeverity_Error 

Error conditions

AJA_DebugSeverity_Warning 

Warning conditions

AJA_DebugSeverity_Notice 

Normal but significant condition

AJA_DebugSeverity_Info 

Informational

AJA_DebugSeverity_Debug 

Debug-level messages

AJA_DebugSeverity_Size 

Size of severity enum, must be last

Definition at line 23 of file debugshare.h.

◆ _AJADebugUnit

The list of debug message groups.

Enumerator
AJA_DebugUnit_Unknown 
AJA_DebugUnit_Critical 
AJA_DebugUnit_DriverGeneric 
AJA_DebugUnit_ServiceGeneric 
AJA_DebugUnit_UserGeneric 
AJA_DebugUnit_VideoGeneric 
AJA_DebugUnit_AudioGeneric 
AJA_DebugUnit_TimecodeGeneric 
AJA_DebugUnit_AncGeneric 
AJA_DebugUnit_RoutingGeneric 
AJA_DebugUnit_StatsGeneric 
AJA_DebugUnit_Enumeration 
AJA_DebugUnit_Application 
AJA_DebugUnit_QuickTime 
AJA_DebugUnit_ControlPanel 
AJA_DebugUnit_Watcher 
AJA_DebugUnit_Plugins 
AJA_DebugUnit_CCLine21Decode 
AJA_DebugUnit_CCLine21Encode 
AJA_DebugUnit_CC608DataQueue 
AJA_DebugUnit_CC608MsgQueue 
AJA_DebugUnit_CC608Decode 
AJA_DebugUnit_CC608DecodeChannel 
AJA_DebugUnit_CC608DecodeScreen 
AJA_DebugUnit_CC608Encode 
AJA_DebugUnit_CC708Decode 
AJA_DebugUnit_CC708Service 
AJA_DebugUnit_CC708ServiceBlockQueue 
AJA_DebugUnit_CC708Window 
AJA_DebugUnit_CC708Encode 
AJA_DebugUnit_CCFont 
AJA_DebugUnit_SMPTEAnc 
AJA_DebugUnit_AJAAncData 
AJA_DebugUnit_AJAAncList 
AJA_DebugUnit_Testing 
AJA_DebugUnit_PnP 
AJA_DebugUnit_Persistence 
AJA_DebugUnit_Avid 
AJA_DebugUnit_DriverInterface 
AJA_DebugUnit_AutoCirculate 
AJA_DebugUnit_NMOS 
AJA_DebugUnit_App_DiskRead 
AJA_DebugUnit_App_DiskWrite 
AJA_DebugUnit_App_Decode 
AJA_DebugUnit_App_Encode 
AJA_DebugUnit_App_DMA 
AJA_DebugUnit_App_Screen 
AJA_DebugUnit_App_User1 
AJA_DebugUnit_App_User2 
AJA_DebugUnit_Anc2110Xmit 
AJA_DebugUnit_Anc2110Rcv 
AJA_DebugUnit_DemoPlayout 
AJA_DebugUnit_DemoCapture 
AJA_DebugUnit_CSC 
AJA_DebugUnit_LUT 
AJA_DebugUnit_Cables 
AJA_DebugUnit_RPCServer 
AJA_DebugUnit_RPCClient 
AJA_DebugUnit_Firmware 
AJA_DebugUnit_App_Alloc 
AJA_DebugUnit_FirstUnused 
AJA_DebugUnit_Unused_60 
AJA_DebugUnit_Unused_61 
AJA_DebugUnit_Unused_62 
AJA_DebugUnit_Unused_63 
AJA_DebugUnit_Unused_64 
AJA_DebugUnit_Unused_65 
AJA_DebugUnit_Unused_66 
AJA_DebugUnit_Unused_67 
AJA_DebugUnit_Unused_68 
AJA_DebugUnit_Unused_69 
AJA_DebugUnit_Unused_70 
AJA_DebugUnit_Unused_71 
AJA_DebugUnit_Unused_72 
AJA_DebugUnit_Unused_73 
AJA_DebugUnit_Unused_74 
AJA_DebugUnit_Unused_75 
AJA_DebugUnit_Unused_76 
AJA_DebugUnit_Unused_77 
AJA_DebugUnit_Unused_78 
AJA_DebugUnit_Unused_79 
AJA_DebugUnit_Unused_80 
AJA_DebugUnit_Unused_81 
AJA_DebugUnit_Unused_82 
AJA_DebugUnit_Unused_83 
AJA_DebugUnit_Unused_84 
AJA_DebugUnit_Size 

Definition at line 44 of file debugshare.h.