ADTF  3.14.3
Codec

Decoder for dynamic structures defined by a DataDefinition definition. More...

Inheritance diagram for Codec:
[legend]

Public Types

typedef CodecElement< CodecElementAccess< Codec > > Element
 Codec element.
 
typedef ChildElements< CodecElementAccess< Codec > > Elements
 Iterator container to iterate all elements of the codec. More...
 
- Public Types inherited from Decoder
typedef DecoderElement< DecoderElementAccess< const Decoder > > Element
 Decoder element.
 
typedef ChildElements< DecoderElementAccess< const Decoder > > Elements
 Iterator container to iterate all elements of the decoder and get values. More...
 
- Public Types inherited from StaticDecoder
typedef DecoderElement< DecoderElementAccess< const StaticDecoder > > Element
 Static decoder element.
 
typedef ChildElements< DecoderElementAccess< const StaticDecoder > > Elements
 Iterator container to iterate all elements of the static decoder. More...
 

Public Member Functions

 Codec ()
 Default constructor.
 
 Codec (Codec &&)
 Move constructor.
 
Codecoperator= (Codec &&)
 Move assignment operator.
 
 Codec (const Codec &)=delete
 No copy constructor.
 
Codecoperator= (const Codec &)=delete
 No copy assignment operator.
 
Element getElement (const CodecIndex &codec_index)
 Retrieves an element instance based on the codec index of that element. More...
 
Element getElement (const std::string &full_element_name)
 Retrieves an element instance based on the full name of the element. More...
 
ElementsgetElements ()
 Retrieves the elements of the codec to get element information. More...
 
template<typename T >
void setElementValue (const CodecIndex &codec_index, const T &value)
 Sets the current value of the given element from given value in type T. More...
 
void setElementVariantValue (const CodecIndex &codec_index, const a_util::variant::Variant &value)
 Sets the current value of the given element from the given variant. More...
 
void setElementStringValue (const CodecIndex &codec_index, const std::string &value)
 Sets the current value of the given element from the given string. More...
 
void setElementRawValue (const CodecIndex &codec_index, const void *value, size_t value_size)
 Sets the current value of the given element by copying its data from the passed-in location. More...
 
void * getElementAddress (const CodecIndex &codec_index)
 
void resetValues (bool zero_values=false)
 Sets all elements to their default values, constant values defined in the data definition or zero if zero_values is set. More...
 
Element getElement (const CodecIndex &index) const
 Retrieves an element instance based on the codec index of that element. More...
 
Element getElement (const std::string &full_element_name) const
 Retrieves an element instance based on the full name of the element. More...
 
const ElementsgetElements () const
 Retrieves the elements of the decoder to get element information and get values. More...
 
- Public Member Functions inherited from Decoder
 Decoder ()
 Default constructor.
 
 Decoder (Decoder &&)
 Move constructor.
 
Decoderoperator= (Decoder &&)
 Move assignment operator.
 
 Decoder (const Decoder &)=delete
 No copy constructor.
 
Decoderoperator= (const Decoder &)=delete
 No copy assignment operator.
 
a_util::result::Result isValid () const override
 
Element getElement (const CodecIndex &index) const
 Retrieves an element instance based on the codec index of that element. More...
 
Element getElement (const std::string &full_element_name) const
 Retrieves an element instance based on the full name of the element. More...
 
const ElementsgetElements () const
 Retrieves the elements of the decoder to get element information and get values. More...
 
size_t getBufferSize () const
 Gets the buffer size in bytes for the main structure. More...
 
size_t getBufferSize (DataRepresentation representation) const
 Gets the buffer size in bytes for the main structure. More...
 
Codec makeCodecFor (void *data, size_t data_size, DataRepresentation representation) const
 Create a new codec with the current dynamic structure layout for a new data buffer. More...
 
- Public Member Functions inherited from StaticDecoder
 StaticDecoder ()
 Default constructor.
 
 StaticDecoder (const StaticDecoder &)=delete
 Noncopyable.
 
StaticDecoderoperator= (const StaticDecoder &)=delete
 Noncopyable.
 
 StaticDecoder (StaticDecoder &&)
 Move constructor.
 
StaticDecoderoperator= (StaticDecoder &&)
 Move assignment operator.
 
Element getElement (const CodecIndex &codec_index) const
 Retrieves an element instance based on the codec index of that element. More...
 
Element getElement (const std::string &full_element_name) const
 Retrieves an element instance based on the full name of the element. More...
 
const ElementsgetElements () const
 Retrieves the elements of the static decoder to get element information. More...
 
size_t getElementChildCount (const CodecIndex &codec_index=CodecIndex()) const
 Retrieves the amount of child elements for the given codec index. More...
 
std::string getElementFullName (const CodecIndex &codec_index) const
 Retrieves the full name of the element within its main structure. More...
 
std::string getElementName (const CodecIndex &codec_index) const
 Retrieves the name of the element within its structured element. More...
 
const std::string & getElementBaseName (const CodecIndex &codec_index) const
 Retrieves the base name of the element within its structured element. More...
 
template<typename T >
getElementValue (const CodecIndex &codec_index) const
 Returns the current value of the given element as a T if supported. More...
 
a_util::variant::Variant getElementVariantValue (const CodecIndex &codec_index) const
 Returns the current value of the given element as a variant. More...
 
void getElementVariantValue (const CodecIndex &codec_index, a_util::variant::Variant &value) const
 Returns the current value of the given element as a variant. More...
 
std::string getElementStringValue (const CodecIndex &codec_index) const
 Returns the current value of the given element as a string. More...
 
void getElementRawValue (const CodecIndex &index, void *value, size_t value_size) const
 Returns the current value of the given element as a variant. More...
 
const void * getElementAddress (const CodecIndex &index) const
 
size_t getStaticBufferSize () const
 Gets the static buffer size in bytes for the main structure. More...
 
size_t getStaticBufferSize (DataRepresentation rep) const
 Gets the static buffer size in bytes for the main structure. More...
 
DataRepresentation getRepresentation () const
 Returns the current data representation the decoder decodes from. More...
 
CodecIndex resolve (size_t leaf_index) const
 
size_t getElementCount () const
 is the leaf count More...
 
a_util::result::Result getElement (size_t leaf_index, const ddl::StructElement *&legacy_struct_element) const
 Returns the StructElement of the element with given leaf index. More...
 
void resolve (CodecIndex &codec_index) const
 The codec index will be resolved for fast access. More...
 

Protected Member Functions

 Codec (std::shared_ptr< const StructAccess > codec_access, void *data, size_t data_size, ddl::DataRepresentation rep)
 For internal use only.
 
 Codec (const Decoder &decoder, void *data, size_t data_size, ddl::DataRepresentation representation)
 For internal use only.
 
- Protected Member Functions inherited from Decoder
 Decoder (std::shared_ptr< const StructAccess > codec_access, const void *data, size_t data_size, DataRepresentation representation)
 For internal use only.
 
 Decoder (const Decoder &decoder, const void *data, size_t data_size, DataRepresentation representation)
 For internal use only.
 
- Protected Member Functions inherited from StaticDecoder
 StaticDecoder (std::shared_ptr< const StructAccess > codec_access, const void *data, size_t data_size, DataRepresentation representation)
 For internal use only.
 

Private Attributes

Element _first_element
 

Additional Inherited Members

- Protected Attributes inherited from StaticDecoder
std::shared_ptr< const StructAccess > _codec_access
 
const void * _data = nullptr
 For internal use only.
 
size_t _data_size = 0
 For internal use only.
 
const ddl::codec::ElementAccessor * _element_accessor
 For internal use only.
 

Detailed Description

Decoder for dynamic structures defined by a DataDefinition definition.

Currently the amount of dynamic elements is determined during construction only (by the current values in the structure).

Definition at line 131 of file repo/src/libraries/mediadescription/include/ddl/codec_preview/codec.h.

Member Typedef Documentation

◆ Elements

Member Function Documentation

◆ getElement() [1/4]

Element getElement ( const CodecIndex codec_index)

Retrieves an element instance based on the codec index of that element.

Parameters
[in]codec_indexThe codec index.
Returns
The Codec Index of the CodecElement.
Remarks
The element is only valid as long as the codec exists.
Exceptions
throwsstd::runtime_error if not found.

◆ getElement() [2/4]

Element getElement

Retrieves an element instance based on the codec index of that element.

Parameters
[in]codec_indexThe codec index.
Returns
The Codec Index of the DecoderElement.
Remarks
The element is only valid as long as the factory exists.
Exceptions
throwsstd::runtime_error if not found.

◆ getElement() [3/4]

Element getElement ( const std::string &  full_element_name)

Retrieves an element instance based on the full name of the element.

Parameters
[in]full_element_nameThe full name of the element in point notation (i.e. "element1.child_element[4].element_value").
Returns
The Codec Index of the CodecElement.
Remarks
The element is only valid as long as the codec exists.
Exceptions
throwsstd::runtime_error if not found.

◆ getElement() [4/4]

Element getElement

Retrieves an element instance based on the full name of the element.

Parameters
[in]full_element_nameThe full name of the element in point notation (i.e. "element1.child_element[4].element_value").
Returns
The Codec Index of the DecoderElement.
Remarks
The element is only valid as long as the factory exists.
Exceptions
throwsstd::runtime_error if not found.

◆ getElementAddress()

void* getElementAddress ( const CodecIndex codec_index)
Parameters
[in]codec_indexThe index of the element.
Returns
A pointer to the element for write access.

◆ getElements() [1/2]

Elements& getElements ( )

Retrieves the elements of the codec to get element information.

Returns
Elements The elements iterator container.
See also
forEachLeafElement, forEachElement
Codec::Element, The Codec Index and the Element Iterator

◆ getElements() [2/2]

const Elements& getElements

Retrieves the elements of the decoder to get element information and get values.

Returns
Elements The elements iterator container.
See also
forEachLeafElement, forEachElement
Decoder::Element, The Codec Index and the Element Iterator

◆ resetValues()

void resetValues ( bool  zero_values = false)

Sets all elements to their default values, constant values defined in the data definition or zero if zero_values is set.

Parameters
[in]zero_valuesset the value to 0 if no constant or default value set in data definition.

◆ setElementRawValue()

void setElementRawValue ( const CodecIndex codec_index,
const void *  value,
size_t  value_size 
)

Sets the current value of the given element by copying its data from the passed-in location.

Parameters
[in]codec_indexThe codec index of the element.
[in]valueThe location where the data should be copied from.
[in]value_sizeThe size in bytes of the location (if 0 - unsafe usage!).
Exceptions
throwsstd::runtime_error if not found or value_size is lower then elements value memory to copy.

◆ setElementStringValue()

void setElementStringValue ( const CodecIndex codec_index,
const std::string &  value 
)

Sets the current value of the given element from the given string.

This will cast the given value to the elements data type!

Parameters
[in]codec_indexThe index of the element.
[in]valueThe value to set.
Exceptions
throwsstd::runtime_error if not found.

◆ setElementValue()

void setElementValue ( const CodecIndex codec_index,
const T &  value 
)
inline

Sets the current value of the given element from given value in type T.

This will cast the given value to the elements data type!

Parameters
[in]codec_indexThe index of the element.
[in]valueThe value to set.
Template Parameters
TType of the value to set
Exceptions
throwsstd::runtime_error if not found.

Definition at line 199 of file repo/src/libraries/mediadescription/include/ddl/codec_preview/codec.h.

References ValueSetter< CodecType, ValueType >::setValue().

Referenced by cSampleCodec::SetElementValue().

◆ setElementVariantValue()

void setElementVariantValue ( const CodecIndex codec_index,
const a_util::variant::Variant value 
)

Sets the current value of the given element from the given variant.

If this element is a enum type the enum types element name can be used in value. Otherwise the string value is automatically converted to the elments data type, if possible.

Parameters
[in]codec_indexThe index of the element.
[in]valueThe value to set.
Exceptions
throwsstd::runtime_error if not found.

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