adtf_file::adtf3 Namespace Reference

namespace for support of ADTF 3 files More...

Classes
class	MediaDescriptionDeserializer
	DDL based Sample Deserializer implementation for ADTF 3 Samples with timestamps of microseconds resolution. This deserializer deserializes the DDL described values of the sample content from the input stream into the sample data buffer adtf_file::ReadSample::beginBufferWrite. More...
class	MediaDescriptionDeserializerNs
	DDL based Sample Deserializer implementation for ADTF 3 Samples with timestamps of nanoseconds resolution. This deserializer deserializes the DDL described values of the sample content from the input stream into the sample data buffer adtf_file::ReadSample::beginBufferWrite. More...
class	MediaDescriptionSerializer
	DDL based Sample Serializer implementation for ADTF 3 Samples with timestamps of microseconds resolution. This serializer serializes the DDL described values of the sample content from the sample data buffer adtf_file::WriteSample::beginBufferRead into the output stream. More...
class	MediaDescriptionSerializerNs
	DDL based Sample Serializer implementation for ADTF 3 Samples with timestamps of nanoseconds resolution. This serializer serializes the DDL described values of the sample content from the sample data buffer adtf_file::WriteSample::beginBufferRead into the output stream. More...
class	SampleCopyDeserializer
	SampleDeserializer for ADTF 3 Samples with timestamp of microseconds resolution. This deserializer "only" memcpy the sample content from the input stream into the sample data buffer adtf_file::ReadSample::beginBufferWrite. More...
class	SampleCopyDeserializerNs
	SampleDeserializer for ADTF 3 Samples with timestamp of nanoseconds resolution. This deserializer "only" memcpy the sample content from the input stream into the sample data buffer adtf_file::ReadSample::beginBufferWrite. More...
class	SampleCopySerializer
	Standard Sample Copy Serializer implementation for ADTF 3 Samples with timestamps of microseconds resolution This serializer "only" memcpy the sample content from the sample data buffer adtf_file::WriteSample::beginBufferRead into the output stream. More...
class	SampleCopySerializerNs
	Standard Sample Copy Serializer implementation for ADTF 3 Samples with timestamps of nanoseconds resolution This serializer "only" memcpy the sample content from the sample data buffer adtf_file::WriteSample::beginBufferRead into the output stream. More...
struct	HashValueStorage
	Value Storage struct. More...
class	StreamTypeDeserializer
	default stream type deserializer of ADTF 3 stream types. More...
class	StreamTypeSerializer
	default stream type serializer of ADTF 3 stream types. More...
struct	SubstreamProperties
class	SubstreamType
class	StandardTypeSerializers
	Default container with all ADTF 3 StreamTypeSerializer provided by the ADTF File Library. More...

Enumerations
enum class	HashedValueType : uint8_t {   hvt_invalid = 0 , hvt_bool = 2 , hvt_int8 = 3 , hvt_uint8 = 4 ,   hvt_int16 = 5 , hvt_uint16 = 6 , hvt_int32 = 7 , hvt_uint32 = 8 ,   hvt_float32 = 9 , hvt_float64 = 10 , hvt_int64 = 12 , hvt_uint64 = 13 }
	Value type identifier for sample info within adtf_file::ReadSample, adtf_file::WriteSample.

Functions
bool	hasSampleInfo (const WriteSample &sample)
	Checks wether the sample has trailing sample information or not. More...
void	serializeSampleInfo (const WriteSample &sample, OutputStream &stream)
	serializes the sample info as trailing data to the sample More...
void	deserializeSampleInfo (ReadSample &sample, InputStream &stream)
	deserializes the sample info from stream as trailing data to the sample if hasSampleInfo returned with true More...
std::unordered_map< std::string, SubstreamProperties >	getSubstreams (const PropertyStreamType &type)
SubstreamProperties	getSubstreamProperties (const PropertyStreamType &type, const std::string &substream)

Detailed Description

namespace for support of ADTF 3 files

Function Documentation

deserializeSampleInfo()

void adtf_file::adtf3::deserializeSampleInfo	(	ReadSample &	sample,
		InputStream &	stream
	)

deserializes the sample info from stream as trailing data to the sample if hasSampleInfo returned with true

Parameters

sample	the sample to deserialize the sample info to
stream	the stream to read

getSubstreamProperties()

SubstreamProperties adtf_file::adtf3::getSubstreamProperties	(	const PropertyStreamType &	type,
		const std::string &	substream
	)

Extract the properties of a single substream.

Parameters

[in]	type	The input stream type.
[in]	substream	The name of the substream.

Returns

The properties of the substream.

getSubstreams()

std::unordered_map<std::string, SubstreamProperties> adtf_file::adtf3::getSubstreams

(

const PropertyStreamType &

type

)

Parses the properties of the given stream type and extracts information about all substreams.

Parameters

[in]

type

The input stream type.

Returns

A map of substreams.

hasSampleInfo()

bool adtf_file::adtf3::hasSampleInfo

(

const WriteSample &

sample

)

Checks wether the sample has trailing sample information or not.

Parameters

sample

the sample to check

Returns

true

false

serializeSampleInfo()

void adtf_file::adtf3::serializeSampleInfo	(	const WriteSample &	sample,
		OutputStream &	stream
	)

serializes the sample info as trailing data to the sample

Parameters

sample	the sample to serialze the sample info from
stream	the stream to write