Namespace for the ADTF Streaming SDK. More...

Namespaces
namespace	ant
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.0.

namespace	catwo
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.2.

namespace	devil
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.3.

namespace	elasto
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.4.

namespace	flash
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.5.

namespace	giant
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.6.

namespace	hollow
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.7.

namespace	iron
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.8.

namespace	kiwi
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.10.

namespace	lucky
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.11.

namespace	penguin
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.15.

namespace	quiet
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.16.

namespace	spider
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.18.

namespace	stream_image_format
	Container namespace to predefine some common imageformats within ADTF - see also Generic Pixel Format.

namespace	testing
	Namespace for all testing functionality provided within the ADTF Streaming SDK.

namespace	thor
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.19.

Classes
class	binding_proxy
	This default class implementation will halp to define a Default InterfaceBindingProxy. More...

class	binding_type
	Binding type generation template to initialize a BindingType with the information of the INTERFACE type. More...

class	cActiveRunner
	Base class for implementing Active Runner. More...

class	cBindingClient
	Default Implementation of adtf::IDynamicBindingObject for one binding object that is able to connect to exactly one server object. More...

class	cBindingProxyInPort
	The Default implementation of the IBindingProxy interface. More...

class	cBindingProxyOutPort
	The Default implementation of the IBindingProxy interface. More...

class	cBindingServer
	Default Implementation of IBindingServer for a BindingObject that is able to connect to a IBindingProxy. More...

class	cBindingType
	The BindingType default implementation. More...

class	cCamelionStreamType

class	cConfigurableInPin

class	cConfigurableOutPin

class	cDefaultBindingProxy
	The Default implementation of the IBindingProxy interface. More...

class	cDynamicSampleReaderQueue
	Implementation of a ISampleReaderQueue with dynamic growing sample queue. More...

class	cExternalQueueSampleReader

class	cExternelQueueSampleReader
	Sample reader which allows the registration of external queue. More...

class	cFilterBase
	The cFilterBase class implements a basic filter that supports the IFilter interfaces. More...

class	cFilterGraph
	A Filter Graph that supports properties and property links. More...

class	cFilterGraphClientPort
	Default implementation of a ClientPort. More...

class	cFilterGraphDataInPort

class	cFilterGraphDataOutPort

class	cFilterGraphRunnerPort

class	cFilterGraphServerPort
	Default implementation of a ServerPort . More...

class	cGraph
	Default implementation for the IFilterGraph interface. More...

class	cInPin

class	cLastSamplesCollector

class	cNamedGraphObject

class	cNullReader
	A reader that does not read anything. More...

class	cOutPin

class	cReferenceSample
	Sample that uses samples buffers that do not copy the data, but only keep a reference to it. More...

class	cRunner
	Default and simple Runner implementation. More...

class	cSample
	The cSample class implements a basic sample which contains streaming data. More...

class	cSampleLogEntry
	Helper Wrapper Class to handle a Sample Log Entry. More...

class	cSampleLogEntryTransmitReceiveStateBuffer
	Helper Wrapper Class to handle the additional Data entry of the Log Event MSLEE_TransmitReceiveState . More...

class	cSampleReader
	The default Sample Reader will read the incomung Stream of a IInPin. More...

class	cSampleSetCollector

class	cSampleStream
	bring latest ant::cSampleStream to users scope More...

class	cSampleStreamingSink
	Basic implementation for a Streaming Sink. More...

class	cSampleStreamingSource
	Basic implementation for a Streaming Source. More...

class	cSampleStreamInPort
	bring latest quiet::cSampleStreamInPort to users scope More...

class	cSampleStreamOutPort
	bring latest quiet::cSampleStream to users scope More...

class	cSampleWriter
	This base implementation of a sample writer is samples and types to the given pin set at SetStreamerPin. More...

class	cStreamingGraph

class	cStreamItem
	Default implementation of an StreamItem as container of the Sample Stream s Queue. More...

class	cStreamMetaType
	Implements the default IStreamMetaType interface. More...

class	cStreamType
	Default StreamType implementation. More...

class	cTimeBasedSampleSetCollector

class	cWeakBindingServer
	Default Implementation of IBindingServer for a BindingObject that is able to connect to a IBindingProxy. More...

class	graph
	Generator Template to create a graph implementation. More...

class	graph_connection

class	IActiveRunner
	The Interface defines an Active Runner Intem which can be part of the IFilterGraph. More...

class	IBindingClient
	This interface defines a dynamic binding object. More...

class	IBindingObject
	This interface defines a dynamic binding object. More...

class	IBindingProxy
	This interface defines a dynamic binding object. More...

class	IBindingProxyInPort
	A Filter Graph will expect any stream from the outside world. More...

class	IBindingProxyOutPort
	A Filter Graph will send any stream to the outside world. More...

class	IBindingServer
	This interface defines a dynamic binding object. More...

class	IBindingType
	The Dynamic Binding type is to describe the IBindingType. More...

class	IDataBinding
	The IDataBinding interfaces provides methods for retrive information of the Pins published. More...

class	IDynamicDataBinding
	This interface extends the IDatabinding Interface to provide dynamic pin creation while connection are established within Streaming Graph and Filter Graph. More...

class	IDynamicInterfaceBinding
	This interface extends the IInterfaceBinding Interface to provide dynamic binding object creation while connection are established within Streaming Graph and Filter Graph. More...

class	IFilter
	The IFilter interfaces provides methods for controlling a filter. More...

class	IFilterGraph
	Defines the Interface used to connect Filters to each other. More...

class	IFilterGraphConnection
	Interface to describe a connection within the IFilterGraph. More...

class	IFilterGraphDataInPort
	Interface for a Filtergraph Data In Port that provides a IInPin as connectable item. More...

class	IFilterGraphDataOutPort
	Interface for a Filtergraph Data Out Port that provides a IOutPin as connectable item. More...

class	IFilterGraphDataPort
	Common interface for a FilterGraph Port that allows to connect to a IFilterGraph with SampleStreams. More...

class	IFilterGraphInterfaceClientPort
	Interface for a Filtergraph Client Port that provides a IBindingClient as connectable item. More...

class	IFilterGraphInterfacePort
	Common interface for a FilterGraph Port that allows to connect to a IFilterGraph with BindingObjects. More...

class	IFilterGraphInterfaceServerPort
	Interface for a Filtergraph Server Port that provides a IBindingServer as connectable item. More...

class	IFilterGraphPort
	Common interface for a FilterGraph Port that allows to connect to a IFilterGraph. More...

class	IFilterGraphRunnerPort
	Interface for a Filtergraph Runner Port that provides a IRunner as connectable item. More...

class	IGraph
	Defines the Interface used to connect Items to each other. More...

class	IGraphConnection
	Interface to describe a connection within the IGraph. More...

class	IInPin
	Type Interface for an InPin of the IDataBinding. More...

class	IInterfaceBinding
	The IInterfaceBinding provides an interface to implement and access a common dynamic binding object registry. More...

class	IInternalBindingProxy
	Interface for accessing an internal Interface Binding Proxy of a sample stream. More...

class	INamedGraphObject
	Interface for a NamedGraphObject which can be added to the FilterGraph. More...

class	interface_binding
	Template class for the default implementation of IInterfaceBinding. More...

class	IOutPin
	Type Interface for an OutPin of the IDataBinding. More...

class	IPin
	Pin Interface for the IDataBinding. More...

class	IRunner
	The Interface defines a runnable item of the GraphObjects providing a IRuntimeBehaviour. More...

class	IRuntimeBehaviour
	The RuntimeBehaviour interface is to clearly define a filters running entry points (IRunner) and their interconnection to each other (ITriggerPipe). More...

class	is_stream_meta_type
	type traits concept test template to check wether a type `T` is a type can be used for Stream Meta Type or not. More...

class	ISample
	The ISample interface sets and retrieves properties on samples . More...

class	ISampleBuffer
	The SampleBuffer is the memory block object for the data of a ISample. More...

class	ISampleBufferFactory
	The SampleBuffer factory manages and can create SampleBuffers. More...

class	ISampleInfo
	Interface for additional sample information on a Additional Sample Information. More...

class	ISampleInStream
	The ISampleInStream interface is return by the ISampleStream::Open call which allows to read from a corresponding reader of the opened ISampleStream instance. More...

class	ISampleOutStream
	The ISampleOutStream interface is return by the ISampleStream::Open call which allows to write into a corresponding writers queue of the opened ISampleStream instance. More...

class	ISampleReader
	Interface for sample reads that read from sample streams via input pins. More...

class	ISampleReaderQueue
	Interface to create a sample reader buffer. More...

class	ISampleSerialization
	Interface for serializing samples. More...

class	ISampleStream
	Interface of the SampleStream. More...

class	ISampleStreamAccess
	Access definiton for the ISampleStream::Open. More...

class	ISampleStreamer
	Base interface for sample readers and writers. More...

class	ISampleStreamingSink
	Interface for Streaming Sink. More...

class	ISampleStreamingSource
	Interface for Streaming Source. More...

class	ISampleStreamInPort
	A Filter Graph will expect any stream from the outside world. More...

class	ISampleStreamOutPort
	A Filter Graph will send any stream to the outside world. More...

class	ISampleWriter
	Interface for sample writers that write to sample streams via output pins. More...

class	IStreamingGraph
	Interface defintion for a Streaming Graph. More...

class	IStreamingInPort
	Streaming In Ports classifies a system border for incoming connections. More...

class	IStreamingOutPort
	Streaming Out Ports classifies a system border for outgoing connections. More...

class	IStreamingPort
	Streaming Ports are alias defintion for system borders. More...

class	IStreamingRequest
	This interface is used to keep a reference to a request. More...

class	IStreamingRequests
	Interface for handling streaming requests. More...

class	IStreamingService
	Basic sec_streaming_service interface to set the state of an IStreamingService. More...

class	IStreamingSink
	The Interface classifies a IStreamingService as Sink. More...

class	IStreamingSource
	The Interface classifies a IStreamingService as Source. More...

class	IStreamItem
	The IStreamItem interface is the base type for all object which are passed through a stream. More...

class	IStreamMetaType
	Defines access methods for a Stream Meta Type - see also Stream Type and Stream Meta Type for more information. More...

class	IStreamType
	Defines access methods for the interface of a Stream Type - see also Stream Type and Stream Meta Type for more information. More...

class	IStreamTypeHandler
	Interface for reacting synchrounously to stream type changes. More...

class	ITriggerPipe
	Interface a Trigger Pipe. More...

class	ITriggerPipeHierachy
	Interface for accessing the parent of a trigger pipe item. More...

class	ITriggerPipeItem
	Interface for objects which can participate a ITriggerPipe. More...

class	ITriggerPipeSource
	Interface that defines a TriggerPipeSource, which is able to send a Run (RUN::TIrgger) call to the registered TriggerPipeItems. More...

class	named_graph_object
	Default convenient implementation for INamedGraphObject. More...

class	output_sample_data
	Wrapper class that facilitates the handling of output samples. More...

class	requestable_writer
	Writer that registers a request broker (cRequestBroker) at the connected sample stream. More...

class	runtime_behaviour
	Default Class Template for a Runtime Behaviour implementation. More...

class	sample_data
	Easy data access for input samples of non trivial type @T (see Supported types for adtf_memory<T> for writing and reading Samples). More...

class	sample_reader
	Reads and stores Samples within the given queue implementation `INTERNAL_QUEUE`. More...

class	sample_stream
	Helper template to implement a ISampleStream or a ISampleStream derived interface. More...

class	sample_writer
	Specialized Sample Writer to write data of a given type `DATA_TYPE` (see Supported types for adtf_memory<T> for writing and reading Samples). More...

class	size_limited_sample_reader_queue

class	stream_meta_type
	Generator template stream_meta_type to create a StreamMetaType Class for the Type T. More...

struct	stream_meta_type_anonymous
	Use this Stream Meta Type only if no property should be set and you do not share and record these data. More...

struct	stream_meta_type_audio
	Use this Stream Meta Type for describing a audio stream with samples and sample rate. More...

struct	stream_meta_type_image
	Use this Stream Meta Type for describing a video stream with single frames and there format and set the values with set_stream_type_image_format. More...

struct	stream_meta_type_plain
	Use this Stream Meta Type if your sample data will be any of this type: bool, uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double or plain array T[], std::array, std::vector of them. More...

struct	stream_meta_type_string
	Use this Stream Meta Type if your sample data will be any of this type: std::string, std::u16string. More...

struct	stream_meta_type_substreams
	Use cSubStreamTypes to create a Stream Type instance for this Stream Meta Type - see also Substreams. More...

class	stream_type
	Generator template to implement a IStreamType based on a Stream Meta Type - see Stream Type and Stream Meta Type. More...

class	stream_type_anonymous
	Generator template to create an instance of a IStreamType class for stream_meta_type_anonymous ("adtf/anonymous"). More...

class	stream_type_audio
	Generator template to create an instance of a IStreamType class for stream_meta_type_audio ("adtf/audio"). More...

class	stream_type_image
	Generator template to create an instance of a IStreamType class for stream_meta_type_image ("adtf/image"). More...

class	stream_type_plain
	Generator template to create an instance of a IStreamType class for stream_meta_type_plain ("adtf/plaintype"). More...

class	stream_type_string
	Generator template to create an instance of a IStreamType class for stream_meta_type_string ("adtf/string"). More...

class	time_limited_sample_reader_queue

class	trigger_pipe_item
	Default implementation class template for a ITriggerPipeItem. More...

class	trigger_pipe_source
	Default implementation class template for a ITriggerPipeSource. More...

struct	tStreamAudioFormat
	Structure for Audio Format. More...

struct	tStreamImageFormat
	Simple Stream Type and Stream Meta Type definition for video frames or an image sequence as a convenience stucture. More...

Typedefs
template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>
using	time_limited_sample_reader
	The time_limited_sample_reader will create a sample reader which will create a internal sample queue that is time limited by the given `TimeRange`.

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>
using	size_limited_sample_reader
	The size_limited_sample_reader will create a sample reader which will create a internal sample queue that is sample count item limited by the given `TimeRange`.

using	cSingleSampleReader
	The cSingleSampleReader will create a sample reader which will create a internal sample queue with only one sample which holds the last received sample always.

using	cDynamicSampleReader
	The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size.

typedef adtf_util::string_base< cStreamFormatStorageType >	tStreamImageFormatName
	formatname type as stack string (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)

Functions
template<typename DATABINDING_BEHAVIOUR_CLASS, typename RUN_FUNC>
tResult	create_inner_pipe (DATABINDING_BEHAVIOUR_CLASS &oComponent, const adtf_util::cString &strNameOfRunner, const adtf_util::cString &strSource, RUN_FUNC oRunFunc)

template<typename Interface, typename InterfaceBinding>
tResult	create_server (InterfaceBinding &oInterfaceBinding, const char *strServerName, const adtf::ucom::iobject_ptr< Interface > &pServerInterface)
	Creates a binding server object for the given INTERFACE type and register it on the cFilterBase instance.

template<typename Interface, typename InterfaceBinding>
tResult	create_client (InterfaceBinding &oInterfaceBinding, const char *strClientName)
	Creates a binding client object for the given INTERFACE type and register it on the cFilterBase instance.

tResult	create_runner (cFilterBase &oFilter, const char *strNameOfRunner, adtf::base::ant::IRunnable &oRunnable)
	Creates a runner on the given cFilterBase and connect it to the given Runnable You only need to implement a Runnable.

tResult	add_piped_connections (IFilterGraph &oGraph, adtf_util::cStringList lstObjectNames, bool bSync=true)
	This is a helper function to create piped connections on the given FilterGraph instance `oGraph`.

tResult	add_paired_connections (IFilterGraph &oGraph, adtf_util::cStringList lstObjectNames, bool bSync=true)
	This is a helper function to create paired connections on the given FilterGraph instance `oGraph`.

tResult	get_filter_graph_object (const IFilterGraph &oGraph, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObject)
	Retrieve the first item of the Filter Graph where the iobject_ptr::Reset returns ERR_NO_ERROR If `pObject` is used with object_ptr this method will return the first object of given INTERFACE of object_ptr<INTERFACE>.

tResult	get_filter_graph_objects (const IFilterGraph &oGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &lstObjects)
	Iterates the named graph objects of the Filter Graph and calls iobject_enum::PushObject to the `lstObjects`.

tResult	get_named_graph_object_from_graph (IGraph &oGraph, const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObjectFound)
	Helper function to retrieve a graph object from a graph with fully qualified unique name of an object.

adtf_util::cString	get_named_graph_object_full_name (const INamedGraphObject &oGraphObject)
	Helper function to retrieve a full qualified unique name of an object registered in IFilterGraph.

void	set_description (base::ant::IConfiguration &oConfig, const char *strDescription)
	Sets description information.

void	set_editor (base::ant::IConfiguration &oConfig, const char strName, const char strUrl)
	Sets graph element editor information.

void	set_editors (base::ant::IConfiguration &oConfig, const std::vector< std::pair< std::string, std::string > > &oEditors)
	Sets multiple graph element editors.

void	set_help_link (base::ant::IConfiguration &oConfig, const char *strUrl)
	Set the link to the corresponding help/documentation.

void	set_description (base::ant::IConfiguration &oConfig, const char strItem, const char strDescription)
	Set the description for a specified item of the graph object.

std::string	get_help_link (base::ant::IConfiguration &oConfig)
	Get the link to the corresponding help/documentation set by set_help_link.

tResult	add_graph_object (ant::cGraph &oGraph, const util::cString &strCID, const util::cString &strName, const std::map< util::cString, util::cString > &oProperties, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pObject)
	Convenience functionality to create and add add graph object to a existing graph.

tResult	add_binding_proxy (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pBindingProxy)
	adds a Binding Proxy to a graph and return the created proxy.

tResult	add_data_in_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds an In Port to a graph and return the created port.

tResult	add_data_out_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds an Out Port to a graph and return the created port.

tResult	add_sample_stream (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pSampleStream)

tResult	add_sample_stream_in_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds a Stream In Port to a graph and return the created port.

tResult	add_sample_stream_out_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds a Stream Out Port to a graph and return the created port.

void	get_child_objects (ant::INamedGraphObject &oObject, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all child objects of the given `oObject`.

void	get_graph_objects (ant::IGraph *pGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all graph objects out of the `pGraph`.

void	get_runner_objects (ant::IRuntimeBehaviour *pRuntimeBehaviour, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all runner objects object out of `pRuntimeBehaviour`.

void	get_data_binding_objects (ant::IDataBinding *pDataBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &oObjects)
	Get all the data binding objects out of `pDataBinding`.

void	get_interface_binding_objects (ant::IInterfaceBinding *pInterfaceBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &oObjects)
	Get all the interface binding objects out of `pInterfaceBinding`.

template<typename Interface, typename InterfaceBinding>
tResult	create_weak_binding_server (InterfaceBinding &oInterfaceBinding, const char *strName, const ucom::ant::iobject_ptr< Interface > &pObject)
	This method creates and registers a new weak binding server (cWeakBindingServer) object.

template<typename DATA_BINDING_IMPL_TYPE, typename READER_OR_WRITER, typename PIN_INTERFACE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, READER_OR_WRITER &oStreamer, ucom::ant::iobject_ptr< PIN_INTERFACE > &pCreatedPin)

tResult	alloc_sample (ucom::ant::iobject_ptr< ucom::ant::IObject > &pSample)
	Helper Function to get a ISample Instance through the IRuntime.

base::flash::tNanoSeconds	get_sample_time (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)
	Returns the sample time stamp with nanosecond precision.

base::flash::tNanoSeconds	get_sample_time (const ant::ISample &oSample)
	Returns the sample timestamp with nanosecond precision.

void	set_sample_time (const ucom::ant::iobject_ptr< ant::ISample > &pSample, base::flash::tNanoSeconds tmTimeStamp)
	Sets the sample timestamp with nanosecond precision.

void	set_sample_substream_id (ant::ISample &oSample, uint32_t nSubStreamId)
	Sets the substream id of a given sample.

uint32_t	get_sample_substream_id (const ant::ISample &oSample)

template<typename T>
tResult	read_from_sample (const ISample &oSample, T &oValue)
	Helper to read the value `oValue` from the sample `oSample`.

template<typename T>
tResult	write_to_sample (ISample &oSample, const T &oValue)
	Helper to write the value `oValue` to the sample `oSample`.

tResult	get_default_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)
	Creates and gets the default buffer factory (ISampleBufferFactory) based on new/delete.

tResult	get_reference_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)
	Creates and gets the a buffer factory that creates sample buffers that do not copy the data, but only keep a reference to it.

adtf::util::cVariant	get_sample_info (const ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oDefault)
	Retrieves a variant value for the hash key `oHash` out of the sample information `oSampleInfo` .

tResult	set_sample_info (ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oValue)
	Sets a variant value for the hash key `oHash` into the sample information `oSampleInfo`.

ISampleInfo::tHashKey	create_sample_info_hash_key (const char *strToHash)
	Generation of unambigious hash key for a string.

tResult	make_sample_reader (ISampleReader &oReader, const char *strNameOfReader, const ucom::iobject_ptr< const IStreamType > &pStreamType)

tResult	make_sample_writer (ISampleWriter &oWriter, const char *strNameOfWriter, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)

bool	stream_image_format_is_generic_rgb (const tStreamImageFormat &strFormat)
	Check if R, G and B components are available in Generic Pixel Format.

bool	stream_image_format_is_generic (const tStreamImageFormat &strFormat)
	Check if all bits are well defined and at least one component is available in Generic Pixel Format.

unsigned int	stream_image_format_get_generic_pixel_size (const tStreamImageFormat &strFormat)
	Retrieves the pixelsize by a Generic Pixel Format.

uint32_t	stream_image_format_get_generic_mask (const char *strChannel, const tStreamImageFormat &strFormat)
	Retrieves the pixelsize by a Generic Pixel Format.

template<typename WRITER_TYPE>
WRITER_TYPE &	flush (WRITER_TYPE &oWriter)
	Global function template to flush a writer.

template<typename WRITER_TYPE>
WRITER_TYPE &	trigger (WRITER_TYPE &oWriter)
	Global function template to trigger a writers sample stream manually.

tResult	get_streaming_graph_object (const IStreamingGraph &oGraph, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObject)
	Retrieve the first item of the Streaming Graph where the iobject_ptr::Reset returns ERR_NOERROR If `pObject` is used with object_ptr this method will return the first object of given INTERFACE of object_ptr<INTERFACE>.

tResult	get_streaming_graph_objects (const IStreamingGraph &oGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &lstObjects)
	Retrieve all items of the Streaming Graph where the iobject_ptr::Reset returns ERR_NOERROR.

tResult	set_stream_type_audio_format (IStreamType &oType, const tStreamAudioFormat &sFormat)
	sets the audio format properties within the stream type if meta type "adtf/audio" is set

tResult	get_stream_type_audio_format (tStreamAudioFormat &sFormat, const IStreamType &oType)
	retrievs the audio format from the properties of the stream type if meta type "adtf/audio" is set.

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_audio_stream_type ()
	Convinience functionality to create a stream type audio - see Stream Meta Type "adtf/audio".

tResult	set_stream_type_image_format (IStreamType &oType, const tStreamImageFormat &oFormat)
	Helper function to set the properties of a IStreamType for a stream_meta_type_image.

tResult	get_stream_type_image_format (tStreamImageFormat &oFormat, const IStreamType &oType)
	Helper function to retrieve the `oFormat` (tStreamImageFormat) out of the of a IStreamType for a stream_meta_type_image.

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_image_stream_type ()
	Convenience functionality to create a stream type image - see sec_stream_type_image.

template<typename T>
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_plain_stream_type ()
	brings latest create_adtf_plain_stream_type to the users scope

template<typename VALUETYPE>
VALUETYPE	get_property (const IStreamType &oStreamType, const char *strNameOfValue, VALUETYPE oDefaultValue)
	Gets the property of the given `oStreamType`.

template<typename VALUETYPE>
tResult	set_property (IStreamType &oStreamType, const char *strNameOfValue, VALUETYPE oValue)
	Sets the property of the given `oStreamType` to the value `oValue`.

tResult	is_compatible (const ant::IStreamType &oCheckedType, const ant::IStreamType &oExpectedType)
	Checks whether `oCheckedType` is compatible with `oExpectedType`.

tResult	is_equal (const ant::IStreamType &oLeftType, const ant::IStreamType &oRightType)
	Check if two stream types are equal.

tResult	create_trigger_pipe (const char *strNameOfPipe, adtf::ucom::ant::iobject_ptr< ITriggerPipe > &pTriggerPipe, adtf::ucom::ant::object_list< ITriggerPipeItem > lstNextItems)
	Creates a Trigger Pipe with given items in `lstNextItems`.

tResult	check_loop_call_in_trigger_pipe (const adtf::streaming::ant::ITriggerPipeSource &pItem)
	Checks a loop call in Trigger Pipe can be created with pItem and all registered subitems.

template<typename ObjectType>
bool	has_trigger_parent (const ObjectType *pChild)
	bring latest riddler::has_parent to users scope

Detailed Description

Namespace for the ADTF Streaming SDK.

Within this namespace all interfaces, classes and functions always refer to their last revised implementation. When using types defined within this namespace it is guaranteed to always use the latest version of the types.

Typedef Documentation

◆ cDynamicSampleReader

using cDynamicSampleReader

The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size.

Remarks: Make sure a a sample receive callback will read until the queue is empty !

This implementation uses the cDynamicSampleReaderQueue as dynamic sample queue implementation.

Definition at line 1094 of file samplereader.h.

◆ cSingleSampleReader

using cSingleSampleReader

The cSingleSampleReader will create a sample reader which will create a internal sample queue with only one sample which holds the last received sample always.

Definition at line 1115 of file samplereader.h.

◆ size_limited_sample_reader

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>

using size_limited_sample_reader

The size_limited_sample_reader will create a sample reader which will create a internal sample queue that is sample count item limited by the given TimeRange.

Template Parameters

MAX_SIZE	The count in amount of samples (has to be set while compile time!).
STORELASTSAMPLE	Option if the last sample received will be hold. true - last sample is stored false - last sample is droped if after Read call

Definition at line 1109 of file samplereader.h.

◆ time_limited_sample_reader

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>

using time_limited_sample_reader

The time_limited_sample_reader will create a sample reader which will create a internal sample queue that is time limited by the given TimeRange.

Template Parameters

TIME_RANGE	The timerange in micro seconds (has to be set while compile time!).
STORELASTSAMPLE	Option if the last sample received will be hold. true - last sample is stored false - last sample is droped if after Read call

Definition at line 1102 of file samplereader.h.

◆ tStreamImageFormatName

typedef adtf_util::string_base<cStreamFormatStorageType> tStreamImageFormatName

formatname type as stack string (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)

Definition at line 23 of file streamimageformat.h.

Function Documentation

◆ add_binding_proxy()

tResult add_binding_proxy	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pBindingProxy )

inline

adds a Binding Proxy to a graph and return the created proxy.

Parameters

oGraph	The graph where to add the Binding Proxy to.
strName	Name of the Binding Proxy within the graph
nOrderNumber	The order numer of the new Binding Proxy.
pBindingProxy	Return value for the instance of the Binding Proxy created.

Returns: tResult

Definition at line 117 of file graph_utils.h.

◆ add_data_in_port()

tResult add_data_in_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds an In Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the In Port to.
strName	Name of the In Port within the graph
nOrderNumber	The order numer of the new In Port.
pPort	Return value for the instance of the port created.

Returns: tResult

Definition at line 184 of file graph_utils.h.

◆ add_data_out_port()

tResult add_data_out_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds an Out Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the Out Port to.
strName	Name of the Out Port within the graph.
nOrderNumber	The order numer of the new Out Port.
pPort	Return value for the instance of the port created.

Returns: tResult

Definition at line 149 of file graph_utils.h.

◆ add_graph_object()

tResult add_graph_object	(	ant::cGraph &	oGraph,
		const util::cString &	strCID,
		const util::cString &	strName,
		const std::map< util::cString, util::cString > &	oProperties,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pObject )

inline

Convenience functionality to create and add add graph object to a existing graph.

Parameters

oGraph	The Graph where to add the object.
strCID	The class interface name of class to create the object.
strName	The name of the object within the graph.
oProperties	The properties to set.
nOrderNumber	the order number of the object
pObject	Return value for the instance of the object created.

Returns: tResult

Definition at line 39 of file graph_utils.h.

◆ add_paired_connections()

tResult add_paired_connections	(	IFilterGraph &	oGraph,
		adtf_util::cStringList	lstObjectNames,
		bool	bSync = true )

This is a helper function to create paired connections on the given FilterGraph instance oGraph.

For each item[N] of lstObjectNames a cFilterGraph::AddConnection call is created with the source item[N] and the destination item[N+1]. N is a multiple of 2.

The names within lstObjectNames must be named graph objects of the FilterGraph oGraph.

Parameters

[in]	oGraph	Graph instance where to add the connections to.
[in]	lstObjectNames	The names of the named graph objects to connect.
[in]	bSync	Determines if the connections will be synchronous or asynchronous.

Returns: Standard Result Code - depends on the cFilterGraph::AddConnection return value.

Return values

ERR_NOT_FOUND There is a name in lstObjectNames which is not a object of oGraph.

◆ add_piped_connections()

tResult add_piped_connections	(	IFilterGraph &	oGraph,
		adtf_util::cStringList	lstObjectNames,
		bool	bSync = true )

This is a helper function to create piped connections on the given FilterGraph instance oGraph.

For each item[N] of lstObjectNames a cFilterGraph::AddConnection call is created with the source item[N] and the destination item[N+1]. The names within lstObjectNames must be named graph objects of the FilterGraph oGraph.

Parameters

[in]	oGraph	Graph instance where to add the connections to.
[in]	lstObjectNames	The names of the named graph objects to connect.
[in]	bSync	Determines if the connections will be synchronous or asynchronous.

Returns: Standard Result Code - depends on the cFilterGraph::AddConnection return value.

Return values

ERR_NOT_FOUND There is a name in lstObjectNames which is not a object of oGraph.

◆ add_sample_stream()

tResult add_sample_stream	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pSampleStream )

inline

Definition at line 82 of file graph_utils.h.

◆ add_sample_stream_in_port()

tResult add_sample_stream_in_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		const util::cString &	strPortID,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds a Stream In Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the Stream In Port to.
strName	Name of the Stream In Port within the graph
strPortID	Port ID as it appears in the streaming graph
nOrderNumber	The order numer of the new Stream In Port.
pPort	Return value for the instance of the port created.

Returns: tResult

Definition at line 259 of file graph_utils.h.

◆ add_sample_stream_out_port()

tResult add_sample_stream_out_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		const util::cString &	strPortID,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds a Stream Out Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the Stream Out Port to.
strName	Name of the Stream Out Port within the graph
strPortID	Port ID As it appears in the streaming graph
nOrderNumber	The order numer of the new Stream Out Port.
pPort	Return value for the instance of the port created.

Returns: tResult

Definition at line 220 of file graph_utils.h.

◆ alloc_sample()

tResult alloc_sample ( ucom::ant::iobject_ptr< ucom::ant::IObject > & pSample )

Helper Function to get a ISample Instance through the IRuntime.

Parameters

pSample [in, out] object_ptr to a ISample if succeeded. The default CID will be the get_class_id<cSample>().

Returns: Standard result code.

Note: rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

Referenced by encoding_sample_writer< WriterImplementation >::MakeSample(), sample_writer< DATA_TYPE >::Transmit(), and cTestWriter::WriteSubStream().

◆ check_loop_call_in_trigger_pipe()

tResult check_loop_call_in_trigger_pipe ( const adtf::streaming::ant::ITriggerPipeSource & pItem )

Checks a loop call in Trigger Pipe can be created with pItem and all registered subitems.

Parameters

[in] pItem beginning source item of the pipe.

Returns: Standard Result Code

Return values

ERR_NOERROR	No loop found. Everything is fine.
ERR_OUT_OF_RANGE	Endless Recursion found, there is a item which will call itself as child (also in depth > 1)!

◆ create_adtf_audio_stream_type()

ucom::ant::object_ptr< ant::IStreamType > create_adtf_audio_stream_type ( )

inline

Convinience functionality to create a stream type audio - see Stream Meta Type "adtf/audio".

Returns: created streamtype

See also: stream_type_audio

Definition at line 195 of file streammetatypeaudio.h.

◆ create_adtf_image_stream_type()

ucom::ant::object_ptr< ant::IStreamType > create_adtf_image_stream_type ( )

inline

Convenience functionality to create a stream type image - see sec_stream_type_image.

Returns: the created type

See also: stream_type_image

Definition at line 145 of file streammetatypeimage.h.

◆ create_adtf_plain_stream_type()

template<typename T>

ucom::ant::object_ptr< ant::IStreamType > create_adtf_plain_stream_type ( )

brings latest create_adtf_plain_stream_type to the users scope

Definition at line 410 of file streammetatypeplain.h.

◆ create_client()

template<typename Interface, typename InterfaceBinding>

tResult create_client	(	InterfaceBinding &	oInterfaceBinding,
		const char *	strClientName )

Creates a binding client object for the given INTERFACE type and register it on the cFilterBase instance.

Template Parameters

Interface	The IObject interface you want to register the binding client object for
InterfaceBinding	The class of the interface binding object

Parameters

[in]	oInterfaceBinding	Interfacebinding instance to register the client object to
[in]	strClientName	name of the object to register

Returns: Standard Result Code

Definition at line 323 of file filterbase.h.

◆ create_inner_pipe()

template<typename DATABINDING_BEHAVIOUR_CLASS, typename RUN_FUNC>

tResult create_inner_pipe	(	DATABINDING_BEHAVIOUR_CLASS &	oComponent,
		const adtf_util::cString &	strNameOfRunner,
		const adtf_util::cString &	strSource,
		RUN_FUNC	oRunFunc )

Definition at line 265 of file filterbase.h.

◆ create_pin()

template<typename DATA_BINDING_IMPL_TYPE, typename READER_OR_WRITER, typename PIN_INTERFACE>

tResult create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		READER_OR_WRITER &	oStreamer,
		ucom::ant::iobject_ptr< PIN_INTERFACE > &	pCreatedPin )

Definition at line 175 of file pin_creation.h.

◆ create_runner()

tResult create_runner	(	cFilterBase &	oFilter,
		const char *	strNameOfRunner,
		adtf::base::ant::IRunnable &	oRunnable )

inline

Creates a runner on the given cFilterBase and connect it to the given Runnable You only need to implement a Runnable.

See also: adtf::base::runnable; adtf::base::IRunnable; sec_filter

Returns: Standard Result Code

Definition at line 249 of file filterbase.h.

◆ create_sample_info_hash_key()

ISampleInfo::tHashKey create_sample_info_hash_key ( const char * strToHash )

Generation of unambigious hash key for a string.

This generation is independent to process and platform.

Parameters

[in] strToHash null terminated string to generate a hash key for.

Returns: Hash key for strToHash.

◆ create_server()

template<typename Interface, typename InterfaceBinding>

tResult create_server	(	InterfaceBinding &	oInterfaceBinding,
		const char *	strServerName,
		const adtf::ucom::iobject_ptr< Interface > &	pServerInterface )

Creates a binding server object for the given INTERFACE type and register it on the cFilterBase instance.

Template Parameters

Interface	The IObject interface you want to register the binding client object for
InterfaceBinding	The class of the interface binding object

Parameters

[in]	oInterfaceBinding	interfacebinding instance to register the server object to
[in]	strServerName	name of the object to register
[in]	pServerInterface	INTERFACE implementation instance. This will be the Server Object retrieved by IBindingClient::GetServerObject and IBindingProxy::GetServerObject

Returns: Standard Result Code

Definition at line 302 of file filterbase.h.

◆ create_trigger_pipe()

tResult create_trigger_pipe	(	const char *	strNameOfPipe,
		adtf::ucom::ant::iobject_ptr< ITriggerPipe > &	pTriggerPipe,
		adtf::ucom::ant::object_list< ITriggerPipeItem >	lstNextItems )

Creates a Trigger Pipe with given items in lstNextItems.

Parameters

[in]	strNameOfPipe	Name of pipe.
[out]	pTriggerPipe	reference to the pipe if created. (you need to hold the reference, otherwise the pipe is closed!)
[in]	lstNextItems	Items which will be connected to each other as pipe. Each Item[N+1] is registered as subitem of Item[N] by calling ITriggerPipeSource::RegisterSubItem.

Returns: Standard Result Code

Return values

ERR_NOERROR	No loop found. Everything is fine.
ERR_OUT_OF_RANGE	Endless Recursion found, there is a item which will call itself as child (also in depth > 1)!

See also: page_trigger_pipe

◆ create_weak_binding_server()

template<typename Interface, typename InterfaceBinding>

tResult create_weak_binding_server	(	InterfaceBinding &	oInterfaceBinding,
		const char *	strName,
		const ucom::ant::iobject_ptr< Interface > &	pObject )

This method creates and registers a new weak binding server (cWeakBindingServer) object.

Parameters

[in]	oInterfaceBinding	The interface binding implmentation to register the object at.
[in]	strName	The name of the server object.
[in]	pObject	The object that implements the given interface. Only a weak reference to this object will be stored.

Returns: Standard result.

Definition at line 203 of file interface_binding_object.h.

◆ flush()

template<typename WRITER_TYPE>

WRITER_TYPE & flush ( WRITER_TYPE & oWriter )

Global function template to flush a writer.

Template Parameters

WRITER_TYPE Type or sub class of cSampleWriter

Returns: Returns the flushed streamer

See also: cSampleWriter

Definition at line 22 of file streaming_functions.h.

◆ get_child_objects()

void get_child_objects	(	ant::INamedGraphObject &	oObject,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	oObjects )

inline

Get all child objects of the given oObject.

Parameters

oObject	the object has childrens
oObjects	all child objects

Definition at line 375 of file graph_utils.h.

◆ get_data_binding_objects()

void get_data_binding_objects	(	ant::IDataBinding *	pDataBinding,
		ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &	oObjects )

inline

Get all the data binding objects out of pDataBinding.

Parameters

pDataBinding	The Data binding object to retrieve the binding objects from
oObjects	list of objects returned

Definition at line 299 of file graph_utils.h.

◆ get_default_buffer_factory()

tResult get_default_buffer_factory ( adtf::ucom::iobject_ptr< ISampleBufferFactory > & pFactory )

Creates and gets the default buffer factory (ISampleBufferFactory) based on new/delete.

The ISampleBuffer returned by the ISampleBufferFactory::GetBuffer will use new / delete on each ISampleBufferFactory::Resize call.

Parameters

[out] pFactory The factory returned

Returns: Standard Result Code

Return values

ERR_POINTER	The factory could not be created due memory allocation error.
ERR_INVALID_INTERFACE	The given `pFactory` did not accept the adtf::ucom::iobject_ptr::Reset call.

◆ get_filter_graph_object()

tResult get_filter_graph_object	(	const IFilterGraph &	oGraph,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObject )

Retrieve the first item of the Filter Graph where the iobject_ptr::Reset returns ERR_NO_ERROR If pObject is used with object_ptr this method will return the first object of given INTERFACE of object_ptr<INTERFACE>.

Sub Graphs are considered.

 // ...
 adtf::ucom::object_ptr<adtf::streaming::IFilterGraph> pFilterGraph;
 adtf::services::get_session_filtergraph(pFilterGraph);
 adtf::ucom::object_ptr<IFilter> pFirstFoundFilter;
 get_filter_graph_object(*pFilterGraph, pFirstFoundFilter);
// ...

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	pObject	The object reference to return the value.

Return values

ERR_NOT_FOUND	iobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_ptr::Reset returned ERR_NOERROR, consider pObject

See also: get_session_filter_graph to retrieve the current Filter Graph.

◆ get_filter_graph_objects()

tResult get_filter_graph_objects	(	const IFilterGraph &	oGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	lstObjects )

Iterates the named graph objects of the Filter Graph and calls iobject_enum::PushObject to the lstObjects.

If lstObjects is used with object_list this method will return all object of given INTERFACE of object_list<INTERFACE>. Sub Graphs are considered.

// ...
adtf::ucom::object_ptr<adtf::streaming::IFilterGraph> pFilterGraph;
adtf::services::get_session_filtergraph(pFilterGraph);
adtf::ucom::object_list<IFilter> lstOfFilters;
get_filter_graph_objects(*pFilterGraph, lstOfFilters);
// ...

Parameters

[in]	oGraph	Graph to retrieve the objects from.
[in,out]	lstObjects	The object list to push the values to.

Return values

ERR_NOT_FOUND	iobject_enum::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_enum::Reset returned ERR_NOERROR, consider pObject

See also: get_session_filter_graph to retrieve the current Filter Graph.

◆ get_graph_objects()

void get_graph_objects	(	ant::IGraph *	pGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	oObjects )

inline

Get all graph objects out of the pGraph.

Parameters

pGraph	the Graph where to get the grpah objects from
oObjects	the list of graph objects to return

Definition at line 357 of file graph_utils.h.

◆ get_help_link()

std::string get_help_link ( base::ant::IConfiguration & oConfig )

Get the link to the corresponding help/documentation set by set_help_link.

Parameters

[in] oConfig The configuration instance where the help link might be stored

Returns: The help link if set. Emtpy if not found.

◆ get_interface_binding_objects()

void get_interface_binding_objects	(	ant::IInterfaceBinding *	pInterfaceBinding,
		ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &	oObjects )

inline

Get all the interface binding objects out of pInterfaceBinding.

Parameters

pInterfaceBinding	The Interface binding object to retrieve the binding objects from
oObjects	list of objects returned

Definition at line 316 of file graph_utils.h.

◆ get_named_graph_object_from_graph()

tResult get_named_graph_object_from_graph	(	IGraph &	oGraph,
		const char *	strName,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObjectFound )

Helper function to retrieve a graph object from a graph with fully qualified unique name of an object.

Parameters

[in]	oGraph	The graph instance to get the object from.
[in]	strName	The fully qualified named with dots (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")
[in,out]	pObjectFound	The object to retrieve

Returns: ...

Remarks: Expensive recursive call !!

◆ get_named_graph_object_full_name()

adtf_util::cString get_named_graph_object_full_name ( const INamedGraphObject & oGraphObject )

Helper function to retrieve a full qualified unique name of an object registered in IFilterGraph.

Parameters

[in] oGraphObject The object to retrieve the fullname for.

Returns: The full qualified name of the object. (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")

Remarks: Expensive recursive call !!

◆ get_property()

template<typename VALUETYPE>

VALUETYPE get_property	(	const IStreamType &	oStreamType,
		const char *	strNameOfValue,
		VALUETYPE	oDefaultValue )

Gets the property of the given oStreamType.

Template Parameters

VALUETYPE Type of value returned and oDefaultValue

Parameters

[in]	oStreamType	StreamType where to get the property
[in]	strNameOfValue	name of the property
[in]	oDefaultValue	default value of property if not found.

Returns: the value of the property

Definition at line 294 of file streamtype_intf.h.

Referenced by adtf::streaming::lucky::get_stream_type_audio_format().

◆ get_reference_buffer_factory()

tResult get_reference_buffer_factory ( adtf::ucom::iobject_ptr< ISampleBufferFactory > & pFactory )

Creates and gets the a buffer factory that creates sample buffers that do not copy the data, but only keep a reference to it.

Use this with EXTREME care!! Keep samples that use these buffers in a weak_object_ptr in order to be able to check if they no longer exist before you manipulate the data again.

Parameters

[out] pFactory The factory returned

Returns: Standard Result Code

Return values

ERR_POINTER	The factory could not be created due memory allocation error.
ERR_INVALID_INTERFACE	The given `pFactory` did not accept the adtf::ucom::iobject_ptr::Reset call.

◆ get_runner_objects()

void get_runner_objects	(	ant::IRuntimeBehaviour *	pRuntimeBehaviour,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	oObjects )

inline

Get all runner objects object out of pRuntimeBehaviour.

Parameters

pRuntimeBehaviour	the runtime behaviour
oObjects	the list of runner objects returned

Definition at line 333 of file graph_utils.h.

◆ get_sample_info()

adtf::util::cVariant get_sample_info	(	const ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oDefault )

Retrieves a variant value for the hash key oHash out of the sample information oSampleInfo .

If the value does not exists the return value is the given defaultoDefault.

Parameters

[in]	oSampleInfo	The sample information to retrieve the value from.
[in]	oHash	The hash key of the value.
[in]	oDefault	default value if value does not exist.

Returns: retrieved value as variant.

◆ get_sample_substream_id()

uint32_t get_sample_substream_id ( const ant::ISample & oSample )

Parameters

[in] oSample The sample to retrieve the substream id from.

Returns: the substream id of the given sample.

Referenced by adtf::streaming::hollow::get_sample_substream_id().

◆ get_sample_time() [1/2]

base::flash::tNanoSeconds get_sample_time ( const ant::ISample & oSample )

Returns the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the microseconds timestamp if not.

Parameters

oSample The sample.

Returns: The timestamp.

◆ get_sample_time() [2/2]

base::flash::tNanoSeconds get_sample_time ( const ucom::ant::iobject_ptr< const ant::ISample > & pSample )

Returns the sample time stamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the microseconds timestamp if not.

Parameters

[in] pSample The sample.

Returns: The timestamp.

Referenced by cGraphObject::CreateInputPinWithCallback(), decoding_sample_reader< ReaderImplementation >::GetLastDecoder(), decoding_sample_reader< ReaderImplementation >::GetLastDecoder(), decoding_sample_reader< ReaderImplementation >::GetNextDecoder(), decoding_sample_reader< ReaderImplementation >::GetNextDecoder(), sample_data< T, Enable >::GetTimeNs(), and cSampleQueueCompareByTime::operator()().

◆ get_stream_type_audio_format()

tResult get_stream_type_audio_format	(	tStreamAudioFormat &	sFormat,
		const IStreamType &	oType )

inline

retrievs the audio format from the properties of the stream type if meta type "adtf/audio" is set.

Parameters

sFormat	The Audio format
oType	The Stream Type where to retrieve the properties from

Returns: tResult

Return values

ERR_NOERROR	Everything went fine
ERR_INVALID_TYPE	the given oType is not a instance of stream meta type "adtf/audio"

Definition at line 171 of file streammetatypeaudio.h.

◆ get_stream_type_image_format()

tResult get_stream_type_image_format	(	tStreamImageFormat &	oFormat,
		const IStreamType &	oType )

Helper function to retrieve the oFormat (tStreamImageFormat) out of the of a IStreamType for a stream_meta_type_image.

Parameters

oType	Stream Type where to get the properties from
oFormat	Format to set the properties content to.

Returns: tResult

See also: stream_meta_type_image

◆ get_streaming_graph_object()

tResult get_streaming_graph_object	(	const IStreamingGraph &	oGraph,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObject )

Retrieve the first item of the Streaming Graph where the iobject_ptr::Reset returns ERR_NOERROR If pObject is used with object_ptr this method will return the first object of given INTERFACE of object_ptr<INTERFACE>.

The embedded Filter Graph is not considered.

 // ...
 adtf::ucom::object_ptr<adtf::streaming::IStreamingGraph> pStreamingGraph;
 adtf::services::get_session_streaming_graph(pStreamingGraph);
 adtf::ucom::object_ptr<ISampleStreamingSource> pFirstFoundSource;
 get_streaming_graph_object(*pFilterGraph, pFirstFoundSource);
// ...

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	pObject	The object reference to return the value.

Return values

ERR_NOT_FOUND	iobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_ptr::Reset returned ERR_NOERROR, consider pObject

See also: tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

◆ get_streaming_graph_objects()

tResult get_streaming_graph_objects	(	const IStreamingGraph &	oGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	lstObjects )

Retrieve all items of the Streaming Graph where the iobject_ptr::Reset returns ERR_NOERROR.

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	lstObjects	The object list reference to return the values to.

See also: tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

◆ has_trigger_parent()

template<typename ObjectType>

bool has_trigger_parent ( const ObjectType * pChild )

inline

bring latest riddler::has_parent to users scope

Definition at line 209 of file triggerpipe_intf.h.

◆ is_compatible()

tResult is_compatible	(	const ant::IStreamType &	oCheckedType,
		const ant::IStreamType &	oExpectedType )

Checks whether oCheckedType is compatible with oExpectedType.

Parameters

[in]	oCheckedType	The type that should be checked for compatibility.
[in]	oExpectedType	The type that is expected.

Returns: Standard result.

See also: AcceptType and IsCompatible implementations

◆ is_equal()

tResult is_equal	(	const ant::IStreamType &	oLeftType,
		const ant::IStreamType &	oRightType )

inline

Check if two stream types are equal.

Parameters

[in]	oLeftType	The operands for the check.
[in]	oRightType	The operands for the check.

Returns: Standard result.

Definition at line 163 of file streamtype_intf.h.

◆ make_sample_reader()

tResult make_sample_reader	(	ISampleReader &	oReader,
		const char *	strNameOfReader,
		const ucom::iobject_ptr< const IStreamType > &	pStreamType )

inline

Definition at line 1117 of file samplereader.h.

◆ make_sample_writer()

tResult make_sample_writer	(	ISampleWriter &	oWriter,
		const char *	strNameOfWriter,
		const ucom::ant::iobject_ptr< const IStreamType > &	pStreamType )

inline

Definition at line 390 of file samplewriter.h.

◆ read_from_sample()

template<typename T>

tResult read_from_sample	(	const ISample &	oSample,
		T &	oValue )

Helper to read the value oValue from the sample oSample.

This will Locks the Sample and copy the memory from the SampleBuffer to the memory of oSample.

Parameters

[in] oSample The Sample to read from.

Template Parameters

T	The Type of `oValue`

Parameters

[in] oValue The value to read.

Remarks: This must be a plain data type (c-style structure or basic type) or at least an standrad layout type.

Returns: Standard Error Code of ISampleBuffer::Read

Definition at line 261 of file sample_intf.h.

◆ set_description() [1/2]

void set_description	(	base::ant::IConfiguration &	oConfig,
		const char *	strDescription )

Sets description information.

See also: adtf::filter::flash::cGraphObject::SetDescription()

Parameters

[in]	oConfig	The configuration instance where the name and url will be stored
[in]	strDescription	The description.

Returns: Standard result.

◆ set_description() [2/2]

void set_description	(	base::ant::IConfiguration &	oConfig,
		const char *	strItem,
		const char *	strDescription )

Set the description for a specified item of the graph object.

Parameters

[in]	oConfig	The configuration instance where the description will be stored
[in]	strItem	The item name of the object (i.e. name of Pin, Binding Proxy, Runner)
[in]	strDescription	The description for the item

◆ set_editor()

void set_editor	(	base::ant::IConfiguration &	oConfig,
		const char *	strName,
		const char *	strUrl )

Sets graph element editor information.

See also: adtf::filter::flash::cGraphObject::SetEditor()

Parameters

[in]	oConfig	The configuration instance where the name and url will be stored
[in]	strName	The name of the editor.
[in]	strUrl	The url to the editor (a qml file).

Returns: Standard result.

◆ set_editors()

void set_editors	(	base::ant::IConfiguration &	oConfig,
		const std::vector< std::pair< std::string, std::string > > &	oEditors )

Sets multiple graph element editors.

See also: adtf::filter::flash::cGraphObject::SetEditor()

Parameters

[in]	oConfig	The configuration instance where the names and urls will be stored
[in]	oEditors	Pairs of names and urls of the editors.

Returns: Standard result.

◆ set_help_link()

void set_help_link	(	base::ant::IConfiguration &	oConfig,
		const char *	strUrl )

Set the link to the corresponding help/documentation.

Parameters

[in]	oConfig	The configuration instance where the help link will be stored
[in]	strUrl	The url to the help document (i.e. an HTML file).

◆ set_property()

template<typename VALUETYPE>

tResult set_property	(	IStreamType &	oStreamType,
		const char *	strNameOfValue,
		VALUETYPE	oValue )

Sets the property of the given oStreamType to the value oValue.

Template Parameters

VALUETYPE Type of oValue

Parameters

[in]	oStreamType	StreamType where to set the property
[in]	strNameOfValue	name of the property
[in]	oValue	value of property to set.

Returns: Standard Result Code

Definition at line 264 of file streamtype_intf.h.

Referenced by adtf::streaming::lucky::set_stream_type_audio_format().

◆ set_sample_info()

tResult set_sample_info	(	ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oValue )

Sets a variant value for the hash key oHash into the sample information oSampleInfo.

Parameters

[in]	oSampleInfo	The sample information to set the value to.
[in]	oHash	The hash key of the value.
[in]	oValue	value to set.

Returns: standard error code

Return values

ERR_NOERROR	value is set
ERR_INVALID_TYPE	Type is not supported. See base::ant::IHashValueMapValue::tType

◆ set_sample_substream_id()

void set_sample_substream_id	(	ant::ISample &	oSample,
		uint32_t	nSubStreamId )

Sets the substream id of a given sample.

Parameters

[in]	oSample	The sample that should be updated.
[in]	nSubStreamId	The substream id to be set.

Referenced by adtf::streaming::hollow::set_sample_substream_id().

◆ set_sample_time()

void set_sample_time	(	const ucom::ant::iobject_ptr< ant::ISample > &	pSample,
		base::flash::tNanoSeconds	tmTimeStamp )

Sets the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the timestamp to microseconds if not.

Parameters

pSample	The sample.
tmTimeStamp	The timestamp.

◆ set_stream_type_audio_format()

tResult set_stream_type_audio_format	(	IStreamType &	oType,
		const tStreamAudioFormat &	sFormat )

inline

sets the audio format properties within the stream type if meta type "adtf/audio" is set

Parameters

sFormat	The Audio format
oType	The Stream Type where to set the properties to

Returns: tResult

Return values

ERR_NOERROR	Everything went fine
ERR_INVALID_TYPE	the given oType is not a instance of stream meta type "adtf/audio"

Definition at line 144 of file streammetatypeaudio.h.

◆ set_stream_type_image_format()

tResult set_stream_type_image_format	(	IStreamType &	oType,
		const tStreamImageFormat &	oFormat )

Helper function to set the properties of a IStreamType for a stream_meta_type_image.

Parameters

oType	Stream Type where to set the properties representing the content of `sFormat` tStreamImageFormat
oFormat	Format to set the properties from.

Returns: tResult

See also: stream_meta_type_image

◆ stream_image_format_get_generic_mask()

uint32_t stream_image_format_get_generic_mask	(	const char *	strChannel,
		const tStreamImageFormat &	strFormat )

Retrieves the pixelsize by a Generic Pixel Format.

Parameters

strChannel	[in] channel to look for.
strFormat	[in] a generic stream image format.

Returns: Returns the pixelsize in bits

◆ stream_image_format_get_generic_pixel_size()

unsigned int stream_image_format_get_generic_pixel_size ( const tStreamImageFormat & strFormat )

Retrieves the pixelsize by a Generic Pixel Format.

Parameters

strFormat [in] a generic stream image format.

Returns: Returns the pixelsize in bits

◆ stream_image_format_is_generic()

bool stream_image_format_is_generic ( const tStreamImageFormat & strFormat )

Check if all bits are well defined and at least one component is available in Generic Pixel Format.

Parameters

strFormat [in] a generic stream image format.

Returns: Returns true when one or more component is specified and all bits are assigned

◆ stream_image_format_is_generic_rgb()

bool stream_image_format_is_generic_rgb ( const tStreamImageFormat & strFormat )

Check if R, G and B components are available in Generic Pixel Format.

Parameters

[in] strFormat a generic stream image format.

Returns: Returns true when R, G and B component including bitsize is specified

◆ trigger()

template<typename WRITER_TYPE>

WRITER_TYPE & trigger ( WRITER_TYPE & oWriter )

Global function template to trigger a writers sample stream manually.

Template Parameters

WRITER_TYPE Type or sub class of cSampleWriter

Returns: Returns the triggered streamer

See also: cSampleWriter, Sample Stream.

Definition at line 35 of file streaming_functions.h.

◆ write_to_sample()

template<typename T>

tResult write_to_sample	(	ISample &	oSample,
		const T &	oValue )

Helper to write the value oValue to the sample oSample.

This will WriteLock the Sample and copy the memory to the SampleBuffer of Sample.

Parameters

[in] oSample The Sample to write to. (mind you must set a still a timestamp to the sample, see ISample::SetTime)

Template Parameters

T	The Type of `oValue`

Parameters

[in] oValue The value to write.

Remarks: This must be a plain data type (c-style structure or basic type) or at least an standrad layout type.

Returns: Standard Error Code of ISampleBuffer::Write

Definition at line 283 of file sample_intf.h.

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ cDynamicSampleReader

◆ cSingleSampleReader

◆ size_limited_sample_reader

◆ time_limited_sample_reader

◆ tStreamImageFormatName

Function Documentation

◆ add_binding_proxy()

◆ add_data_in_port()

◆ add_data_out_port()

◆ add_graph_object()

◆ add_paired_connections()

◆ add_piped_connections()

◆ add_sample_stream()

◆ add_sample_stream_in_port()

◆ add_sample_stream_out_port()

◆ alloc_sample()

◆ check_loop_call_in_trigger_pipe()

◆ create_adtf_audio_stream_type()

◆ create_adtf_image_stream_type()

◆ create_adtf_plain_stream_type()

◆ create_client()

◆ create_inner_pipe()

◆ create_pin()

◆ create_runner()

◆ create_sample_info_hash_key()

◆ create_server()

◆ create_trigger_pipe()

◆ create_weak_binding_server()

◆ flush()

◆ get_child_objects()

◆ get_data_binding_objects()

◆ get_default_buffer_factory()

◆ get_filter_graph_object()

◆ get_filter_graph_objects()

◆ get_graph_objects()

◆ get_help_link()

◆ get_interface_binding_objects()

◆ get_named_graph_object_from_graph()

◆ get_named_graph_object_full_name()

◆ get_property()

◆ get_reference_buffer_factory()

◆ get_runner_objects()

◆ get_sample_info()

◆ get_sample_substream_id()

◆ get_sample_time() [1/2]

◆ get_sample_time() [2/2]

◆ get_stream_type_audio_format()

◆ get_stream_type_image_format()

◆ get_streaming_graph_object()

◆ get_streaming_graph_objects()

◆ has_trigger_parent()

◆ is_compatible()

◆ is_equal()

◆ make_sample_reader()

◆ make_sample_writer()

◆ read_from_sample()

◆ set_description() [1/2]

◆ set_description() [2/2]

◆ set_editor()

◆ set_editors()

◆ set_help_link()

◆ set_property()

◆ set_sample_info()

◆ set_sample_substream_id()

◆ set_sample_time()

◆ set_stream_type_audio_format()

◆ set_stream_type_image_format()

◆ stream_image_format_get_generic_mask()

◆ stream_image_format_get_generic_pixel_size()

◆ stream_image_format_is_generic()

◆ stream_image_format_is_generic_rgb()

◆ trigger()

◆ write_to_sample()