#include <sample_codec.h>

Inherits adtf::mediadescription::osborn::cSampleDecoderBase.

Public Member Functions
	cSampleDecoder ()=default

	cSampleDecoder (cSampleDecoder &&)

cSampleDecoder &	operator= (cSampleDecoder &&)

size_t	GetBufferSize () const
	Gets the buffer size in bytes for the main structure.

size_t	GetBufferSize (ddl::tDataRepresentation eRep) const
	Gets the buffer size in bytes for the main structure.

const void *	GetData () const
	Get the current data pointer.

size_t	GetDataSize () const
	Get the current data size.

Public Member Functions inherited from adtf::mediadescription::osborn::cSampleDecoderBase
	cSampleDecoderBase ()

	cSampleDecoderBase (cSampleDecoderBase &&)

cSampleDecoderBase &	operator= (cSampleDecoderBase &&)

tResult	IsValid () const

tElement	GetElement (const tCodecIndex &oCodecIndex) const

tElement	GetElement (std::string_view strElementFullName) const

tElement	GetChildElement (const tCodecIndex &oCodecIndex, std::string_view strElementPath) const

const tElements &	GetElements () const

size_t	GetElementChildCount (const tCodecIndex &oCodecIndex) const

std::string	GetElementFullName (const tCodecIndex &oCodecIndex) const
	Retrieves the full name of the element within its main structure.

std::string	GetElementName (const tCodecIndex &oCodecIndex) const
	Retrieves the name of the element within its structured element.

const std::string &	GetElementBaseName (const tCodecIndex &oCodecIndex) const
	Retrieves the base name of the element within its structured element.

size_t	GetStaticBufferSize () const
	Gets the static buffer size in bytes for the main structure.

size_t	GetStaticBufferSize (ddl::tDataRepresentation eRep) const
	Gets the static buffer size in bytes for the main structure.

ddl::tDataRepresentation	GetRepresentation () const

template<typename T>
T	GetElementValue (const tCodecIndex &oCodecIndex) const
	Gets the elements value as value of type T. You may use a valid codec index retrieved by the cSampleCodecFactory, but no other! This is to prepare for decoding in advance:

template<typename T>
T	GetElementValue (const penguin::tLeafCodecIndex &oLeafCodecIndex) const
	Gets the elements value as value of type T. You may use a valid codec index retrieved by the cSampleCodecFactory, but no other! This is to prepare for decoding in advance:

a_util::variant::Variant	GetElementVariantValue (const tCodecIndex &oCodecIndex) const

void	GetElementVariantValue (const tCodecIndex &oCodecIndex, a_util::variant::Variant &oValue) const

std::string	GetElementStringValue (const tCodecIndex &oCodecIndex) const

void	GetElementRawValue (const tCodecIndex &oCodecIndex, void *pValue, size_t szValueSize) const
	Copies the elements value to the given memory pointer in `pValue`.

const void *	GetElementAddress (const tCodecIndex &oCodecIndex) const
	Gets the elements value memory pointer into the given data.

void	Resolve (tCodecIndex &oCodecIndex) const

tResult	GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
	Get the Element StructElement information.

adtf_util::cVariant	GetElementValue (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value.

tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.

tResult	GetElementValue (const char *strElementName, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.

tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, void *pValue) const
	Legacy: Copies the Element Value memory into the memory pointer. Keep in MIND this function is UNSAFE in case of value memory is biger than the given one.

tResult	GetElementValue (const char strElementName, void pValue) const
	Legacy: Get the Element Value pointer.

const void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element StructElement information.

tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const

Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cDecoderLegacy
tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const

adtf_util::cVariant	GetElementValue (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value.

tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.

tResult	GetElementValue (const char *strElementName, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value.

tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, void *pValue) const
	Legacy: Copies the Element Value memory into the memory pointer. Keep in MIND this function is UNSAFE in case of value memory is biger than the given one.

tResult	GetElementValue (const char strElementName, void pValue) const
	Legacy: Get the Element Value pointer.

adtf_util::cString	GetElementValueString (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value as string (resolved to the enum element name if is enum type)

tResult	GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
	Get the Element StructElement information.

const void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element StructElement information.

size_t	GetElementCount () const
	Legacy: Get the Element Leaf count.

Friends
class	cSampleCodecFactory

Additional Inherited Members
Public Types inherited from adtf::mediadescription::osborn::cSampleDecoderBase
typedef ddl::codec::DecoderElement< sample_decoder_access< const cSampleDecoderBase > >	tElement

typedef ddl::codec::ChildElements< sample_decoder_access< const cSampleDecoderBase > >	tElements

Public Types inherited from adtf::mediadescription::osborn::adtf_ddl_access::cDecoderLegacy
typedef ddl::StructElement	DefinedStructElementType
	type definition for the old access_element API.

Static Public Member Functions inherited from adtf::mediadescription::osborn::adtf_ddl_access::cDecoderLegacy
static const char *	GetStructElementName (const ddl::StructElement *pElement)
	Legacy: Get the Struct Element Name for access_element legacy support.

Protected Member Functions inherited from adtf::mediadescription::osborn::cSampleDecoderBase
void	ResetFirst ()

Detailed Description

Decoder for samples with static and/or dynamic data.

Constructor & Destructor Documentation

◆ cSampleDecoder() [1/2]

adtf::mediadescription::osborn::cSampleDecoder::cSampleDecoder ( )

default

Default constructor

◆ cSampleDecoder() [2/2]

adtf::mediadescription::osborn::cSampleDecoder::cSampleDecoder ( cSampleDecoder && )

Move constructor

Member Function Documentation

◆ GetBufferSize() [1/2]

size_t adtf::mediadescription::osborn::cSampleDecoder::GetBufferSize ( ) const

Gets the buffer size in bytes for the main structure.

Return values

size_t size in bytes of the structure depending on the current representation (GetRepresentation)

◆ GetBufferSize() [2/2]

size_t adtf::mediadescription::osborn::cSampleDecoder::GetBufferSize ( ddl::tDataRepresentation eRep ) const

Gets the buffer size in bytes for the main structure.

Parameters

eRep	option to retrieve size in bytes for the deserialized or serialized representation.

Return values

size_t size in bytes of the structure depending on the given representation eRep

◆ GetData()

const void * adtf::mediadescription::osborn::cSampleDecoder::GetData ( ) const

inline

Get the current data pointer.

Returns: const void*

◆ GetDataSize()

size_t adtf::mediadescription::osborn::cSampleDecoder::GetDataSize ( ) const

inline

Get the current data size.

Returns: const void*

◆ operator=()

cSampleDecoder & adtf::mediadescription::osborn::cSampleDecoder::operator= ( cSampleDecoder && )

Move assignment operator

The documentation for this class was generated from the following file:

src/libraries/mediadescription/include/adtfmediadescription/sample_codec.h

Public Member Functions

Friends

Additional Inherited Members