Doxygen Book
gsttensor_debug.h File Reference

GStreamer plugin to help debug tensor streams. More...

#include <gst/gst.h>
#include <gst/base/gstbasetransform.h>
#include <tensor_common.h>
Include dependency graph for gsttensor_debug.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _GstTensorDebug
 Internal data structure for tensor_debug instances. More...
 
struct  _GstTensorDebugClass
 GstTensorDebugClass data structure. More...
 

Macros

#define GST_TYPE_TENSOR_DEBUG   (gst_tensor_debug_get_type())
 
#define GST_TENSOR_DEBUG(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TENSOR_DEBUG,GstTensorDebug))
 
#define GST_TENSOR_DEBUG_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TENSOR_DEBUG,GstTensorDebugClass))
 
#define GST_IS_TENSOR_DEBUG(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TENSOR_DEBUG))
 
#define GST_IS_TENSOR_DEBUG_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TENSOR_DEBUG))
 
#define GST_TENSOR_DEBUG_CAST(obj)   ((GstTensorDebug *)(obj))
 

Typedefs

typedef struct _GstTensorDebug GstTensorDebug
 
typedef struct _GstTensorDebugClass GstTensorDebugClass
 

Enumerations

enum  tdbg_output_mode {
  TDBG_OUTPUT_DISABLED = 0x00, TDBG_OUTPUT_CONSOLE_I = 0x11, TDBG_OUTPUT_CONSOLE_W = 0x12, TDBG_OUTPUT_CONSOLE_E = 0x13,
  TDBG_OUTPUT_GSTDBG_I = 0x24, TDBG_OUTPUT_GSTDBG_W = 0x28, TDBG_OUTPUT_GSTDBG_E = 0x2C, TDBG_OUTPUT_CIRCULARBUF = 0x100,
  TDBG_OUTPUT_FILEWRITE = 0x200
}
 Property "OUTPUT" specification. More...
 
enum  tdbg_cap_mode { TDBG_CAP_DISABLED = 0, TDBG_CAP_SHOW_UPDATE = 1, TDBG_CAP_SHOW_UPDATE_F = 2, TDBG_CAP_SHOW_ALWAYS = 3 }
 Property "CAP" specification. More...
 
enum  tdbg_meta_mode { TDBG_META_DISABLED = 0x0, TDBG_META_TIMESTAMP = 0x1, TDBG_META_QUERYSERVER = 0x2 }
 Property "META" specification. More...
 

Functions

GType gst_tensor_debug_get_type (void)
 Get Type function required for gst elements. More...
 

Detailed Description

GStreamer plugin to help debug tensor streams.

GStreamer/NNStreamer tensor_debug Copyright (C) 2022 MyungJoo Ham myung.nosp@m.joo..nosp@m.ham@s.nosp@m.amsu.nosp@m.ng.co.nosp@m.m

Date
23 Sep 2022
See also
https://github.com/nnstreamer/nnstreamer
Author
MyungJoo Ham myung.nosp@m.joo..nosp@m.ham@s.nosp@m.amsu.nosp@m.ng.co.nosp@m.m
Bug:
No known bugs except for NYI items

Definition in file gsttensor_debug.h.

Macro Definition Documentation

◆ GST_IS_TENSOR_DEBUG

#define GST_IS_TENSOR_DEBUG (   obj)    (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TENSOR_DEBUG))

Definition at line 35 of file gsttensor_debug.h.

◆ GST_IS_TENSOR_DEBUG_CLASS

#define GST_IS_TENSOR_DEBUG_CLASS (   klass)    (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TENSOR_DEBUG))

Definition at line 37 of file gsttensor_debug.h.

◆ GST_TENSOR_DEBUG

#define GST_TENSOR_DEBUG (   obj)    (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TENSOR_DEBUG,GstTensorDebug))

Definition at line 31 of file gsttensor_debug.h.

◆ GST_TENSOR_DEBUG_CAST

#define GST_TENSOR_DEBUG_CAST (   obj)    ((GstTensorDebug *)(obj))

Definition at line 39 of file gsttensor_debug.h.

◆ GST_TENSOR_DEBUG_CLASS

#define GST_TENSOR_DEBUG_CLASS (   klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TENSOR_DEBUG,GstTensorDebugClass))

Definition at line 33 of file gsttensor_debug.h.

◆ GST_TYPE_TENSOR_DEBUG

#define GST_TYPE_TENSOR_DEBUG   (gst_tensor_debug_get_type())

Definition at line 29 of file gsttensor_debug.h.

Typedef Documentation

◆ GstTensorDebug

Definition at line 41 of file gsttensor_debug.h.

◆ GstTensorDebugClass

Definition at line 42 of file gsttensor_debug.h.

Enumeration Type Documentation

◆ tdbg_cap_mode

Property "CAP" specification.

Enumerator
TDBG_CAP_DISABLED 

No output for tensor-capability info

TDBG_CAP_SHOW_UPDATE 

Output tensor-capability if there is a change in gstcap

TDBG_CAP_SHOW_UPDATE_F 

Output tensor-capability if there is a change in dimensions even if gstcap has no changes. This happens with format=flexible or sparse

TDBG_CAP_SHOW_ALWAYS 

Definition at line 63 of file gsttensor_debug.h.

◆ tdbg_meta_mode

Property "META" specification.

Enumerator
TDBG_META_DISABLED 

Don't bring up metadata of a stream

TDBG_META_TIMESTAMP 

Enable timestamp info

TDBG_META_QUERYSERVER 

Enable tensor-query-server related info

Definition at line 74 of file gsttensor_debug.h.

◆ tdbg_output_mode

Property "OUTPUT" specification.

Enumerator
TDBG_OUTPUT_DISABLED 

disable output.

TDBG_OUTPUT_CONSOLE_I 

console/debug info

TDBG_OUTPUT_CONSOLE_W 

console/debug warn

TDBG_OUTPUT_CONSOLE_E 

console/debug error (non fatal)

TDBG_OUTPUT_GSTDBG_I 

gst-debug info

TDBG_OUTPUT_GSTDBG_W 

gst-debug warn

TDBG_OUTPUT_GSTDBG_E 

gst-debug error (non fatal)

TDBG_OUTPUT_CIRCULARBUF 

in circular buffer for later retrievals. (

Todo:
NYI NOT_SUPPORTED)
TDBG_OUTPUT_FILEWRITE 

Write to a file. (

Todo:
NYI NOT_SUPPORTED)

Definition at line 47 of file gsttensor_debug.h.

Function Documentation

◆ gst_tensor_debug_get_type()

GType gst_tensor_debug_get_type ( void  )

Get Type function required for gst elements.