vftr_dump.h File Reference

Core feature-lib for dumping messages. More...

#include <stdio.h>
#include <time.h>
#include <pthread.h>
#include "mpi_base_types.h"
#include "vftr_dump_define.h"

Macros
#define	FORCE_INLINE   static inline __attribute__((always_inline))
#define	VFTR_initDump(args)
	Initialize dump system. More...
#define	VFTR_dumpStart()
#define	VFTR_dumpEnd()   pthread_cleanup_pop(1);

Functions
INT32	_VFTR_initDump (char *args)
	Initialize dump system for debugging. More...
VOID	VFTR_exitDump ()
INT32	VFTR_dump (const VOID *buf, UINT32 len, UINT32 flag, TIMESPEC_S timestamp)
	Dump a data structure with timestamps. More...
INT32	VFTR_dumpWithJiffies (const VOID *buf, UINT32 len, UINT32 flag, UINT32 jiffies)
	A jiffies version of VFTR_dump. More...
FORCE_INLINE void	_cleanup_push (void *args)

Variables
int	vftr_dump_en
pthread_mutex_t	g_access_mutex

Detailed Description

Core feature-lib for dumping messages.

Macro Definition Documentation

#define VFTR_dumpStart

(

)

Value:

pthread_cleanup_push(_cleanup_push, (void *)&g_access_mutex); \
        pthread_mutex_lock(&g_access_mutex);

#define VFTR_initDump

(

args

)

Value:

do {                                                                    \
                if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) {                      \
                        fprintf(stderr, "failed to ignore signal SIGPIPE !\n"); \
                };                                                              \
		_VFTR_initDump(args);                                           \
        } while (0)

Initialize dump system.

Parameters

[in]

args

Generally use NULL as input. Ignore SIGPIPE to avoid program stop after pipe destoryed.

Function Documentation

INT32 _VFTR_initDump

(

char *

args

)

Initialize dump system for debugging.

Parameters

[in]

args

Generally use NULL as input.

INT32 VFTR_dump	(	const VOID *	buf,
		UINT32	len,
		UINT32	flag,
		TIMESPEC_S	timestamp
	)

Dump a data structure with timestamps.

Parameters

[in]	buf	Data to be sent
[in]	len	Length of data
[in]	timestamp	Better to be a wall clock which matches the OSD timestamp shown in video clips

Returns

0 if success, otherwise, a negative value returns

See also

TIMESPEC_S

INT32 VFTR_dumpWithJiffies	(	const VOID *	buf,
		UINT32	len,
		UINT32	flag,
		UINT32	jiffies
	)

A jiffies version of VFTR_dump.

Parameters

[in]	buf	Data to be sent
[in]	len	Length of data
[in]	jiffies	You can use U32 timestamp in MPI_IVA_OBJ_LIST_S

Returns

0 if success, otherwise, a negative value returns

See also

VFTR_dump

MPI_IVA_OBJ_LIST_S

Variable Documentation

int vftr_dump_en

a global flag for enableing dump system