Ocean::Media::MediaFoundation::Utilities Class Reference

This class implements utilities functions for the Microsoft Media Foundation. More...

#include <Utilities.h>

Data Structures
struct	GUIDCompare
	GUID helper struct. More...

Static Public Member Functions
static std::string	attribute2String (const GUID &attribute)
	Translates a media foundation attribute to a readable string.
static std::string	majorMediaType2String (const GUID &type)
	Translates a major media type to a readable string.
static std::string	videoSubtype2String (const GUID &type)
	Translates a video subtype to a readable string.
static std::string	unregisteredVideoSubtype2String (const GUID &type)
	Translates an unregistered video subtype to a readable string.
static std::string	audioSubtype2String (const GUID &type)
	Translates an audio subtype to a readable string.
static std::string	transformCategory2String (const GUID &category)
	Translates an transform category to a readable string.
static std::string	guid2String (const GUID &value)
	Translates the GUID key to a string.
static bool	dumpAttributes (IMFAttributes *attributes, std::string &result)
	Dumps a set of attributes to a string object.
static bool	enumerateTransforms (std::string &result)
	Enumerates the registered media foundation transforms.
static LiveVideo::StreamType	mediaSubtypeToStreamType (const GUID &mediaSubtype, LiveVideo::CodecType *codecType=nullptr)
	Returns the stream type of a Media Foundation media subtype.
static FrameType::PixelFormat	mediaSubtypeToPixelFormat (const GUID &mediaSubtype)
	Returns the pixel format of a Media Foundation media subtype.
static GUID	convertPixelFormat (const FrameType::PixelFormat pixelFormat)
	Converts a pixel format to a Media Foundation media subtype.
static ScopedIMFMediaSource	createMediaSourceByUrl (const std::wstring &url)
	Creates the media source object for a given URL.
static ScopedIMFTopologyNode	addSourceNodeToTopology (IMFTopology *topology, IMFMediaSource *mediaSource, IMFPresentationDescriptor *presentationDescriptor, IMFStreamDescriptor *streamDescriptor)
	Adds a source node to a given topology.
static ScopedIMFTopologyNode	addOutputNodeToTopology (IMFTopology *topology, IMFActivate *sinkActivate, const DWORD streamIndex=0)
	Adds an output node to a given topology.
static bool	connectSelectedStream (IMFTopology *topology, IMFMediaSource *mediaSource, IMFActivate *sinkActivate, const GUID &majorMediaType)
	Connects the selected media source with a given sink activate object.
static bool	getAllocatedString (IMFActivate *activate, const GUID &key, std::string &value)
	Returns an allocated string from an activate.
template<typename T >
static ScopedMediaFoundationObject< T >	topologyNodeObject (IMFTopologyNode *node)
	Extracts an object from a topology node.
template<typename T >
static ScopedMediaFoundationObject< T >	eventObject (IMFMediaEvent *mediaEvent)
	Extracts an object from an event.

Private Types
using	IdMap = std::map< GUID, std::string, GUIDCompare >
	Definition of a map mapping GUID objects to strings.

Static Private Member Functions
static IdMap	guidMap ()
	Returns a map mapping all GUID ids to readable strings.
static IdMap	attributeMap ()
	Returns a map mapping attribute GUID ids to readable strings.
static IdMap	majorMediaTypeMap ()
	Returns a map mapping major media type GUID ids to readable strings.
static IdMap	videoSubtypeMap ()
	Returns a map mapping video subtype GUID ids to readable strings.
static IdMap	audioSubtypeMap ()
	Returns a map mapping audio subtype GUID ids to readable strings.
static IdMap	transformCategoryMap ()
	Returns a map mapping transform category GUID ids to readable strings.

Detailed Description

This class implements utilities functions for the Microsoft Media Foundation.

Member Typedef Documentation

IdMap

using Ocean::Media::MediaFoundation::Utilities::IdMap = std::map<GUID, std::string, GUIDCompare>

private

Definition of a map mapping GUID objects to strings.

Member Function Documentation

addOutputNodeToTopology()

static ScopedIMFTopologyNode Ocean::Media::MediaFoundation::Utilities::addOutputNodeToTopology ( IMFTopology *  topology, IMFActivate *  sinkActivate, const DWORD  streamIndex = 0  )

static

Adds an output node to a given topology.

Parameters

topology	The topology to that the node will be added, must be valid
sinkActivate	Sink activate object, must be valid
streamIndex	Stream index

Returns

Resulting topology node, invalid otherwise

addSourceNodeToTopology()

static ScopedIMFTopologyNode Ocean::Media::MediaFoundation::Utilities::addSourceNodeToTopology ( IMFTopology *  topology, IMFMediaSource *  mediaSource, IMFPresentationDescriptor *  presentationDescriptor, IMFStreamDescriptor *  streamDescriptor  )

static

Adds a source node to a given topology.

Parameters

topology	The topology to that the node will be added, must be valid
mediaSource	Media source object, must be valid
presentationDescriptor	Presentation descriptor, must be valid
streamDescriptor	Stream descriptor, must be valid

Returns

Resulting topology node, invalid otherwise

attribute2String()

static std::string Ocean::Media::MediaFoundation::Utilities::attribute2String ( const GUID &  attribute )

static

Translates a media foundation attribute to a readable string.

Parameters

attribute

The attribute to be translated

Returns

Translated attribute

attributeMap()

static IdMap Ocean::Media::MediaFoundation::Utilities::attributeMap ( )

staticprivate

Returns a map mapping attribute GUID ids to readable strings.

Returns

GUID map

audioSubtype2String()

static std::string Ocean::Media::MediaFoundation::Utilities::audioSubtype2String ( const GUID &  type )

static

Translates an audio subtype to a readable string.

Parameters

type	The type to be translated

Returns

Translated type

audioSubtypeMap()

static IdMap Ocean::Media::MediaFoundation::Utilities::audioSubtypeMap ( )

staticprivate

Returns a map mapping audio subtype GUID ids to readable strings.

Returns

GUID map

connectSelectedStream()

static bool Ocean::Media::MediaFoundation::Utilities::connectSelectedStream ( IMFTopology *  topology, IMFMediaSource *  mediaSource, IMFActivate *  sinkActivate, const GUID &  majorMediaType  )

static

Connects the selected media source with a given sink activate object.

Parameters

topology	The topology that will receive the connection, must be valid
mediaSource	The media source object, must be valid
sinkActivate	The sink activate object, must be valid
majorMediaType	Major media type

Returns

True, if succeeded

convertPixelFormat()

static GUID Ocean::Media::MediaFoundation::Utilities::convertPixelFormat ( const FrameType::PixelFormat  pixelFormat )

static

Converts a pixel format to a Media Foundation media subtype.

Parameters

pixelFormat

Pixel format

Returns

Media Foundation media type

createMediaSourceByUrl()

static ScopedIMFMediaSource Ocean::Media::MediaFoundation::Utilities::createMediaSourceByUrl ( const std::wstring &  url )

static

Creates the media source object for a given URL.

The resulting object has to be released by the caller.

Parameters

url	URL for that the media source object will be returned

Returns

Resulting media source object, invalid otherwise

dumpAttributes()

static bool Ocean::Media::MediaFoundation::Utilities::dumpAttributes ( IMFAttributes *  attributes, std::string &  result  )

static

Dumps a set of attributes to a string object.

Parameters

attributes	The attributes to dump
result	Resulting dump

Returns

True, if succeeded

enumerateTransforms()

static bool Ocean::Media::MediaFoundation::Utilities::enumerateTransforms ( std::string &  result )

static

Enumerates the registered media foundation transforms.

Parameters

result

The resulting enumerated transforms

Returns

True, if succeeded

eventObject()

template<typename T >

ScopedMediaFoundationObject< T > Ocean::Media::MediaFoundation::Utilities::eventObject ( IMFMediaEvent *  mediaEvent )

static

Extracts an object from an event.

Parameters

mediaEvent

Media event from that the object will be extracted, must be valid

Returns

Resulting object which must be released by the caller, otherwise nullptr

Template Parameters

T	Data type of the desired object

getAllocatedString()

static bool Ocean::Media::MediaFoundation::Utilities::getAllocatedString ( IMFActivate *  activate, const GUID &  key, std::string &  value  )

static

Returns an allocated string from an activate.

Parameters

activate	The activate from which the string will be returned, must be valid
key	The key identifying which value to retrieve, must be valid
value	The resulting string value @reutrn True, if succeeded

guid2String()

static std::string Ocean::Media::MediaFoundation::Utilities::guid2String ( const GUID &  value )

static

Translates the GUID key to a string.

Parameters

value

The value to be translated

Returns

Translated key

guidMap()

static IdMap Ocean::Media::MediaFoundation::Utilities::guidMap ( )

staticprivate

Returns a map mapping all GUID ids to readable strings.

Returns

GUID map

majorMediaType2String()

static std::string Ocean::Media::MediaFoundation::Utilities::majorMediaType2String ( const GUID &  type )

static

Translates a major media type to a readable string.

Parameters

type	The type to be translated

Returns

Translated type

majorMediaTypeMap()

static IdMap Ocean::Media::MediaFoundation::Utilities::majorMediaTypeMap ( )

staticprivate

Returns a map mapping major media type GUID ids to readable strings.

Returns

GUID map

mediaSubtypeToPixelFormat()

static FrameType::PixelFormat Ocean::Media::MediaFoundation::Utilities::mediaSubtypeToPixelFormat ( const GUID &  mediaSubtype )

static

Returns the pixel format of a Media Foundation media subtype.

Parameters

mediaSubtype

Media Foundation media type to convert

Returns

The resulting pixel format, FORMAT_UNDEFINED if no corresponding pixel format exists

mediaSubtypeToStreamType()

static LiveVideo::StreamType Ocean::Media::MediaFoundation::Utilities::mediaSubtypeToStreamType ( const GUID &  mediaSubtype, LiveVideo::CodecType *  codecType = nullptr  )

static

Returns the stream type of a Media Foundation media subtype.

Parameters

mediaSubtype	Media Foundation media type for that the stream type will be returned
codecType	Optional resulting codec type, nullptr if not of interest

Returns

The resulting stream type, ST_INVALID if no corresponding stream type exists

topologyNodeObject()

template<typename T >

ScopedMediaFoundationObject< T > Ocean::Media::MediaFoundation::Utilities::topologyNodeObject ( IMFTopologyNode *  node )

static

Extracts an object from a topology node.

Parameters

node	The node from that the object will be extracted, must be valid

Returns

Resulting object which must be released by the caller, otherwise nullptr

Template Parameters

T	Data type of the desired object

transformCategory2String()

static std::string Ocean::Media::MediaFoundation::Utilities::transformCategory2String ( const GUID &  category )

static

Translates an transform category to a readable string.

Parameters

category

The category to be translated

Returns

Translated type

transformCategoryMap()

static IdMap Ocean::Media::MediaFoundation::Utilities::transformCategoryMap ( )

staticprivate

Returns a map mapping transform category GUID ids to readable strings.

Returns

GUID map

unregisteredVideoSubtype2String()

static std::string Ocean::Media::MediaFoundation::Utilities::unregisteredVideoSubtype2String ( const GUID &  type )

static

Translates an unregistered video subtype to a readable string.

Parameters

type	The type to be translated

Returns

Translated type

videoSubtype2String()

static std::string Ocean::Media::MediaFoundation::Utilities::videoSubtype2String ( const GUID &  type )

static

Translates a video subtype to a readable string.

Parameters

type	The type to be translated

Returns

Translated type

videoSubtypeMap()

static IdMap Ocean::Media::MediaFoundation::Utilities::videoSubtypeMap ( )

staticprivate

Returns a map mapping video subtype GUID ids to readable strings.

Returns

GUID map

---

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

• media/mediafoundation/Utilities.h