- Introduction
This binary provides utilities and default implementations for Filters, Sample Streams, Active Runners and Binding Proxies for usage within Filter Graph.
Sample Stream
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Sample Stream |
CID | default_sample_stream.streaming.adtf.cid |
Description | The Sample Stream is the implementation of the adtf::streaming::cSampleStream. See Sample Stream for details. You can connect Runners of Filters at the bottom of the Sample Stream in order to execute them when a Data Trigger arrives. |
- Properties
Name | Value | Type | Description | Subproperties |
forward_all_triggers | true | tBool | true (default): all triggers will be forwarded, i.e. all Trigger Pipe Items will be called whenever a trigger is received. false: triggers will only be forwared if a new item (Stream Type / Sample) has been written to the Sample Stream. | |
Substream Selector
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Substream Selector |
CID | substream_selector.streaming.adtf.cid |
Description | Sample Stream Implementation that filters a specific Sub Stream. |
- Properties
Name | Value | Type | Description | Subproperties |
forward_all_triggers | false | tBool | true (default): all triggers will be forwarded, i.e. all Trigger Pipe Items will be called whenever a trigger is received. false: triggers will only be forwared if a new item (Stream Type / Sample) has been written to the Sample Stream. | |
substream | | cString | The substream that should be filtered. | |
Binding Proxy
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Binding Proxy |
CID | default_binding_proxy.streaming.adtf.cid |
Description | The Default Binding Proxy provides the opportunity to connect an IBindingServer with an IBindingClient. It will only check for a matching IBindingType and forward the ServerObject of the adtf::streaming::ant::IBindingServer::GetServerObject as an adtf::ucom::IObject. The check for compatibility is performed by the adtf::streaming::ant::IBindingClient or the Filter implementation. We will provide further BindingProxy implementation to specialize and record the communication between the Client/Server calls. |
RPC Runner
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | RPC Runner |
CID | rpc_runner.streaming.adtf.cid |
Description | Use this Active Runner to send a trigger to Runner by using RPC interfaces. See adtf::remote::IRPCActiveRunner. |
- Required Interfaces
IID |
reference_clock.osborn.streaming.adtf.iid |
kernel.devil.services.adtf.iid |
RPC Runner Usage
For a first usage, the example session Processing using RPC will show the basic functionality how use RPC trigger to process samples. The ADTF Control provides a call for sending triggers using a RPC Runner.
Timer Runner
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Timer Runner |
CID | default_timer_runner.streaming.adtf.cid |
Description | Active Runner which creates a thread that triggers all connected runners in a periodic manner at a specified interval |
- Properties
Name | Value | Type | Description | Subproperties |
timer_period_micro_sec | 100000 | tInt64 | The property value defines the period in micro second for the timer. | |
- Required Interfaces
IID |
reference_clock.osborn.streaming.adtf.iid |
kernel.devil.services.adtf.iid |
Thread Runner
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Thread Runner |
CID | default_thread_runner.streaming.adtf.cid |
Description | Active Runner which creates a thread that triggers all connected runners, by default, repeatedly without any delay |
- Properties
Name | Value | Type | Description | Subproperties |
thread_is_cyclic | true | tBool | true: The adtf::streaming::IRunner::Run call is executed until the IActiveRunner::Deactivate was called. false: The adtf::streaming::IRunner::Run call is executed only once. If it returns no further IRunner::Run call is submitted.Warning: If implementing an adtf::streaming::IRunner with endless loop, make sure it will return if an adtf::ucom::SetRunLevel() with adtf::ucom::IRuntime::RL_Application is requested to leave RL_Running. | |
- Required Interfaces
IID |
reference_clock.osborn.streaming.adtf.iid |
kernel.devil.services.adtf.iid |
Sample Stream Merger
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Sample Stream Merger |
CID | sample_stream_merger.streaming.adtf.cid |
Description | This filter merges multiple Sample Streams of the same type onto one output. |
Type | Filter |
- Output Pins
Name | Stream Type | Description |
output | default_core_objects_plugin_sample_stream_merger_streaming_adtf_cid_output | Provides the merged Sample Stream |
- Dynamic Pins
Dynamic Input Pins | true |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Output Pin Stream Types
Pin Name | output |
Meta Type Name | |
Stream Type Properties | |
Substream Assembler
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Substream Assembler |
CID | substream_assembler.streaming.adtf.cid |
Description | This filter assembles multiple inputs into Substreams on one output. |
Type | Filter |
- Output Pins
Name | Stream Type | Description |
substreams | adtf/substreams | Provides the collection of merged streams |
- Dynamic Pins
Dynamic Input Pins | true |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Output Pin Stream Types
Pin Name | substreams |
Meta Type Name | adtf/substreams |
Stream Type Properties |
Name | Value | Type | Description | Subproperties |
substreams | true | tBool | | |
|
Substream Dissector
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Substream Dissector |
CID | substream_dissector.streaming.adtf.cid |
Description | This filter dissects the input samples into seperate substreams that provide the data of the individual elements. |
Type | Filter |
- Properties
Name | Value | Type | Description | Subproperties |
create_struct_and_array_substreams | true | tBool | If activated, additional substreams will be created for all struct and array (sub-)elements. | |
ignore_unsupported_substreams | false | tBool | If enabled, input substreams without a valid media description will be ignored. | |
- Input Pins
Name | Stream Type | Description |
input | adtf/anonymous | input pin accepting either plain streams with a media description set or substreams. |
- Output Pins
Name | Stream Type | Description |
substreams | adtf/substreams | output pin providing each struct's signal as an individual substream |
- Runner
Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
process_input | 9 | 1 | input | 0 | 0 | 0 | 0 | Default runner port for the input pin 'input' |
- Dynamic Pins
Dynamic Input Pins | false |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Input Pin Stream Types
Pin Name | input |
Meta Type Name | adtf/anonymous |
Stream Type Properties | |
- Output Pin Stream Types
Pin Name | substreams |
Meta Type Name | adtf/substreams |
Stream Type Properties |
Name | Value | Type | Description | Subproperties |
substreams | true | tBool | | |
|
Substream Merger
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Substream Merger |
CID | substream_merger.streaming.adtf.cid |
Description | This filter merges Substreams from multiple inputs into Substreams on one output. |
Type | Filter |
- Properties
Name | Value | Type | Description | Subproperties |
pin_names_as_prefix | true | tBool | If true the substream names will be prefixed with the name of the input pin. | |
- Output Pins
Name | Stream Type | Description |
substreams | adtf/substreams | Provides the collection of merged substreams |
- Dynamic Pins
Dynamic Input Pins | true |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Output Pin Stream Types
Pin Name | substreams |
Meta Type Name | adtf/substreams |
Stream Type Properties |
Name | Value | Type | Description | Subproperties |
substreams | true | tBool | | |
|
Substream Reducer
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Substream Reducer |
CID | substream_reducer.streaming.adtf.cid |
Description | This filter outputs a subset of the Substreams from the input Sample Stream. Please keep in mind that this filter will forward all samples and only manipulate the Stream Type. So there may be samples transmitted that do not match any of the Substream IDs in the output stream type. |
Type | Filter |
- Properties
Name | Value | Type | Description | Subproperties |
filter | | cString | Only substreams matching this string will be present in the output Substream subset. | |
filter_mode | 0 | tUInt8 | Chooses how the streams are filtered. In 'prefix' mode the prefix will be stripped from the stream name as well. | Value List:
prefix = 0
regex = 1 |
- Input Pins
Name | Stream Type | Description |
input | adtf/substreams | A Substreams input. |
- Output Pins
Name | Stream Type | Description |
output | adtf/substreams | Provides the subset of Substreams. Please keep in mind that there may be samples transmitted that do not match any of the Substream IDs in the output stream type. |
- Runner
Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
process_input | 9 | 1 | input | 0 | 0 | 0 | 0 | Default runner port for the input pin 'input' |
- Dynamic Pins
Dynamic Input Pins | false |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Input Pin Stream Types
Pin Name | input |
Meta Type Name | adtf/substreams |
Stream Type Properties |
Name | Value | Type | Description | Subproperties |
substreams | true | tBool | | |
|
- Output Pin Stream Types
Pin Name | output |
Meta Type Name | adtf/substreams |
Stream Type Properties |
Name | Value | Type | Description | Subproperties |
substreams | true | tBool | | |
|
Thread Dispatcher
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Thread Dispatcher |
CID | thread_dispatcher.streaming.adtf.cid |
Description | This filter dispatches/distributes processing of sets of input samples/triggers to multiple threads. All samples corresponding to a trigger will be forwarded to exactly one thread only. |
Type | Filter |
- Properties
Name | Value | Type | Description | Subproperties |
delay_trigger_until_thread_ready | false | tBool | If activated the input trigger will be delayed until at least one processing thread is ready. Otherwise the trigger call returns immediately after all data has been put into the internal queue. | |
thread_count | 2 | tUInt32 | The number of threads that should process the input. Adjust this and then select 'Create Output and Runner Pins' from the context menu in the Configuration Editor. | |
- Input Pins
Name | Stream Type | Description |
input | adtf/anonymous | The input that should be distributed over all threads. |
- Runner
Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
process_input | 9 | 1 | input | 0 | 0 | 0 | 0 | Default runner port for the input pin 'input' |
- Dynamic Pins
Dynamic Input Pins | false |
Dynamic Output Pins | true |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Input Pin Stream Types
Pin Name | input |
Meta Type Name | adtf/anonymous |
Stream Type Properties | |
Thread Invoker
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Thread Invoker |
CID | thread_invoker.streaming.adtf.cid |
Description | This filter forwards/processes triggers asynchronously. When a data in trigger is recieved on its input, the processing thread is woken and starts forwarding samples and the trigger. |
Type | Filter |
- Input Pins
Name | Stream Type | Description |
input | adtf/anonymous | The input that should be processed asynchronously by the thread. |
- Output Pins
Name | Stream Type | Description |
output | default_core_objects_plugin_thread_invoker_streaming_adtf_cid_output | The output to which the samples and triggers are forwarded by the woken processing thread. |
- Runner
Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
process | 6 | 0 | | 1 | 1 | 0 | 0 | This should be connected to the active runner that will perform the processing. |
process_input | 9 | 1 | input | 0 | 0 | 0 | 0 | Default runner port for the input pin 'input' |
- Dynamic Pins
Dynamic Input Pins | false |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Input Pin Stream Types
Pin Name | input |
Meta Type Name | adtf/anonymous |
Stream Type Properties | |
- Output Pin Stream Types
Pin Name | output |
Meta Type Name | |
Stream Type Properties | |
Thread Mapper
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Thread Mapper |
CID | thread_mapper.streaming.adtf.cid |
Description | This filter maps processing of an input onto multiple threads. The Data In Trigger is delayed until all threads have processed the trigger. |
Type | Filter |
- Properties
Name | Value | Type | Description | Subproperties |
thread_count | 0 | tUInt32 | The number of threads that should process the input. Adjust this and then select 'Create Output and Runner Pins' from the context menu in the Configuration Editor. | |
- Input Pins
Name | Stream Type | Description |
input | adtf/anonymous | The input that should be processed by all threads. |
- Runner
Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
process_input | 9 | 1 | input | 0 | 0 | 0 | 0 | Default runner port for the input pin 'input' |
- Dynamic Pins
Dynamic Input Pins | false |
Dynamic Output Pins | true |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Input Pin Stream Types
Pin Name | input |
Meta Type Name | adtf/anonymous |
Stream Type Properties | |
Thread Reducer
- Plugin Information
-
- Plugin Versions
Plugin Version | 3.14.3 |
Plugin File Version | 1.0 |
adtf | 3.14.3 |
adtf::ucom | 3.1.0 |
- Component Information
Name | Thread Reducer |
CID | thread_reducer.streaming.adtf.cid |
Description | This filter triggers when all inputs have triggered at least once. The trigger is then sent and processed by the connected active runner. |
Type | Filter |
- Output Pins
Name | Stream Type | Description |
trigger | default_core_objects_plugin_thread_reducer_streaming_adtf_cid_trigger | A trigger will be sent on this pin once all inputs have triggered once. |
- Runner
Name | Activation Type | Data Triggered | Data Input | Thread Triggered | Thread Cyclic | Timer Triggered | Timer Interval | Description |
process | 6 | 0 | | 1 | 1 | 0 | 0 | This should be connected to the active runner that will perform the processing once all inputs sent a trigger. |
- Dynamic Pins
Dynamic Input Pins | true |
Dynamic Output Pins | false |
Dynamic Input Binding Pins | false |
Dynamic Output Binding Pins | false |
- Output Pin Stream Types
Pin Name | trigger |
Meta Type Name | |
Stream Type Properties | |