Skip to main content

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

std::stringmedia_type = ...

Top-level GStreamer media type for the negotiated caps. More...

FormatSpecformat

Pixel/tensor format descriptor. More...

intwidth = -1

Frame width, in pixels. -1 = unspecified. More...

intheight = -1

Frame height, in pixels. -1 = unspecified. More...

intdepth = -1

Frame depth (e.g. More...

intmax_width = -1

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

intmax_height = -1

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

intmax_depth = -1

Max depth accepted at push time. More...

intfps_n = 0

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

intfps_d = 1

Framerate denominator. More...

std::stringcaps_override

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

boolis_live = true

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

booldo_timestamp = true

Let appsrc stamp PTS on push. More...

boolblock = true

Block on pool exhaustion instead of dropping. More...

intstream_type = 0

GST_APP_STREAM_TYPE_STREAM by default. More...

std::uint64_tmax_bytes = 0

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

booluse_simaai_pool = true

Allocate from the SiMa-aware buffer pool. More...

intpool_min_buffers = 1

Minimum buffers held by the pool. More...

intpool_max_buffers = 2

Maximum buffers held by the pool. More...

InputMemoryPolicymemory_policy = InputMemoryPolicy::Auto

Ingress allocation target policy used by appsrc input buffer allocation. More...

std::stringbuffer_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 74 of file Input.h.

Public Member Attributes

block

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

Block on pool exhaustion instead of dropping.

Definition at line 94 of file Input.h.

94 bool block = true;

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 106 of file Input.h.

106 std::string buffer_name;

caps_override

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

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

Definition at line 90 of file Input.h.

90 std::string caps_override;

depth

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

Frame depth (e.g.

tensor channels). -1 = unspecified.

Definition at line 80 of file Input.h.

80 int depth = -1;

do_timestamp

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

Let appsrc stamp PTS on push.

Definition at line 93 of file Input.h.

93 bool do_timestamp = true;

format

FormatSpec simaai::neat::InputOptions::format

Pixel/tensor format descriptor.

Definition at line 77 of file Input.h.

fps_d

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

Framerate denominator.

Definition at line 88 of file Input.h.

88 int fps_d = 1;

fps_n

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

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

Framerate numerator.

Definition at line 87 of file Input.h.

87 int fps_n = 0;

height

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

Frame height, in pixels. -1 = unspecified.

Definition at line 79 of file Input.h.

79 int height = -1;

is_live

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

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

Definition at line 92 of file Input.h.

92 bool is_live = true;

max_bytes

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

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

Definition at line 96 of file Input.h.

96 std::uint64_t max_bytes = 0;

max_depth

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

Max depth accepted at push time.

-1 = no cap.

Definition at line 85 of file Input.h.

85 int max_depth = -1;

max_height

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

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

Definition at line 84 of file Input.h.

84 int max_height = -1;

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 83 of file Input.h.

83 int max_width = -1;

media_type

std::string simaai::neat::InputOptions::media_type

Top-level GStreamer media type for the negotiated caps.

Initialiser
= "video/x-raw"

Definition at line 75 of file Input.h.

75 std::string media_type =

memory_policy

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

Ingress allocation target policy used by appsrc input buffer allocation.

Auto keeps legacy target selection unless caller/model/session overrides.

Definition at line 103 of file Input.h.

pool_max_buffers

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

Maximum buffers held by the pool.

Definition at line 100 of file Input.h.

pool_min_buffers

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

Minimum buffers held by the pool.

Definition at line 99 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 110 of file Input.h.

110 std::optional<PreprocessMetaTemplate> preprocess_meta;

stream_type

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

GST_APP_STREAM_TYPE_STREAM by default.

Definition at line 95 of file Input.h.

95 int stream_type = 0;

use_simaai_pool

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

Allocate from the SiMa-aware buffer pool.

Definition at line 98 of file Input.h.

98 bool use_simaai_pool = true;

width

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

Frame width, in pixels. -1 = unspecified.

Definition at line 78 of file Input.h.

78 int width = -1;

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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.