Default Core Objects Plugin
Table of Contents
- 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 Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 adtf::ucom 3.1.0
- Component Information
Name Sample Stream CID default_sample_stream.streaming.adtf.cid Description The (Default) Sample Stream is the implementation of the adtf::streaming::cSampleStream. You can connect runners of filters at the bottom of the (Default) 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 (Default) Sample Stream.
Substream Selector
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 adtf::ucom 3.1.0
- Component Information
Name Substream Selector CID substream_selector.streaming.adtf.cid Description Sample stream implementation that filters a specific subtream. This will request the given substream at the connected source.
- 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 (Default) Sample Stream. substream cString The substream that should be filtered and requested.
Binding Proxy
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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 server object 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 binding proxy implementation to specialize and record the communication between the client/server calls.
RPC Runner
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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 connected runners by using RPC interfaces. See adtf::remote::IRPCActiveRunner.
- Required Interfaces
IID reference_clock.penguin.streaming.adtf.iid kernel.penguin.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 Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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 clock_source 0 tUInt32 The clock used for triggering the timer. Value List:
ADTF Stream Clock = 0
Monotonic = 1
Real Time = 2deadline_error_handling 4 tUInt32 Defines the default action for deadline and start instant miss errors: - ignore: do nothing.
- log: log the miss.
- stop: stop the session.
Value List:
ignore = 0
log = 4
stop = 8interval_miss_handling 0 tUInt32 Defines how to handle missed interval: - queue: try to catch up with the stream time.
- reschedule: reschedule all later calls.
- drop: drop all calls until catching up with the stream time.
Value List:
queue = 0
reschedule = 1
drop = 2maximum_execution_time 0 tInt64 The maximum allowed execution time in microseconds. 0 = unspecified scheduling/class 0 tUInt32 The scheduler that is used. Value List:
default = 0
normal = 1
realtime = 2scheduling/cpu_affinity cString A comma separated list of CPUs to which the thread affinity should be set. Empty = all scheduling/priority -1.000000 tFloat64 The priority in the range of 0.0 to 1.0. -1.0 = default priority from OS. Value Range:
minimum = -1.000000
maximum = 1.000000timer_period_micro_sec 100000 tInt64 The property value defines the period in micro second for the timer.
- Required Interfaces
IID reference_clock.penguin.streaming.adtf.iid kernel.penguin.services.adtf.iid
Thread Runner
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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 scheduling/class 0 tUInt32 The scheduler that is used. Value List:
default = 0
normal = 1
realtime = 2scheduling/cpu_affinity cString A comma separated list of CPUs to which the thread affinity should be set. Empty = all scheduling/priority -1.000000 tFloat64 The priority in the range of 0.0 to 1.0. -1.0 = default priority from OS. Value Range:
minimum = -1.000000
maximum = 1.000000thread_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.penguin.streaming.adtf.iid kernel.penguin.services.adtf.iid
Sample Stream Merger
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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
Signal Provider
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 adtf::ucom 3.1.0
- Component Information
Name Signal Provider CID signal_provider.streaming.adtf.cid Description Use this filter to provide data/signals from sample streams / substreams via the Signal Registry Service. Type Filter
- Properties
Name Value Type Description Subproperties array_size_limit 1024 tUInt64 Limit array types to at most this number of elements. Set to 0 to disable the limit. synchronous_signal_decoding true tBool If enabled, decoding of signals is delayed and queued until the Signal Registry Service contains the signals for a sample. If disabled, decoding is skipped on a per-substream basis while the Signal Registry Service is being initialized. Can be necessary if some complex streamtypes are introducing excessive delays.
- Dynamic Pins
Dynamic Input Pins true Dynamic Output Pins false Dynamic Input Binding Pins false Dynamic Output Binding Pins false
- Required Interfaces
IID signal_registry.flash.services.adtf.iid
Substream Assembler
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 adtf::ucom 3.1.0
- Component Information
Name Substream Assembler CID substream_assembler.streaming.adtf.cid Description Use this filter to assemble all its dynamic input sample streams as substreams on one output. Type Filter
- Output Pins
Name Stream Type Description substreams adtf/substreams Provides all dynamic input streams as individual substreams uniquely named after their input pin's name. E.g. input pins named 'a', 'b', 'c' will cause three substreams named 'a', 'b' and 'c'.
- 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 Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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
- 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 Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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. Please keep in mind that this filter will NOT request any substreams from the connected sources. 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 Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 adtf::ucom 3.1.0
- Component Information
Name Substream Reducer CID substream_reducer.streaming.adtf.cid Description Use this filter to output only a subset of the incoming substreams from the input sample stream. Please keep in mind that this filter will NOT request any substreams from the connected sources.
To make sure that the connected source(s) provides data for the given substreams either connect a 'Substream Requestor' to the output pin of this filter and/or make sure the any filter or sink that should handle these substreams does request them (i.e. by enabling the 'request_substreams' property if a 'ADTFDAT File Recorder' or 'Qt5 Media Description Display' is connected).
Type Filter
- Properties
Name Value Type Description Subproperties filter_file cFilename If set, each line of the given file will be used to match and select substreams according to 'filter_mode'. Note: Cannot be used in combination with property 'filter_string'. Launching will be declined when setting both properties! filter_mode 1 tUInt8 Chooses how the substreams are filtered. In 'prefix_trim' mode the prefix will be stripped from the substream name as well. Value List:
prefix = 2
prefix_trim = 1
regex = 4filter_string cString If set, substreams matching this string will be present in the output substream subset. Note: Cannot be used in combination with property 'filter_file'. Launching will be declined when setting both properties!
- Input Pins
Name Stream Type Description input adtf/substreams Sample stream containing substreams to create a subset of.
- Output Pins
Name Stream Type Description output adtf/substreams Provides the subset of substreams. 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.
- 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
Substream Requestor
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 adtf::ucom 3.1.0
- Component Information
Name Substream Requestor CID substream_requestor.streaming.adtf.cid Description Use this filter to request ALL substreams provided on the connected sample stream. This request will effect the source filter of the substreams, thus ALL other filters that are connected to the same source will also recieve the samples from all substreams available to this instance. To request a subset of all available substreams only, please use a 'Substream Reducer' filter before this filter. Type Filter
- Input Pins
Name Stream Type Description substreams adtf/substreams The input from which all substreams should be requested.
- 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 substreams Meta Type Name adtf/substreams Stream Type Properties Name Value Type Description Subproperties substreams true tBool
Thread Dispatcher
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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 ADTF 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
Thread Invoker
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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
- Properties
Name Value Type Description Subproperties max_processing_delay -1 tInt64 The maximum processing delay until the stream time is blocked during playback. -1 = none. Value Range:
minimum = -1
maximum = 9223372036854775807reschedule_triggers false tBool If enabled, behaves like a new trigger pipe. The current stream time will be used when forwarding triggers. If max_processing_delay is enabled, it is relative to the stream time at which the trigger arrives at the invoker.
If disabled, behaves like a continuation of the original trigger pipe. The original trigger timestamps will be used when forwarding triggers. If max_processing_delay is enabled, it is treated relative to the original trigger timestamp. If the original trigger was executed under a deadline constraint, max_processing_delay must be greater or equal to this constraint.
- 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
- Required Interfaces
IID reference_clock.penguin.streaming.adtf.iid
Thread Mapper
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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 ADTF 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
Thread Reducer
- Plugin Information
Plugin Filename default_core_objects.adtfplugin Plugin Description default_core_objects.plugindescription Plugin Name Default Core Objects Plugin License ADTF Support Mail support@digitalwerk.net Homepage URL https://support.digitalwerk.net/
- Plugin Versions
Plugin Version 3.16.2 Plugin File Version 1.0 adtf 3.16.2 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