ADTF  3.14.3
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...

Inheritance diagram for stream_meta_type_image:
[legend]

Static Public Member Functions

static void SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)
 Sets the default properties to the given pProperties. More...
 
static tResult IsCompatible (const adtf::streaming::ant::IStreamType &oTypeToCheck, const adtf::streaming::ant::IStreamType &oTypeExpected)
 Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types in ADTF for a summary of implementations. More...
 
- Static Public Member Functions inherited from stream_meta_type_image
static void SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)
 Sets the default properties to the given pProperties. More...
 

Additional Inherited Members

- Static Public Attributes inherited from stream_meta_type_image
static constexpr const tChar *const MetaTypeName = "adtf/image"
 StreamMetaTypeName for imagetype (video stream).
 
static constexpr const tChar *const FormatName = "format_name"
 Name for the Property of the format name - see imageformat_definition and Generic Pixel Format. More...
 
static constexpr const tChar *const MaxByteSize = "max_byte_size"
 Name for the Property of the max byte size. More...
 
static constexpr const tChar *const PixelWidth = "pixel_width"
 Name for the Property of the pixel width. More...
 
static constexpr const tChar *const PixelHeight = "pixel_height"
 Name for the Property of the pixel height. More...
 
static constexpr const tChar *const DataEndianess = "data_endianess"
 Name for the Property of the data endianess (usually pixel endianess). More...
 

Detailed Description

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.

Concept template to create the "adtf/image" Stream Meta Type for the generator template stream_meta_type.

Remarks
Mind that this defines only the absolute minimum of properties for image storage, many formats will require additional properties.
See also
Stream Meta Type, set_stream_type_image_format, get_stream_type_image_format This version of meta type defines a specific IsCompatible.

Definition at line 100 of file streammetatypeimage.h.

Member Function Documentation

◆ IsCompatible()

static tResult IsCompatible ( const adtf::streaming::ant::IStreamType oTypeToCheck,
const adtf::streaming::ant::IStreamType oTypeExpected 
)
static

Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types in ADTF for a summary of implementations.

This implementation of IsCompatible will accept all other Meta Types and will return ERR_NOERROR only if:
If a format is set, each property value describing the format must be equal except MaxByteSize which follows thease rules:

  • if MaxByteSize is 0 in oTypeExpected - it is dynamic and will be accepted
  • if MaxByteSize is greater in oTypeExpected than in oTypeToCheck -> it will fit for any prellocations and will be accepted
  • if MaxByteSize in oTypeExpected is lower than in oTypeToCheck -> it is not compatible
  • if MaxByteSize is 0 in oTypeToCheck, we need also 0 in oTypeExpected to be compatible


If no format was set, it will return ERR_NOERROR only if the MetaTypeName is equal independently by properties content.

Remarks
For a complete definition of the delivered default types and the information of which Stream Type is compatible to another one then see Default Stream Meta Types in ADTF.
Parameters
[in]oTypeToCheckThe incoming type to check.
[in]oTypeExpectedThe expected type which values are more significant.
Return values
ERR_NOERRORtypes are compatible
See also
Default Stream Meta Types in ADTF, AcceptType and IsCompatible implementations.

◆ SetProperties()

static void SetProperties ( const adtf::ucom::iobject_ptr< adtf::base::IProperties > &  pProperties)
inlinestatic

Sets the default properties to the given pProperties.

Parameters
pPropertiesThe properties where to set the default properties to

Definition at line 107 of file streammetatypeimage.h.

References stream_meta_type_image::SetProperties().


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)