InputOptions Struct

Caps, buffering, and pool options for the Input Node. More...

Declaration

struct simaai::neat::InputOptions { ... }

Included Headers

#include <Input.h>

Public Member Attributes Index

PayloadType	payload_type = PayloadType::Auto
	Public payload family. More...
FormatSpec	format
	Pixel/tensor format descriptor. More...
int	width = -1
	Frame width, in pixels. -1 = unspecified. More...
int	height = -1
	Frame height, in pixels. -1 = unspecified. More...
int	depth = -1
	Frame depth (e.g. More...
int	max_width = -1
	Optional dynamic-input limits used for validation/pool sizing. More...
int	max_height = -1
	Max height accepted at push time. -1 = no cap. More...
int	max_depth = -1
	Max depth accepted at push time. More...
int	fps_n = 0
	Optional fixed framerate for caps (0/1 means "unspecified"). More...
int	fps_d = 1
	Framerate denominator. More...
std::string	caps_override
	Optional full caps string override (used for multi-tensor caps). More...
bool	is_live = true
	Mark the source as live (appsrc is-live). More...
bool	do_timestamp = true
	Let appsrc stamp PTS on push. More...
bool	block = true
	Block on pool exhaustion instead of dropping. More...
int	stream_type = 0
	GST_APP_STREAM_TYPE_STREAM by default. More...
std::uint64_t	max_bytes = 0
	appsrc max-bytes back-pressure threshold. 0 = unlimited. More...
bool	use_simaai_pool = true
int	pool_min_buffers = 1
	Minimum buffers held by the pool. More...
int	pool_max_buffers = 2
	Maximum buffers held by the pool. More...
InputMemoryPolicy	memory_policy = InputMemoryPolicy::Auto
	Ingress allocation target policy used by appsrc input buffer allocation. More...
std::string	buffer_name
	Optional GstSimaMeta buffer name override. Leave empty to avoid forcing a legacy default. More...
std::optional< PreprocessMetaTemplate >	preprocess_meta
	Optional preprocess runtime metadata template used to annotate GstSimaMeta with geometry/affine context for downstream plugins (e.g. More...

Description

Caps, buffering, and pool options for the Input Node.

Definition at line 85 of file Input.h.

Public Member Attributes

block

bool simaai::neat::InputOptions::block = true

Block on pool exhaustion instead of dropping.

Definition at line 104 of file Input.h.

buffer_name

std::string simaai::neat::InputOptions::buffer_name

Optional GstSimaMeta buffer name override. Leave empty to avoid forcing a legacy default.

Definition at line 122 of file Input.h.

caps_override

std::string simaai::neat::InputOptions::caps_override

Optional full caps string override (used for multi-tensor caps).

Definition at line 100 of file Input.h.

depth

int simaai::neat::InputOptions::depth = -1

Frame depth (e.g.

tensor channels). -1 = unspecified.

Definition at line 90 of file Input.h.

do_timestamp

bool simaai::neat::InputOptions::do_timestamp = true

Let appsrc stamp PTS on push.

Definition at line 103 of file Input.h.

format

FormatSpec simaai::neat::InputOptions::format

Pixel/tensor format descriptor.

Definition at line 87 of file Input.h.

fps_d

int simaai::neat::InputOptions::fps_d = 1

Framerate denominator.

Definition at line 98 of file Input.h.

fps_n

int simaai::neat::InputOptions::fps_n = 0

Optional fixed framerate for caps (0/1 means "unspecified").

Framerate numerator.

Definition at line 97 of file Input.h.

height

int simaai::neat::InputOptions::height = -1

Frame height, in pixels. -1 = unspecified.

Definition at line 89 of file Input.h.

is_live

bool simaai::neat::InputOptions::is_live = true

Mark the source as live (appsrc is-live).

Definition at line 102 of file Input.h.

max_bytes

std::uint64_t simaai::neat::InputOptions::max_bytes = 0

appsrc max-bytes back-pressure threshold. 0 = unlimited.

Definition at line 106 of file Input.h.

max_depth

int simaai::neat::InputOptions::max_depth = -1

Max depth accepted at push time.

-1 = no cap.

Definition at line 95 of file Input.h.

max_height

int simaai::neat::InputOptions::max_height = -1

Max height accepted at push time. -1 = no cap.

Definition at line 94 of file Input.h.

max_width

int simaai::neat::InputOptions::max_width = -1

Optional dynamic-input limits used for validation/pool sizing.

These do not constrain negotiated caps and are only checked at push time. Max width accepted at push time. -1 = no cap.

Definition at line 93 of file Input.h.

memory_policy

InputMemoryPolicy simaai::neat::InputOptions::memory_policy = InputMemoryPolicy::Auto

Ingress allocation target policy used by appsrc input buffer allocation.

Auto lets graph lowering infer from downstream nodes where possible.

Definition at line 119 of file Input.h.

payload_type

PayloadType simaai::neat::InputOptions::payload_type = PayloadType::Auto

Public payload family.

Definition at line 86 of file Input.h.

pool_max_buffers

int simaai::neat::InputOptions::pool_max_buffers = 2

Maximum buffers held by the pool.

Definition at line 116 of file Input.h.

pool_min_buffers

int simaai::neat::InputOptions::pool_min_buffers = 1

Minimum buffers held by the pool.

Definition at line 115 of file Input.h.

preprocess_meta

std::optional<PreprocessMetaTemplate> simaai::neat::InputOptions::preprocess_meta

Optional preprocess runtime metadata template used to annotate GstSimaMeta with geometry/affine context for downstream plugins (e.g.

box decode).

Definition at line 126 of file Input.h.

stream_type

int simaai::neat::InputOptions::stream_type = 0

GST_APP_STREAM_TYPE_STREAM by default.

Definition at line 105 of file Input.h.

use_simaai_pool

bool simaai::neat::InputOptions::use_simaai_pool = true

Deprecated

Accepted for source compatibility. Use memory_policy instead: false maps to InputMemoryPolicy::SystemMemory; default SiMa allocation behavior maps to InputMemoryPolicy::Auto; explicit targets use InputMemoryPolicy::Ev74 or InputMemoryPolicy::Dms0. Older Graph JSON using this field is still accepted. New saved Graph JSON writes memory_policy.

Definition at line 114 of file Input.h.

width

int simaai::neat::InputOptions::width = -1

Frame width, in pixels. -1 = unspecified.

Definition at line 88 of file Input.h.

---

The documentation for this struct was generated from the following file:

• Input.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.