Pipeline runtime
Graph, PipelineRun, options, reports, errors. More...
Classes Index
| struct | DebugOptions |
|
Tunables for debug-mode pipeline dumps. More... | |
| struct | DebugOutput |
|
One captured pipeline output (single-shot dump result). More... | |
| struct | DebugStream |
|
Streaming iterator over debug-mode pipeline outputs. More... | |
| struct | Box |
|
One axis-aligned detection produced by BoxDecode. More... | |
| struct | BoxDecodeResult |
|
Parsed BoxDecode output paired with its raw byte buffer. More... | |
| struct | FormatSpec |
|
Thin wrapper around FormatTag with implicit string conversions. More... | |
| class | RtspServerHandle |
|
Live handle for a Graph running in RTSP server mode. More... | |
| class | Graph |
|
The assembly stage — turns a list of Nodes into a runnable, deterministic pipeline. More... | |
| struct | GroupMeta |
|
Per-fragment metadata captured during build. More... | |
| struct | RtspServerOptions |
|
Options for Graph::run_rtsp() — controls the RTSP server's mount point and ports. More... | |
| struct | AdvancedExecutionOptions |
|
Intent-named, jargon-free execution controls (preferred over the raw legacy fields). More... | |
| struct | GraphOptions |
|
Per-Graph construction options. More... | |
| struct | OutputTensorOptions |
|
Options for Graph::add_output_tensor() — the tensor-friendly output helper. More... | |
| struct | Sample |
|
Typed payload returned by Run::pull() and consumed by Run::push(). More... | |
| struct | RunOptions |
|
Per-Run runtime options. More... | |
| class | Run |
|
Live pipeline handle: push inputs in, pull outputs out. More... | |
| struct | BoxDecodeOptions |
|
Options driving a standalone BoxDecode invocation. More... | |
Enumerations Index
| enum class | BoxDecodeType : std::int32_t { ... } |
|
Decode families accepted by the BoxDecode backend. More... | |
| enum class | BoxDecodeTypeOption : std::int32_t { ... } |
|
Tensor packing/layout option within a decode family. More... | |
| enum class | BoxDecodeSourceStorage : std::int32_t { ... } |
|
Source byte layout of the head tensors feeding a BoxDecode stage. More... | |
| enum class | FormatTag { ... } |
|
Identifies a media or tensor payload format. More... | |
| enum class | RunMode { ... } |
| enum class | SampleKind { ... } |
| enum class | PullStatus { ... } |
|
Result status of Run::pull(). More... | |
| enum class | OverflowPolicy { ... } |
|
What push() does when the input queue is full. More... | |
| enum class | RunPreset { ... } |
|
Convenience preset bundles for RunOptions. More... | |
| enum class | OutputMemory { ... } |
|
How output Tensors relate to the underlying GStreamer buffers. More... | |
Description
Graph, PipelineRun, options, reports, errors.
Enumerations
BoxDecodeSourceStorage
| strong |
Source byte layout of the head tensors feeding a BoxDecode stage.
- Enumeration values
-
DenseHwc Dense, physically contiguous HWC heads (e.g. a Cast/dequant output) (= 0) PackedCBlock Channel-block packed / tessellated heads (e.g. a cblock detess output) (= 1)
For model-pack (Model-constructed) graphs this is resolved authoritatively from the model archive and must NOT be set by hand. For hand-built graphs that decode without a model pack (e.g. a Cast/detess stage stitched directly into SimaBoxDecode), the upstream contract does not carry the packing flags, so the value cannot be inferred and must be specified explicitly via the SimaBoxDecode constructor. When it is neither supplied by a model pack nor specified, contract compilation fails fast.
Definition at line 99 of file BoxDecodeType.h.
BoxDecodeType
| strong |
Decode families accepted by the BoxDecode backend.
- Enumeration values
Unspecified is an internal unset sentinel and must fail fast before runtime decode. Most YOLO-family variants share the same class-inference contract in genericboxdecode_v2:
- decoupled heads: repeated class-depth tensors, class depth > 4
- packed heads: depth = 3 * (num_classes + 5), consistent across heads YoloV26 uses decoupled 4-channel raw l/t/r/b bbox heads paired with class heads. YoloV26Seg uses the same raw l/t/r/b bbox heads, class-score heads, 32-channel mask-coefficient heads, and a trailing mask prototype. YoloV26Pose uses the same raw l/t/r/b bbox heads, 1-channel pose scores, and 51-channel keypoint heads.
Definition at line 37 of file BoxDecodeType.h.
BoxDecodeTypeOption
| strong |
Tensor packing/layout option within a decode family.
- Enumeration values
Some families admit multiple equivalent head layouts (packed vs interleaved, grouped by role, probability vs logit class scores). Auto lets the planner pick from observed tensor geometry; the explicit values force a particular decoding contract for ambiguous models.
Definition at line 74 of file BoxDecodeType.h.
FormatTag
| strong |
Identifies a media or tensor payload format.
- Enumeration values
Used in caps strings and option fields throughout the pipeline. Auto is the unset sentinel (let the framework pick or sniff). The EVXX_ variants are aliases preferred by the EV74 caps surface.
- See Also
Definition at line 36 of file FormatSpec.h.
OutputMemory
| strong |
How output Tensors relate to the underlying GStreamer buffers.
Auto lets the framework pick based on platform and pipeline shape. ZeroCopy shares storage with GStreamer (faster but lifetime-coupled to the Run). Owned copies into a framework-owned buffer (safer, slightly slower).
Definition at line 100 of file Run.h.
OverflowPolicy
| strong |
What push() does when the input queue is full.
- Enumeration values
-
Block push() blocks until queue space frees up. Lossless. Use for batch processing (= 0) KeepLatest Drop the oldest queued frame to make room DropIncoming Drop the new frame; keep what's queued
The right choice depends on the input source — file batches want lossless, live cameras want freshness, network feeds with chokepoint pipelines want bounded memory.
Definition at line 70 of file Run.h.
PullStatus
| strong |
Result status of Run::pull().
- Enumeration values
-
Ok A sample is available in the output parameter Timeout The wait elapsed without a sample arriving Closed The pipeline has reached EOS; no more samples will come Error A runtime error occurred; check the optional PullError
Definition at line 432 of file GraphOptions.h.
RunMode
| strong |
Internal timing mode a Run operates in.
- Enumeration values
-
Async Continuous pipeline; user pushes/pulls asynchronously Sync One frame in, one result out, synchronously
Public Graph users should not pass this into Graph::build(...): use Graph::build(...) for reusable push/pull runners and Graph::run(...) for one-shot execution. The runtime still keeps this enum to select internal optimized paths.
- See Also
Definition at line 195 of file GraphOptions.h.
RunPreset
| strong |
Convenience preset bundles for RunOptions.
- Enumeration values
-
Realtime Low-latency; small queues; KeepLatest overflow Balanced Default; moderate queues; Block overflow Reliable Lossless; deeper queues; Block overflow
Each preset adjusts queue depth, overflow policy, and output ownership to a profile that's known to work well for one workload class. Use start_measurement() when you want performance data for any preset.
Definition at line 86 of file Run.h.
SampleKind
| strong |
What kind of payload a Sample carries.
- Enumeration values
The framework's outputs come in three shapes depending on the model's output topology: a single Tensor, a flat list of Tensors (TensorSet), or a recursive Bundle of Samples (Bundle, used by multi-logical-output models).
- See Also
Definition at line 421 of file GraphOptions.h.
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.