ADTF  3.13.2
adtf::streaming::ant Namespace Reference

Namespace for all functionality of the ADTF Streaming SDK provided since v3.0. More...

Namespaces

 detail
 Namespace for internal functionality.
 
 imageformat_definition
 Namespace to sort pixelformat descriptions.
 

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  cBindingClient
 Default Implementation of adtf::IDynamicBindingObject for one binding object that is able to connect to exactly one server object. 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  cConfigurableInPin
 The class provides a input Pin implemenation that offers an adtf::base::ant::IConfiguration interface. More...
 
class  cConfigurableOutPin
 The class provides a output Pin implemenation that offers an adtf::base::ant::IConfiguration interface. More...
 
class  cDataBinding
 The cFilter class implements a basic filter that supports the IFilter and IPinEventSink interfaces. More...
 
class  cDefaultBindingProxy
 The Default implementation of the IBindingProxy interface. More...
 
class  cDynamicSampleReaderQueue
 Implementation of a adtf::streaming::ant::ISampleReaderQueue with dynamic growing sample queue. More...
 
class  cExternalQueueSampleReader
 Sample reader which allows the registration of external queue. More...
 
class  cExternelQueueSampleReader
 Sample reader which allows the registration of external queue. More...
 
class  cFilterBase
 The cFilterBase class implements a basic filter that supports the ant::IFilter interfaces. More...
 
class  cFilterGraph
 Default implementation for the IFilterGraph interface. More...
 
class  cFilterGraphClientPort
 Default implementation of a ClientPort. More...
 
class  cFilterGraphDataInPort
 The Default implementation of the DataInPort. More...
 
class  cFilterGraphDataOutPort
 The Default implementation of the IFilterGraphDataOutPort. More...
 
class  cFilterGraphRunnerPort
 Default implementation of a RunnerPort. More...
 
class  cFilterGraphServerPort
 Default implementation of a ServerPort . More...
 
class  cFilterLevelmachine
 The Default Filter Level State Machine. More...
 
class  cGraph
 Default implementation for the IFilterGraph interface. More...
 
class  cInPin
 The cInputPin class implements basic functionality specified by the IInPin interface. More...
 
class  cInterfaceBinding
 Default IInterfaceBinding implementation. More...
 
class  cLastSampleReader
 Sample reader which always provides the last successful received sample. More...
 
class  cLastSamplesCollector
 A class that collects the last samples from multiple sample readers. More...
 
class  cLimitedSampleReaderQueue
 
class  cOutPin
 The cOutPin class implements basic functionality specified by the IOutPin interface. More...
 
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  cRuntimeBehaviour
 Default implementation for the IRuntimeBehaviour. 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  cSampleLogEntryList
 Helper class to serialize and handle an ISampleLog. More...
 
class  cSampleLogEntryTransmitReceiveStateBuffer
 Helper Wrapper Class to handle the additional Data entry of the Log Event ISampleLog::MSLEE_TransmitReceiveState . More...
 
class  cSampleQueue
 A simple Sample Queue that hold Samples in a sorted way by time. More...
 
struct  cSampleQueueCompareByTime
 Defines the structure for the SampleQueue Insert Compare. More...
 
class  cSampleReader
 The default Sample Reader will read the incomung Stream of a IInPin. More...
 
class  cSampleSetCollector
 A class that collects the sample sets from multiple sample readers. More...
 
class  cSampleStream
 The Default implementation of the ISampleStream interface. More...
 
class  cSampleStreamingSink
 Basic implementation for a Streaming Sink. More...
 
class  cSampleStreamingSource
 Basic implementation for a Streaming Source. More...
 
class  cSampleStreamInPort
 The Default implementation of the ISampleStream interface. More...
 
class  cSampleStreamOutPort
 The Default implementation of the ISampleStream interface. More...
 
class  cSampleWriter
 This base implementation of a sample writer is able to write to one Sample Stream which is connected to ONE cOutPin. More...
 
class  cStreamingGraph
 
class  cStreamItem
 Default implementation of an StreamItem as container of the Sample Stream s Queue. More...
 
class  cStreamMetaType
 Implements the default adtf::streaming::ant::IStreamMetaType interface. More...
 
class  cStreamType
 Default StreamType implementation. More...
 
class  cTimeBasedSampleSetCollector
 A class that collects the sample sets from multiple sample readers. More...
 
class  data_binding
 Template class for the default implementation of IDataBinding. 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  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  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  ISampleLog
 The ISampleLog interface defines an interface to trace and store Sample data- and timing flow. 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  ISampleQueue
 The ISampleQueue Interface provides methods for manipulating a queue of samples. More...
 
class  ISampleQueueEventSink
 The ISampleQueueEventSink provides methods to act upon sample queue events emitted by a sample queue. More...
 
class  ISampleReader
 Sample Reader interface is to opens a Sample Stream for reading. 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
 Local Sample Streamer Interface. 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
 Sample Wiriter interface is to opens a Sample Stream for writing. 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  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  ITriggerPipe
 Interface a Trigger Pipe. 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  runtime_behaviour
 Default Class Template for a Runtime Behaviour implementation. More...
 
class  sample_data
 Sample Data getter for an easy use of samples with samplebuffer set to the type T. More...
 
class  sample_reader
 A Possible Sample Reader of a Trigger Function! Sample reader with a internal queue, used for ISampleStreamAccess::PushRead! Make sure the trigger function empties the queue!! More...
 
class  sample_stream
 Helper template to implement a ISampleStream or a ISampleStream derived interface. More...
 
class  sample_streamer
 Helper template can be used to implement ISampleStreamer. More...
 
class  sample_writer
 Specialized Sample Writer to write DATA of type DATA_TYPE. 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: tBool, tUInt8, tInt8, tUInt16, tInt16, tUInt32, tInt32, tUInt64, tInt64, tFloat32 or tFloat64. More...
 
class  stream_type_plain
 Generator template to create an instance of a IStreamType class for stream_meta_type_plain ("adtf/plaintype"). More...
 
class  streaming_level_machine
 The Streaming Service Level Machine implementation. 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  tStreamImageFormat
 Simple Stream Type and Stream Meta Type definition for video frames or an image sequence as a convenience stucture. More...
 

Typedefs

using cDynamicSampleReader = sample_reader< cDynamicSampleReaderQueue >
 The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size. More...
 
template<tTimeStamp TIME_RANGE, tBool STORELASTSAMPLE = tTrue>
using time_limited_sample_reader = sample_reader< time_limited_sample_reader_queue< TIME_RANGE >, STORELASTSAMPLE >
 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. More...
 
template<tSize MAX_SIZE, tBool STORELASTSAMPLE = tTrue>
using size_limited_sample_reader = sample_reader< size_limited_sample_reader_queue< MAX_SIZE >, STORELASTSAMPLE >
 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. More...
 
using cSingleSampleReader = size_limited_sample_reader< 1 >
 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.
 
typedef adtf_util::stack_string_base< ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME, adtf_util::assert_out_of_range > cStreamFormatStorageType
 formatname storage type (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)
 
typedef adtf_util::string_base< cStreamFormatStorageTypetStreamImageFormatName
 formatname type as stack string (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)
 

Functions

template<typename DATABINDING_BEHAVIOUR_CLASS >
tResult create_inner_pipe (DATABINDING_BEHAVIOUR_CLASS &oComponent, adtf_util::cStringList lstItems)
 Creates a Trigger Pipe and registers it at the given oFilter instance. More...
 
template<typename DATABINDING_BEHAVIOUR_CLASS >
tResult create_inner_pipe (DATABINDING_BEHAVIOUR_CLASS &oComponent, const adtf_util::cString &strNameOfRunner, const adtf_util::cString &strSource, base::ant::runnable< base::ant::IRunnable::RUN_TRIGGER >::tRunFunction oRunFunc)
 Creates a Trigger Pipe and registers it at the given oFilter instance. More...
 
template<typename INTERFACE >
tResult create_server (cFilterBase &oFilter, const tChar *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. More...
 
template<typename INTERFACE >
tResult create_client (cFilterBase &oFilter, const tChar *strClientName)
 Creates a binding client object for the given INTERFACE type and register it on the cFilterBase instance. More...
 
tResult create_runner (cFilterBase &oFilter, const tChar *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. More...
 
tResult add_piped_connections (IFilterGraph &oGraph, adtf_util::cStringList lstObjectNames, tBool bSync=tTrue)
 This is a helper function to create piped connections on the given FilterGraph instance oGraph. More...
 
tResult add_paired_connections (IFilterGraph &oGraph, adtf_util::cStringList lstObjectNames, tBool bSync=tTrue)
 This is a helper function to create paired connections on the given FilterGraph instance oGraph. More...
 
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 adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>. More...
 
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. More...
 
tResult get_named_graph_object_from_graph (IGraph &oGraph, const tChar *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. More...
 
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. More...
 
adtf_util::cString get_named_graph_object_full_name (const INamedGraphObject &oGraphObject, const tChar *strSeperator)
 Helper function to retrieve a full qualified unique name of an object registered in IFilterGraph. More...
 
template<typename DATA_BINDING_IMPL_TYPE >
tResult create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleWriter &oWriter, const tChar *strNameOfWriterAndPin, const ucom::iobject_ptr< const IStreamType > &pStreamType, ucom::iobject_ptr< IOutPin > &pPinCreated)
 Creates a cOutPin and registers it at the given oDataBindingImpl instance. More...
 
template<typename DATA_BINDING_IMPL_TYPE >
tResult create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleWriter &oWriter, const tChar *strNameOfWriterAndPin, const adtf::ucom::iobject_ptr< const IStreamType > &pStreamType)
 Creates a cOutPin and registers it at the given oDataBindingImpl instance. More...
 
template<typename DATA_BINDING_IMPL_TYPE >
tResult create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleWriter &oWriter, const tChar *strNameOfWriterAndPin, const adtf::ucom::iobject_ptr< IStreamType > &pStreamType)
 Creates a cOutPin and registers it at the given oDataBindingImpl instance. More...
 
template<typename DATA_BINDING_IMPL_TYPE >
tResult create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleReader &oReader, const tChar *strNameOfReaderAndPin, const ucom::iobject_ptr< const IStreamType > &pStreamType, ucom::iobject_ptr< IInPin > &pPinCreated)
 Creates a cInPin and registers it at the given oDataBindingImpl instance. More...
 
template<typename DATA_BINDING_IMPL_TYPE >
tResult create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleReader &oReader, const tChar *strNameOfReaderAndPin, const ucom::iobject_ptr< const IStreamType > &pStreamType)
 Creates a cInPin and registers it at the given oDataBindingImpl instance. More...
 
template<typename DATA_BINDING_IMPL_TYPE >
tResult create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleReader &oReader, const tChar *strNameOfReaderAndPin, const adtf::ucom::iobject_ptr< IStreamType > &pStreamType)
 Creates a cInPin and registers it at the given oDataBindingImpl instance. More...
 
tResult alloc_sample (ucom::ant::iobject_ptr< ucom::ant::IObject > &pSampleObject, const tChar *strSampleCID)
 Helper Function to get a Sample Instance through the adtf::ucom::ant::IRuntime. More...
 
tResult alloc_sample (ucom::ant::iobject_ptr< ucom::ant::IObject > &pSample, const tChar *strSampleCID, tTimeStamp nTimeStamp)
 Helper Function to get a Sample Instance through the adtf::ucom::ant::IRuntime. More...
 
tResult alloc_sample (ucom::ant::iobject_ptr< ISample > &pSample)
 Helper Function to get a ISample Instance through the adtf::ucom::ant::IRuntime. More...
 
tResult alloc_sample (ucom::ant::iobject_ptr< ISample > &pSample, tTimeStamp nTimeStamp)
 Helper Function to get a ISample Instance through the adtf::ucom::ant::IRuntime. More...
 
template<typename T >
tResult read_from_sample (const ISample &oSample, T &oValue)
 Helper to read the value oValue from the sample oSample. More...
 
template<typename T >
tResult write_to_sample (ISample &oSample, const T &oValue)
 Helper to write the value oValue to the sample oSample. More...
 
tResult get_default_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)
 Creates and gets the default buffer factory (ISampleBufferFactory) based on new/delete. More...
 
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. More...
 
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 . More...
 
adtf::util::cVariant get_sample_info (const ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash)
 Retrieves a variant value for the hash key oHash out of the sample information oSampleInfo . More...
 
adtf::util::cVariant get_sample_info (const ISample &oSample, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oDefault)
 Retrieves a variant value for the hash key oHash out of the samples (oSample) sample information. More...
 
adtf::util::cVariant get_sample_info (const ISample &oSample, const ISampleInfo::tHashKey &oHash)
 Retrieves a variant value for the hash key oHash out of the samples (oSample) sample information. More...
 
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. More...
 
tResult set_sample_info (ISample &oSample, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oValue)
 Sets a variant value for the hash key oHash into the sample oSample sample information. More...
 
ISampleInfo::tHashKey create_sample_info_hash_key (const tChar *strToHash)
 Generation of unambigious hash key for a string. More...
 
const ISampleInStreamoperator>> (const ISampleInStream &oStreamReader, IStreamItem &oItem)
 Streaming Operator>> to read a sample from the readers queue. More...
 
ISampleOutStreamoperator<< (ISampleOutStream &oStreamWriter, const adtf::ucom::ant::iobject_ptr< const ISample > &pSample)
 Streaming Operator<< to write a sample to a writers queue of the ISampleStream. More...
 
ISampleOutStreamoperator<< (ISampleOutStream &oStreamWriter, const adtf::ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
 Streaming Operator<< to write a stream type to a writers queue of the ISampleStream. More...
 
ISampleOutStreamoperator<< (ISampleOutStream &oStreamWriter, const adtf::ucom::ant::iobject_ptr< IStreamType > &pStreamType)
 Streaming Operator<< to write an stream type to a writers queue of the ISampleStream. More...
 
ISampleOutStreamoperator<< (ISampleOutStream &oStreamWriter, ISampleOutStream &(*pStreamfunc)(ISampleOutStream &))
 Streaming Operator<< to call a certain streaming function (manipulator), use i.e. More...
 
ISampleOutStreamoperator<< (ISampleOutStream &oStreamWriter, const tResult &oErr)
 Streaming Operator<< to write an Error to the ISampleStream. More...
 
cSampleReaderoperator>> (cSampleReader &oSampleReader, ucom::ant::iobject_ptr< const ISample > &pSample)
 
::* Streaming Operator>> to get the next sample from the cSampleReader More...
 
template<typename DATATYPE >
cSampleReaderoperator>> (cSampleReader &oSampleReader, sample_data< DATATYPE > &oSampleData)
 Streaming Operator>> to get the next sample from the cSampleReader. More...
 
cSampleReaderoperator>> (cSampleReader &oSampleReader, ucom::ant::iobject_ptr< const IStreamType > &pType)
 Streaming Operator>> to write/change a StreamType to the cSampleReader. More...
 
cSampleReaderoperator>> (cSampleReader &oSampleReader, cSampleReader &(*pStreamfunc)(cSampleReader &))
 Streaming Operator>> to clear the cSampleReaders Queue. More...
 
tResult make_sample_reader (cSampleReader &oReader, const tChar *strNameOfReader, const ucom::iobject_ptr< const IStreamType > &pStreamType)
 Initializes a cSampleReader with given name and StreamType param[in] oReader Reader to intialize param[in] strName Name to set param[in] pStreamType Stream Type to set. More...
 
cSampleWriteroperator<< (cSampleWriter &oSampleWriter, const ucom::ant::iobject_ptr< const ISample > &pSample)
 Streaming Operator<< to write/transmit a sample to the cSampleWriter. More...
 
cSampleWriteroperator<< (cSampleWriter &oSampleWriter, const ucom::ant::iobject_ptr< ISample > &pSample)
 Streaming Operator<< to write/transmit a sample to the cSampleWriter. More...
 
cSampleWriteroperator<< (cSampleWriter &oSampleWriter, const ucom::ant::iobject_ptr< const IStreamType > &pType)
 Streaming Operator<< to write/change a StreamType to the cSampleWriter. More...
 
cSampleWriteroperator<< (cSampleWriter &oSampleWriter, cSampleWriter &(*pStreamfunc)(cSampleWriter &))
 Streaming Operator<< to flush or to write the cSampleWriter. More...
 
cSampleWriteroperator<< (cSampleWriter &oSampleWriter, const tResult &oError)
 Streaming Operator<< to write/set a error to the cSampleWriter. More...
 
template<typename DATA_TYPE >
sample_writer< DATA_TYPE > & operator<< (sample_writer< DATA_TYPE > &oSampleWriter, const DATA_TYPE &oSampleData)
 Streaming Operator<< to write/transmit a sample to the cSampleWriter. More...
 
cSampleReaderoperator>> (cSampleReader &oSampleReader, cSampleWriter &oSampleWriter)
 Streaming Operator>> to transmit all samples from the oSampleReader to the oSampleWriter. More...
 
tResult make_sample_writer (cSampleWriter &oWriter, const tChar *strNameOfWriter, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
 
tBool operator!= (const tStreamImageFormat &sLeft, const tStreamImageFormat &sRight)
 is not equal operator to compare tStreamImageFormat More...
 
tBool operator== (const tStreamImageFormat &sLeft, const tStreamImageFormat &sRight)
 is equal operator to compare tStreamImageFormat More...
 
 ADTF_DEFINE_STREAM_IMAGE_FORMAT (RGB_8, "R(3)G(3)B(2)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_555
 BYTE ORDER FORMAT DESCRIPTION Format definition. More...
 
 R (5) G(5) B(5)(1)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_565
 Format definition.
 
 R (8) G(8) B(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(BGR_24
 Format definition. More...
 
 B (8) G(8) R(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_32
 Format definition this description means always first in lowest bit of lowest byte.
 
 A (8) B(8) G(8) R(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(ARGB_32
 Format definition this description means always first in lowest bit of lowest byte.
 
 A (8) R(8) G(8) B(8)") tBool stream_image_format_is_generic_greyscale( const tStreamImageFormat & strFormat)
 Format definition. More...
 
tBool stream_image_format_is_generic_rgb (const tStreamImageFormat &strFormat)
 Check if R, G and B components are available in Generic Pixel Format. More...
 
tBool 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. More...
 
tUInt stream_image_format_get_generic_pixel_size (const tStreamImageFormat &strFormat)
 Retrieves the pixelsize by a Generic Pixel Format. More...
 
tUInt32 stream_image_format_get_generic_mask (const tChar *strChannel, const tStreamImageFormat &strFormat)
 Retrieves the pixelsize by a Generic Pixel Format. More...
 
template<typename WRITER_TYPE >
WRITER_TYPE & flush (WRITER_TYPE &oWriter)
 Global function template to flush a writer. More...
 
template<typename WRITER_TYPE >
WRITER_TYPE & trigger (WRITER_TYPE &oWriter)
 Global function template to trigger a writers sample stream manually. More...
 
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 adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>. More...
 
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. More...
 
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. More...
 
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. More...
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tBool, "BOOL")
 defines a stream_type_plain for the c-type tBool
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt8, "INT8")
 defines a stream_type_plain for the c-type tInt8
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt8, "UINT8")
 defines a stream_type_plain for the ctype tUInt8
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt16, "INT16")
 defines a stream_type_plain for the c-type tInt16
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt16, "UINT16")
 defines a stream_type_plain for the c-type tUInt16
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt32, "INT32")
 defines a stream_type_plain for the c-type tInt32
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt32, "UINT32")
 defines a stream_type_plain for the c-type tUInt32
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt64, "INT64")
 defines a stream_type_plain for the c-type tInt64
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt64, "UINT64")
 defines a stream_type_plain for the c-type tUInt64
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tFloat32, "FLOAT32")
 defines a stream_type_plain for the c-type tFloat32
 
 ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tFloat64, "FLOAT64")
 defines a stream_type_plain for the c-type tFloat64
 
template<typename T >
tBool operator== (const IStreamType &oStreamType, T)
 The equality operator returns true only if the given oStreamType is an instance of the stream_meta_type in T. More...
 
template<typename T >
tBool operator!= (const IStreamType &oStreamType, T oValue)
 The not-equality operator returns false only if the given oStreamType is not an instance of the stream_meta_type in T. More...
 
template<typename VALUETYPE >
tResult set_property (IStreamType &oStreamType, const tChar *strNameOfValue, VALUETYPE oValue)
 Sets the property of the given oStreamType to the value oValue. More...
 
tResult set_property (IStreamType &oStreamType, const tChar *strNameOfValue, const tChar *poValue)
 Sets the property of the given oStreamType to the cString value poValue. More...
 
template<typename VALUETYPE >
VALUETYPE get_property (const IStreamType &oStreamType, const tChar *strNameOfValue, VALUETYPE oDefaultValue)
 Gets the property of the given oStreamType. More...
 
template<typename VALUETYPE >
VALUETYPE get_property (const IStreamType &oStreamType, const tChar *strNameOfValue)
 Gets the property of the given oStreamType. More...
 
template<typename T , typename std::enable_if_t< flash::is_stream_meta_type< T >::value, int > = 0>
tBool operator== (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType, const T &oValue)
 The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T. More...
 
template<typename T , typename std::enable_if_t< flash::is_stream_meta_type< T >::value, int > = 0>
tBool operator!= (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType, const T &oValue)
 The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T. More...
 
tResult create_trigger_pipe (const tChar *strNameOfPipe, adtf::ucom::ant::iobject_ptr< ITriggerPipe > &pTriggerPipe, adtf::ucom::ant::object_list< ITriggerPipeItem > lstNextItems)
 Creates a Trigger Pipe with given items in lstNextItems. More...
 
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. More...
 

Detailed Description

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

Typedef Documentation

◆ 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 828 of file samplereader.h.

◆ 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_SIZEThe count in amount of samples (has to be set while compile time!).
STORELASTSAMPLEOption if the last sample received will be hold.
  • tTrue - last sample is stored
  • tFalse - last sample is droped if after Read call

Definition at line 850 of file samplereader.h.

◆ 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_RANGEThe timerange in micro seconds (has to be set while compile time!).
STORELASTSAMPLEOption if the last sample received will be hold.
  • tTrue - last sample is stored
  • tFalse - last sample is droped if after Read call

Definition at line 839 of file samplereader.h.

Function Documentation

◆ A()

adtf::streaming::ant::A ( ) const &

Format definition.

Format definition this description means always first in lowest bit of lowest byte
Check if GREY component is available Generic Pixel Format.

Parameters
strFormata generic stream image format.
Returns
Returns true when GREY component is available

◆ add_paired_connections()

tResult adtf::streaming::ant::add_paired_connections ( IFilterGraph oGraph,
adtf_util::cStringList  lstObjectNames,
tBool  bSync = tTrue 
)

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]oGraphGraph instance where to add the connections to.
[in]lstObjectNamesThe names of the named graph objects to connect.
[in]bSyncDetermines if the connections will be synchronous or asynchronous.
Returns
Standard Result Code - depends on the cFilterGraph::AddConnection return value.
Return values
ERR_NOT_FOUNDThere is a name in lstObjectNames which is not a object of oGraph.

◆ add_piped_connections()

tResult adtf::streaming::ant::add_piped_connections ( IFilterGraph oGraph,
adtf_util::cStringList  lstObjectNames,
tBool  bSync = tTrue 
)

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]oGraphGraph instance where to add the connections to.
[in]lstObjectNamesThe names of the named graph objects to connect.
[in]bSyncDetermines if the connections will be synchronous or asynchronous.
Returns
Standard Result Code - depends on the cFilterGraph::AddConnection return value.
Return values
ERR_NOT_FOUNDThere is a name in lstObjectNames which is not a object of oGraph.

◆ ADTF_DEFINE_STREAM_IMAGE_FORMAT()

adtf::streaming::ant::ADTF_DEFINE_STREAM_IMAGE_FORMAT ( RGB_8  ,
"R(3)G(3)B(2)"   
)

BYTE ORDER FORMAT DESCRIPTION Format definition.

Format definition Format definition Format definition Format definition Format definition

◆ alloc_sample() [1/4]

tResult adtf::streaming::ant::alloc_sample ( ucom::ant::iobject_ptr< ucom::ant::IObject > &  pSampleObject,
const tChar strSampleCID 
)

Helper Function to get a Sample Instance through the adtf::ucom::ant::IRuntime.

Parameters
pSampleObject[in, out] object_ptr to of Sample if succeeded. Due to the unknown interface you want receive it is provided as object_ptr<IObject>.
strSampleCID[in] Sample object identifier (class id) of the sample class. If strSampleOID is empty then the get_class_id<cSample>() will be used.
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().

◆ alloc_sample() [2/4]

tResult adtf::streaming::ant::alloc_sample ( ucom::ant::iobject_ptr< ucom::ant::IObject > &  pSample,
const tChar strSampleCID,
tTimeStamp  nTimeStamp 
)

Helper Function to get a Sample Instance through the adtf::ucom::ant::IRuntime.

Parameters
pSample[in, out] object_ptr to of Sample if succeeded. Due to the unknown interface you want receive it is provided as object_ptr<IObject>.
strSampleCID[in] Sample object identifier (class id) of the sample class. If strSampleOID is empty then the get_class_id<cSample>() will be used.
nTimeStamp[in] The timestamp of the sample.
Returns
Standard result code.
Note
rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

◆ alloc_sample() [3/4]

tResult adtf::streaming::ant::alloc_sample ( ucom::ant::iobject_ptr< ISample > &  pSample)

Helper Function to get a ISample Instance through the adtf::ucom::ant::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}

◆ alloc_sample() [4/4]

tResult adtf::streaming::ant::alloc_sample ( ucom::ant::iobject_ptr< ISample > &  pSample,
tTimeStamp  nTimeStamp 
)

Helper Function to get a ISample Instance through the adtf::ucom::ant::IRuntime.

Parameters
pSample[in, out] object_ptr to a ISample if succeeded. The default CID will be the get_class_id<cSample>().
nTimeStamp[in] The timestamp of the sample.
Returns
Standard result code.
Note
rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

◆ check_loop_call_in_trigger_pipe()

tResult adtf::streaming::ant::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]pItembeginning source item of the pipe.
Returns
Standard Result Code
Return values
ERR_NOERRORNo loop found. Everything is fine.
ERR_OUT_OF_RANGEEndless Recursion found, there is a item which will call itself as child (also in depth > 1)!

Referenced by trigger_pipe_source< INTERFACE >::RegisterSubItem().

◆ create_client()

tResult adtf::streaming::ant::create_client ( cFilterBase oFilter,
const tChar strClientName 
)

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

Template Parameters
INTERFACEThe IObject interface you want to register the binding client object for
Parameters
[in]oFilterfilter instance to register the client object to
[in]strClientNamename of the object to register
Returns
Standard Result Code

Definition at line 232 of file filterbase.h.

References RETURN_IF_FAILED, and RETURN_NOERROR.

◆ create_inner_pipe() [1/2]

tResult adtf::streaming::ant::create_inner_pipe ( DATABINDING_BEHAVIOUR_CLASS &  oComponent,
adtf_util::cStringList  lstItems 
)
inline

Creates a Trigger Pipe and registers it at the given oFilter instance.

You can use an initializer list for the lstItems as follow:

create_inner_pipe(m_oMyFilter, {"in_pin_1", "my_fancy_runner", "out_pin_1"};

This function will create a pipe where the "my_fancy_runner" will be called from "in_pin_1" if some a synchronous DataTrigger is received. "my_fanc_runner" will read data from "in_pin_1" by its Readers (or do something else) and writes data to the "out_pin_1". If the "my_fancy_runner" returns it will forward a synchronous DataTrigger to "out_pin_1".

Parameters
[in]oComponentdatabinding and runtime behavior instance where to register the Trigger Pipe.
[in]lstItemslist of items of the Trigger Pipe. These items can be a registered Pin of the oFilter or a Runner of oFilter.
Returns
Standard Result Code of the cFilterBase::RegisterInnerPipe call.
Return values
ERR_NOT_FOUNDA given name is not a Pin (InPin or OutPin) or a Runner registered on oFilter.
See also
page_trigger_pipe

Definition at line 133 of file filterbase.h.

◆ create_inner_pipe() [2/2]

tResult adtf::streaming::ant::create_inner_pipe ( DATABINDING_BEHAVIOUR_CLASS &  oComponent,
const adtf_util::cString &  strNameOfRunner,
const adtf_util::cString &  strSource,
base::ant::runnable< base::ant::IRunnable::RUN_TRIGGER >::tRunFunction  oRunFunc 
)

Creates a Trigger Pipe and registers it at the given oFilter instance.

You can call this function like this:

create_inner_pipe(m_oMyFilter, "my_fancy_runner", "in_pin_1", ADTF_RUN_FUNCTION(Read));

This function will create a pipe where the "my_fancy_runner" will be called from "in_pin_1" if some synchronous DataTrigger is received. "my_fancy_runner" will then trigger the Read functor to handle that event (e.g. read in the data sample).

Parameters
[in]oComponentdatabinding and runtime behavior instance where to register the Trigger Pipe.
[in]strNameOfRunnername of the runner
[in]strSourcename of the source where the trigger is receive from
[in]oRunFuncfunction to call if trigger is received
Returns
Standard Result Code of the cFilterBase::RegisterInnerPipe call.
Return values
ERR_NOT_FOUNDA given name is not a Pin (InPin or OutPin) or a Runner registered on oFilter.
See also
page_trigger_pipe

Definition at line 176 of file filterbase.h.

References create_trigger_pipe(), IS_FAILED, ITriggerPipe::Open(), RETURN_ERROR, and RETURN_IF_FAILED.

◆ create_pin() [1/6]

tResult adtf::streaming::ant::create_pin ( DATA_BINDING_IMPL_TYPE &  oDataBindingImpl,
cSampleWriter oWriter,
const tChar strNameOfWriterAndPin,
const ucom::iobject_ptr< const IStreamType > &  pStreamType,
ucom::iobject_ptr< IOutPin > &  pPinCreated 
)

Creates a cOutPin and registers it at the given oDataBindingImpl instance.

Template Parameters
DATA_BINDING_IMPL_TYPEimplementation type of a data_binding to register pins to Following adtf default types support this:
Parameters
[in]oDataBindingImpldata_binding instance where to register the OutPin.
[in]oWriterSampleWriter which will be registered at the cOutpin as ISampleWriter
[in]strNameOfWriterAndPinThe Pin name to set on the OutPin. Also the SampleWriters name will be changed.
[in]pStreamTypeType initially set to the writer. A deep copy is made.
[in,out]pPinCreatedPin created will be returned
Returns
Standard Result Code of the cFilterBase::RegisterPin call.

Definition at line 37 of file pin_creation.h.

References iobject_ptr_base< T >::Reset(), sample_streamer< INTERFACE, PINTYPE >::ResetPin(), RETURN_IF_FAILED, RETURN_NOERROR, sample_streamer< INTERFACE, PINTYPE >::SetName(), and sample_streamer< INTERFACE, PINTYPE >::SetType().

Referenced by create_pin().

◆ create_pin() [2/6]

tResult adtf::streaming::ant::create_pin ( DATA_BINDING_IMPL_TYPE &  oDataBindingImpl,
cSampleWriter oWriter,
const tChar strNameOfWriterAndPin,
const adtf::ucom::iobject_ptr< const IStreamType > &  pStreamType 
)

Creates a cOutPin and registers it at the given oDataBindingImpl instance.

Template Parameters
DATA_BINDING_IMPL_TYPEimplementation type of a data_binding to register pins to Following adtf default types support this:
Parameters
[in]oDataBindingImpldata_binding instance where to register the OutPin.
[in]oWriterSampleWriter which will be registered at the cOutpin as ISampleWriter
[in]strNameOfWriterAndPinThe Pin name to set on the OutPin. Also the SampleWriters name will be changed.
[in]pStreamTypeType initially set to the writer. A deep copy is made.
Returns
Standard Result Code of the cFilterBase::RegisterPin call.

Definition at line 69 of file pin_creation.h.

References create_pin().

◆ create_pin() [3/6]

tResult adtf::streaming::ant::create_pin ( DATA_BINDING_IMPL_TYPE &  oDataBindingImpl,
cSampleWriter oWriter,
const tChar strNameOfWriterAndPin,
const adtf::ucom::iobject_ptr< IStreamType > &  pStreamType 
)

Creates a cOutPin and registers it at the given oDataBindingImpl instance.

Template Parameters
DATA_BINDING_IMPL_TYPEimplementation type of a data_binding to register pins to Following adtf default types support this:
Parameters
[in]oDataBindingImpldata_binding instance where to register the OutPin.
[in]oWriterSampleWriter which will be registered at the cOutpin as ISampleWriter
[in]strNameOfWriterAndPinThe Pin name to set on the OutPin. Also the SampleWriters name will be changed.
[in]pStreamTypeType initially set to the writer. A deep copy is made.
Returns
Standard Result Code of the cDataBinding::RegisterPin call.

Definition at line 93 of file pin_creation.h.

References create_pin().

◆ create_pin() [4/6]

tResult adtf::streaming::ant::create_pin ( DATA_BINDING_IMPL_TYPE &  oDataBindingImpl,
cSampleReader oReader,
const tChar strNameOfReaderAndPin,
const ucom::iobject_ptr< const IStreamType > &  pStreamType,
ucom::iobject_ptr< IInPin > &  pPinCreated 
)

Creates a cInPin and registers it at the given oDataBindingImpl instance.

Template Parameters
DATA_BINDING_IMPL_TYPEconcrete type of a IDataBinding implementation
Parameters
[in]oDataBindingImpldatabinding implementation instance where to register the InPin.
[in]oReaderSampleReader which will be registerd at the cInpin as ISampleStreamer
[in]strNameOfReaderAndPinThe Pin Name to set on the InPin. Also the SampleReaders Name will be changed.
[in]pStreamTypeType initially set to the Reader. A deep copy is made.
[in,out]pPinCreatedPin created will be returned
Returns
Standard Result Code of the cFilterBase::RegisterPin call.

Definition at line 113 of file pin_creation.h.

References iobject_ptr_base< T >::Reset(), sample_streamer< INTERFACE, PINTYPE >::ResetPin(), RETURN_IF_FAILED, RETURN_NOERROR, sample_streamer< INTERFACE, PINTYPE >::SetName(), and sample_streamer< INTERFACE, PINTYPE >::SetType().

◆ create_pin() [5/6]

tResult adtf::streaming::ant::create_pin ( DATA_BINDING_IMPL_TYPE &  oDataBindingImpl,
cSampleReader oReader,
const tChar strNameOfReaderAndPin,
const ucom::iobject_ptr< const IStreamType > &  pStreamType 
)

Creates a cInPin and registers it at the given oDataBindingImpl instance.

Template Parameters
DATA_BINDING_IMPL_TYPEconcrete type of a IDataBinding implementation
Parameters
[in]oDataBindingImpldatabinding instance where to register the InPin.
[in]oReaderSampleReader which will be registerd at the cInpin as ISampleStreamer
[in]strNameOfReaderAndPinThe Pin Name to set on the InPin. Also the SampleReaders Name will be changed.
[in]pStreamTypeType initially set to the Reader. A deep copy is made.
Returns
Standard Result Code of the cFilterBase::RegisterPin call.

Definition at line 141 of file pin_creation.h.

References create_pin().

◆ create_pin() [6/6]

tResult adtf::streaming::ant::create_pin ( DATA_BINDING_IMPL_TYPE &  oDataBindingImpl,
cSampleReader oReader,
const tChar strNameOfReaderAndPin,
const adtf::ucom::iobject_ptr< IStreamType > &  pStreamType 
)

Creates a cInPin and registers it at the given oDataBindingImpl instance.

Template Parameters
DATA_BINDING_IMPL_TYPEconcrete type of a IDataBinding implementation.
Parameters
[in]oDataBindingImplFileBase instance where to register the InPin.
[in]oReaderSampleReader which will be registerd at the cInpin as ISampleStreamer
[in]strNameOfReaderAndPinThe Pin Name to set on the InPin. Also the SampleReaders Name will be changed.
[in]pStreamTypeType initially set to the Reader. A deep copy is made.
Returns
Standard Result Code of the cFilterBase::RegisterPin call.

Definition at line 162 of file pin_creation.h.

References create_pin().

◆ create_runner()

tResult adtf::streaming::ant::create_runner ( cFilterBase oFilter,
const tChar 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 adtf::streaming::ant::create_sample_info_hash_key ( const tChar strToHash)

Generation of unambigious hash key for a string.

This generation is independent to process and platform.

Parameters
[in]strToHashnull terminated string to generate a hash key for.
Returns
Hash key for strToHash.

◆ create_server()

tResult adtf::streaming::ant::create_server ( cFilterBase oFilter,
const tChar 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
INTERFACEThe IObject interface you want to register the binding server object for. Used to create a IBindingType.
Parameters
[in]oFilterfilter instance to register the server object to
[in]strServerNamename of the object to register
[in]pServerInterfaceINTERFACE implementation instance. This will be the Server Object retrieved by IBindingClient::GetServerObject and IBindingProxy::GetServerObject
Returns
Standard Result Code

Definition at line 212 of file filterbase.h.

References RETURN_IF_FAILED, RETURN_NOERROR, and adtf::ucom::ant::ucom_object_ptr_cast().

◆ create_trigger_pipe()

tResult adtf::streaming::ant::create_trigger_pipe ( const tChar 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]strNameOfPipeName of pipe.
[out]pTriggerPipereference to the pipe if created. (you need to hold the reference, otherwise the pipe is closed!)
[in]lstNextItemsItems 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_NOERRORNo loop found. Everything is fine.
ERR_OUT_OF_RANGEEndless Recursion found, there is a item which will call itself as child (also in depth > 1)!
See also
page_trigger_pipe

Referenced by create_inner_pipe().

◆ flush()

WRITER_TYPE& adtf::streaming::ant::flush ( WRITER_TYPE &  oWriter)

Global function template to flush a writer.

Template Parameters
WRITER_TYPEType or sub class of cSampleWriter
Returns
Returns the flushed streamer
See also
cSampleWriter

Definition at line 22 of file streaming_functions.h.

◆ get_default_buffer_factory()

tResult adtf::streaming::ant::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]pFactoryThe factory returned
Returns
Standard Result Code
Return values
ERR_POINTERThe factory could not be created due memory allocation error.
ERR_INVALID_INTERFACEThe given pFactory did not accept the adtf::ucom::iobject_ptr::Reset call.

◆ get_filter_graph_object()

tResult adtf::streaming::ant::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 adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>.

Sub Graphs are considered.

// ...
adtf::services::get_session_filtergraph(pFilterGraph);
get_filter_graph_object(*pFilterGraph, pFirstFoundFilter);
// ...
Parameters
[in]oGraphGraph to retrieve the object from.
[in,out]pObjectThe object reference to return the value.
Return values
ERR_NOT_FOUNDiobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRRORiobject_ptr::Reset returned ERR_NOERROR, consider pObject
See also
adtf::services::ant::get_session_filter_graph to retrieve the current Filter Graph.

◆ get_filter_graph_objects()

tResult adtf::streaming::ant::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 adtf::ucom::ant::object_list this method will return all object of given INTERFACE of adtf::ucom::ant::object_list<INTERFACE>. Sub Graphs are considered.

// ...
adtf::services::get_session_filtergraph(pFilterGraph);
adtf::ucom::object_list<IFilter> lstOfFilters;
get_filter_graph_objects(*pFilterGraph, lstOfFilters);
// ...
Parameters
[in]oGraphGraph to retrieve the objects from.
[in,out]lstObjectsThe object list to push the values to.
Return values
ERR_NOT_FOUNDiobject_enum::Reset never returned ERR_NOERROR
ERR_NOERRRORiobject_enum::Reset returned ERR_NOERROR, consider pObject
See also
adtf::services::ant::get_session_filter_graph to retrieve the current Filter Graph.

Referenced by adtf::services::ant::get_recorders().

◆ get_named_graph_object_from_graph()

tResult adtf::streaming::ant::get_named_graph_object_from_graph ( IGraph oGraph,
const tChar 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]oGraphThe graph instance to get the object from.
[in]strNameThe fully qualified named with dots (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")
[in,out]pObjectFoundThe object to retrieve
Returns
...
Remarks
Expensive recursive call !!

◆ get_named_graph_object_full_name() [1/2]

adtf_util::cString adtf::streaming::ant::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]oGraphObjectThe object to retrieve the fullname for.
Returns
The full qualified name of the object. (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")
Remarks
Expensive recursive call !!

Referenced by qt_ui_filter< FILTERBASECLASS >::Init(), named_graph_object< trigger_pipe_item< IRunner > >::LogNamedMessage(), and trigger_pipe_source< INTERFACE >::RegisterSubItem().

◆ get_named_graph_object_full_name() [2/2]

adtf_util::cString adtf::streaming::ant::get_named_graph_object_full_name ( const INamedGraphObject oGraphObject,
const tChar strSeperator 
)

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

Parameters
[in]oGraphObjectThe object to retrieve the fullname for.
[in]strSeperatorThe seperator to use between the parent object names.
Returns
The full qualified name of the object. (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")
Remarks
Expensive recursive call !!

◆ get_property() [1/2]

VALUETYPE adtf::streaming::ant::get_property ( const IStreamType oStreamType,
const tChar strNameOfValue,
VALUETYPE  oDefaultValue 
)

Gets the property of the given oStreamType.

Template Parameters
VALUETYPEType of value returned and oDefaultValue
Parameters
[in]oStreamTypeStreamType where to get the property
[in]strNameOfValuename of the property
[in]oDefaultValuedefault value of property if not found.
Returns
the value of the property

Definition at line 219 of file streamtype_intf.h.

References IStreamType::GetConfig(), and IS_OK.

◆ get_property() [2/2]

VALUETYPE adtf::streaming::ant::get_property ( const IStreamType oStreamType,
const tChar strNameOfValue 
)

Gets the property of the given oStreamType.

Template Parameters
VALUETYPEType of value returned
Parameters
[in]oStreamTypeStreamType where to get the property
[in]strNameOfValuename of the property
Returns
the value of the property

Definition at line 239 of file streamtype_intf.h.

◆ get_reference_buffer_factory()

tResult adtf::streaming::ant::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 adtf::ucom::ant::weak_object_ptr in order to be able to check if they no longer exist before you manipulate the data again.

Parameters
[out]pFactoryThe factory returned
Returns
Standard Result Code
Return values
ERR_POINTERThe factory could not be created due memory allocation error.
ERR_INVALID_INTERFACEThe given pFactory did not accept the adtf::ucom::iobject_ptr::Reset call.

◆ get_sample_info() [1/4]

adtf::util::cVariant adtf::streaming::ant::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]oSampleInfoThe sample information to retrieve the value from.
[in]oHashThe hash key of the value.
[in]oDefaultdefault value if value does not exist.
Returns
retrieved value as variant.

◆ get_sample_info() [2/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info ( const ISampleInfo oSampleInfo,
const ISampleInfo::tHashKey oHash 
)

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

If the value does not exists the return value content is undefined.

Parameters
[in]oSampleInfoThe sample information to retrieve the value from.
[in]oHashThe hash key of the value.
Returns
retrieved value as variant.

◆ get_sample_info() [3/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info ( const ISample oSample,
const ISampleInfo::tHashKey oHash,
const adtf::util::cVariant  oDefault 
)

Retrieves a variant value for the hash key oHash out of the samples (oSample) sample information.

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

Parameters
[in]oSampleThe sample to retrieve the value from its sample information.
[in]oHashThe hash key of the value.
[in]oDefaultdefault value if value does not exist.
Returns
retrieved value as variant.

◆ get_sample_info() [4/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info ( const ISample oSample,
const ISampleInfo::tHashKey oHash 
)

Retrieves a variant value for the hash key oHash out of the samples (oSample) sample information.

If the value does not exists the return value content is undefined.

Parameters
[in]oSampleThe sample to retrieve the value from its sample information.
[in]oHashThe hash key of the value.
Returns
retrieved value as variant.

◆ get_stream_type_image_format()

tResult adtf::streaming::ant::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
oTypeStream Type where to get the properties from
oFormatFormat to set the properties content to.
Returns
tResult
See also
stream_meta_type_image

◆ get_streaming_graph_object()

tResult adtf::streaming::ant::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 adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>.

The embedded Filter Graph is not considered.

Parameters
[in]oGraphGraph to retrieve the object from.
[in,out]pObjectThe object reference to return the value.
Return values
ERR_NOT_FOUNDiobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRRORiobject_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 adtf::streaming::ant::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]oGraphGraph to retrieve the object from.
[in,out]lstObjectsThe object list reference to return the values to.
See also
tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

Referenced by adtf::services::ant::get_recorders().

◆ make_sample_reader()

tResult adtf::streaming::ant::make_sample_reader ( cSampleReader oReader,
const tChar strNameOfReader,
const ucom::iobject_ptr< const IStreamType > &  pStreamType 
)
inline

Initializes a cSampleReader with given name and StreamType param[in] oReader Reader to intialize param[in] strName Name to set param[in] pStreamType Stream Type to set.

A deep copy will be created.

Returns
Result of cSampleReader::SetType

Definition at line 929 of file samplereader.h.

References sample_streamer< INTERFACE, PINTYPE >::SetName(), and sample_streamer< INTERFACE, PINTYPE >::SetType().

Referenced by adtf::mediadescription::ant::make_sample_reader().

◆ make_sample_writer()

tResult adtf::streaming::ant::make_sample_writer ( cSampleWriter oWriter,
const tChar strNameOfWriter,
const ucom::ant::iobject_ptr< const IStreamType > &  pStreamType 
)
inline
  • Initializes the given oWriter with name and type.
    Parameters
    [in]oWriterwriter to initializes
    [in]strNameOfWritername sets to the writer
    [in]pStreamTypestream for the writer (deep copy is created)
    Returns
    Standard Result Code

Definition at line 351 of file samplewriter.h.

References sample_streamer< INTERFACE, PINTYPE >::SetName(), and sample_streamer< INTERFACE, PINTYPE >::SetType().

Referenced by adtf::mediadescription::ant::make_sample_writer().

◆ operator!=() [1/3]

tBool adtf::streaming::ant::operator!= ( const tStreamImageFormat sLeft,
const tStreamImageFormat sRight 
)

is not equal operator to compare tStreamImageFormat

Parameters
sLeft[in] left value
sRight[in] right value
Return values
tTrueis not equal
tFalseis equal

◆ operator!=() [2/3]

tBool adtf::streaming::ant::operator!= ( const IStreamType oStreamType,
oValue 
)

The not-equality operator returns false only if the given oStreamType is not an instance of the stream_meta_type in T.

It will compare the unique meta type name.

Template Parameters
TA class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)
Parameters
oStreamTypeThe Stream Type instance to check the unique meta type name.
oValuethe Stream Meta Type to expected
Return values
truemeta type name is not equal
falsemeta type name is equal

Definition at line 175 of file streamtype_intf.h.

◆ operator!=() [3/3]

tBool adtf::streaming::ant::operator!= ( const ucom::ant::iobject_ptr< const IStreamType > &  pStreamType,
const T &  oValue 
)

The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T.

It will compare the unique meta type name.

Template Parameters
TA class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)
Parameters
pStreamTypeThe Stream Type instance to check the unique meta type name.
oValuethe Stream Meta Type (not) expected
Return values
truemeta type name is not equal
falsemeta type name is equal

Definition at line 358 of file streamtype_intf.h.

◆ operator<<() [1/11]

ISampleOutStream& adtf::streaming::ant::operator<< ( ISampleOutStream oStreamWriter,
const adtf::ucom::ant::iobject_ptr< const ISample > &  pSample 
)
inline

Streaming Operator<< to write a sample to a writers queue of the ISampleStream.

See also
ISampleOutStream::Write
Parameters
oStreamWriter[in] The Writer to write to.
pSample[in] The Sample which will be written to queue.
Returns
...

Definition at line 97 of file sampleoutstream_intf.h.

References ISampleOutStream::Write().

◆ operator<<() [2/11]

ISampleOutStream& adtf::streaming::ant::operator<< ( ISampleOutStream oStreamWriter,
const adtf::ucom::ant::iobject_ptr< const IStreamType > &  pStreamType 
)
inline

Streaming Operator<< to write a stream type to a writers queue of the ISampleStream.

See also
ISampleOutStream::Write
Parameters
oStreamWriter[in] The Writer to write to.
pStreamType[in] The StreamType which will be written to queue.
Returns
...

Definition at line 111 of file sampleoutstream_intf.h.

References ISampleOutStream::Write().

◆ operator<<() [3/11]

ISampleOutStream& adtf::streaming::ant::operator<< ( ISampleOutStream oStreamWriter,
const adtf::ucom::ant::iobject_ptr< IStreamType > &  pStreamType 
)
inline

Streaming Operator<< to write an stream type to a writers queue of the ISampleStream.

See also
ISampleOutStream::Write
Parameters
oStreamWriter[in] The Writer to write to.
pStreamType[in] The StreamType which will be written to queue.
Returns
...

Definition at line 125 of file sampleoutstream_intf.h.

References ISampleOutStream::Write().

◆ operator<<() [4/11]

ISampleOutStream& adtf::streaming::ant::operator<< ( ISampleOutStream oStreamWriter,
ISampleOutStream &(*)(ISampleOutStream &)  pStreamfunc 
)
inline

Streaming Operator<< to call a certain streaming function (manipulator), use i.e.

to flush the queue:

See also
ISampleOutStream::Flush
Parameters
[in]oStreamWriterThe Writer to call the streaming function to.
[in]pStreamfuncstreaming function to execute with layout: ISampleOutStream&(ISampleOutStream&)
Returns
return manipulated oStreamWriter instance

Definition at line 144 of file sampleoutstream_intf.h.

◆ operator<<() [5/11]

ISampleOutStream& adtf::streaming::ant::operator<< ( ISampleOutStream oStreamWriter,
const tResult oErr 
)
inline

Streaming Operator<< to write an Error to the ISampleStream.

See also
ISampleOutStream::SetStreamError
Parameters
oStreamWriter[in] The Writer to write to.
oErr[in] The Error which will be written to queue.
Returns
return manipulated oStreamWriter instance

Definition at line 157 of file sampleoutstream_intf.h.

References ISampleOutStream::SetStreamError().

◆ operator<<() [6/11]

cSampleWriter& adtf::streaming::ant::operator<< ( cSampleWriter oSampleWriter,
const ucom::ant::iobject_ptr< const ISample > &  pSample 
)
inline

Streaming Operator<< to write/transmit a sample to the cSampleWriter.

See also
cSampleWriter::Transmit
Parameters
oSampleWriter[in] The Writer to transmit the sample reference to.
pSample[in] The Sample reference which will be transmitted on oSampleWriter
Returns
the writers instance
Note
rtsafe{using ADTF Sample Pool Service and a ADTF Memory Allocator Service and the sample stream connected has a static queue}

Definition at line 186 of file samplewriter.h.

References cSampleWriter::Transmit().

◆ operator<<() [7/11]

cSampleWriter& adtf::streaming::ant::operator<< ( cSampleWriter oSampleWriter,
const ucom::ant::iobject_ptr< ISample > &  pSample 
)
inline

Streaming Operator<< to write/transmit a sample to the cSampleWriter.

See also
cSampleWriter::Transmit
Parameters
oSampleWriter[in] The Writer to transmit the sample reference to.
pSample[in] The Sample reference which will be transmitted on oSampleWriter
Returns
...

Definition at line 200 of file samplewriter.h.

References cSampleWriter::Transmit().

◆ operator<<() [8/11]

cSampleWriter& adtf::streaming::ant::operator<< ( cSampleWriter oSampleWriter,
const ucom::ant::iobject_ptr< const IStreamType > &  pType 
)
inline

Streaming Operator<< to write/change a StreamType to the cSampleWriter.

See also
cSampleWriter::ChangeType
Parameters
oSampleWriter[in] The Writer to change the StreamType reference.
pType[in] The StreamType reference which will be change and write on oSampleWriter
Returns
...

Definition at line 213 of file samplewriter.h.

References cSampleWriter::ChangeType().

◆ operator<<() [9/11]

cSampleWriter& adtf::streaming::ant::operator<< ( cSampleWriter oSampleWriter,
cSampleWriter &(*)(cSampleWriter &)  pStreamfunc 
)
inline

Streaming Operator<< to flush or to write the cSampleWriter.

See also
cSampleWriter::Flush
Parameters
oSampleWriter[in] The Writer to execute the function to.
pStreamfunc[in] the streamfunction to execute with the layout: cSampleWriter&(cSampleWriter&)
Returns
...

Definition at line 226 of file samplewriter.h.

◆ operator<<() [10/11]

cSampleWriter& adtf::streaming::ant::operator<< ( cSampleWriter oSampleWriter,
const tResult oError 
)
inline

Streaming Operator<< to write/set a error to the cSampleWriter.

See also
cSampleWriter::SetStreamError
Parameters
oSampleWriter[in] The Writer to set the error reference.
oError[in] The error reference which will be set on oSampleWriter
Returns
...

Definition at line 238 of file samplewriter.h.

References cSampleWriter::SetStreamError().

◆ operator<<() [11/11]

sample_writer<DATA_TYPE>& adtf::streaming::ant::operator<< ( sample_writer< DATA_TYPE > &  oSampleWriter,
const DATA_TYPE &  oSampleData 
)

Streaming Operator<< to write/transmit a sample to the cSampleWriter.

See also
sample_writer::Transmit
Parameters
oSampleWriter[in] The Writer to transmit the sample reference to.
oSampleData[in] the data to write
Returns
The writers instance
Note
rtsafe{using ADTF Sample Pool Service and a ADTF Memory Allocator Service}

Definition at line 321 of file samplewriter.h.

References sample_writer< DATA_TYPE >::Transmit().

◆ operator==() [1/3]

tBool adtf::streaming::ant::operator== ( const tStreamImageFormat sLeft,
const tStreamImageFormat sRight 
)

is equal operator to compare tStreamImageFormat

Parameters
sLeft[in] left value
sRight[in] right value
Return values
tTrueis equal
tFalseis not equal

◆ operator==() [2/3]

tBool adtf::streaming::ant::operator== ( const IStreamType oStreamType,
 
)

The equality operator returns true only if the given oStreamType is an instance of the stream_meta_type in T.

It will compare the unique meta type name.

Template Parameters
TA class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)
Parameters
oStreamTypeThe Stream Type instance to check the unique meta type name.
Return values
truemeta type name is equal
falsemeta type name is not equal

Definition at line 158 of file streamtype_intf.h.

References adtf_string_intf, IStreamType::GetMetaTypeName(), and cResult::IsEqual().

◆ operator==() [3/3]

tBool adtf::streaming::ant::operator== ( const ucom::ant::iobject_ptr< const IStreamType > &  pStreamType,
const T &  oValue 
)

The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T.

It will compare the unique meta type name.

Template Parameters
TA class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)
Parameters
pStreamTypeThe Stream Type instance to check the unique meta type name.
oValuethe Stream Meta Type expected
Return values
truemeta type name is equal
falsemeta type name is not equal

Definition at line 337 of file streamtype_intf.h.

References iobject_ptr_base< T >::Get(), and tFalse.

◆ operator>>() [1/6]

const ISampleInStream& adtf::streaming::ant::operator>> ( const ISampleInStream oStreamReader,
IStreamItem oItem 
)
inline

Streaming Operator>> to read a sample from the readers queue.

Remarks
Intialize the passed oItem with tReadingEvent::RE_Nothing to react on empty queues!
See also
ISampleInStream::Read
Parameters
oStreamReader[in] The Reader to read from.
oItem[in] The item implemenation to read to (see IStreamItem for default implementation).
Returns
...

Definition at line 80 of file sampleinstream_intf.h.

References ISampleInStream::Read().

◆ operator>>() [2/6]

cSampleReader& adtf::streaming::ant::operator>> ( cSampleReader oSampleReader,
cSampleWriter oSampleWriter 
)
inline

Streaming Operator>> to transmit all samples from the oSampleReader to the oSampleWriter.

Parameters
oSampleReader[in] The Reader to read the streamdata.
oSampleWriter[in] The writer to write teh streamdata to.
Returns
teh reader with new state.

Definition at line 334 of file samplewriter.h.

References cSampleReader::GetNextSample(), and IS_OK.

◆ operator>>() [3/6]

cSampleReader& adtf::streaming::ant::operator>> ( cSampleReader oSampleReader,
ucom::ant::iobject_ptr< const ISample > &  pSample 
)
inline


::* Streaming Operator>> to get the next sample from the cSampleReader

See also
cSampleReader::GetNextSample
Parameters
oSampleReader[in] The Reader to get the next sample from queue.
pSample[in] The Sample reference to store the next sample from oSampleReader
Returns
...

Definition at line 866 of file samplereader.h.

References cSampleReader::GetNextSample(), and iobject_ptr_base< T >::Reset().

◆ operator>>() [4/6]

cSampleReader& adtf::streaming::ant::operator>> ( cSampleReader oSampleReader,
sample_data< DATATYPE > &  oSampleData 
)

Streaming Operator>> to get the next sample from the cSampleReader.

See also
cSampleReader::GetNextSample
Parameters
oSampleReader[in] The Reader to get the next sample from queue.
oSampleData[in] The Sample data to read the
Returns
the sample reader with new state after reading

Definition at line 883 of file samplereader.h.

References cSampleReader::GetNextSample(), IS_OK, and sample_data< T >::Reset().

◆ operator>>() [5/6]

cSampleReader& adtf::streaming::ant::operator>> ( cSampleReader oSampleReader,
ucom::ant::iobject_ptr< const IStreamType > &  pType 
)
inline

Streaming Operator>> to write/change a StreamType to the cSampleReader.

See also
cSampleReader::ChangeType
Parameters
oSampleReader[in] The Reader to get StreamType reference.
pType[in] The StreamType reference to store the stream type
Returns
...

Definition at line 904 of file samplereader.h.

References cSampleReader::GetLastType().

◆ operator>>() [6/6]

cSampleReader& adtf::streaming::ant::operator>> ( cSampleReader oSampleReader,
cSampleReader &(*)(cSampleReader &)  pStreamfunc 
)
inline

Streaming Operator>> to clear the cSampleReaders Queue.

See also
cSampleReader::Clear
Parameters
[in]oSampleReaderThe Reader to execute he function to.
[in]pStreamfuncthe streamfunction to execute with the layout: cSampleReader&(cSampleReader&)
Returns
return the oSampleReader after executed streamfunction!

Definition at line 917 of file samplereader.h.

◆ R()

R ( )

Format definition.

Format definition this description means always first in lowest bit of lowest byte.

◆ read_from_sample()

tResult adtf::streaming::ant::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]oSampleThe Sample to read from.
Template Parameters
TThe Type of oValue
Parameters
[in]oValueThe 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 263 of file sample_intf.h.

References ISample::Lock(), ISampleBuffer::Read(), and RETURN_IF_FAILED.

◆ set_property() [1/2]

tResult adtf::streaming::ant::set_property ( IStreamType oStreamType,
const tChar strNameOfValue,
VALUETYPE  oValue 
)

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

Template Parameters
VALUETYPEType of oValue
Parameters
[in]oStreamTypeStreamType where to set the property
[in]strNameOfValuename of the property
[in]oValuevalue of property to set.
Returns
Standard Result Code

Definition at line 189 of file streamtype_intf.h.

References IStreamType::GetConfig(), and RETURN_IF_FAILED.

◆ set_property() [2/2]

tResult adtf::streaming::ant::set_property ( IStreamType oStreamType,
const tChar strNameOfValue,
const tChar poValue 
)
inline

Sets the property of the given oStreamType to the cString value poValue.

Parameters
[in]oStreamTypeStreamType where to set the property
[in]strNameOfValuename of the property
[in]poValuestring value of property to set.
Returns
Standard Result Code

Definition at line 203 of file streamtype_intf.h.

References IStreamType::GetConfig(), and RETURN_IF_FAILED.

◆ set_sample_info() [1/2]

tResult adtf::streaming::ant::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]oSampleInfoThe sample information to set the value to.
[in]oHashThe hash key of the value.
[in]oValuevalue to set.
Returns
standard error code
Return values
ERR_NOERRORvalue is set
ERR_INVALID_TYPEType is not supported. See base::ant::IHashValueMapValue::tType

◆ set_sample_info() [2/2]

tResult adtf::streaming::ant::set_sample_info ( ISample oSample,
const ISampleInfo::tHashKey oHash,
const adtf::util::cVariant  oValue 
)

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

Parameters
[in]oSampleThe sample to set the value to its sample information.
[in]oHashThe hash key of the value.
[in]oValuevalue to set.
Returns
standard error code
Return values
ERR_NOERRORvalue is set
ERR_INVALID_TYPEType is not supported. See base::ant::IHashValueMapValue::tType

◆ set_stream_type_image_format()

tResult adtf::streaming::ant::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
oTypeStream Type where to set the properties representing the content of sFormat tStreamImageFormat
oFormatFormat to set the properties from.
Returns
tResult
See also
stream_meta_type_image

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

◆ stream_image_format_get_generic_mask()

tUInt32 adtf::streaming::ant::stream_image_format_get_generic_mask ( const tChar 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()

tUInt adtf::streaming::ant::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()

tBool adtf::streaming::ant::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()

tBool adtf::streaming::ant::stream_image_format_is_generic_rgb ( const tStreamImageFormat strFormat)

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

Parameters
[in]strFormata generic stream image format.
Returns
Returns true when R, G and B component including bitsize is specified

◆ trigger()

WRITER_TYPE& adtf::streaming::ant::trigger ( WRITER_TYPE &  oWriter)

Global function template to trigger a writers sample stream manually.

Template Parameters
WRITER_TYPEType 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()

tResult adtf::streaming::ant::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]oSampleThe Sample to write to. (mind you must set a still a timestamp to the sample, see ISample::SetTime)
Template Parameters
TThe Type of oValue
Parameters
[in]oValueThe 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 285 of file sample_intf.h.

References RETURN_IF_FAILED, ISampleBuffer::Write(), and ISample::WriteLock().


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)