#include <MetadataHandlerWMA.h>

Inheritance diagram for sbMetadataHandlerWMA:

Collaboration diagram for sbMetadataHandlerWMA:

Protected Member Functions
	~sbMetadataHandlerWMA ()

nsString	ReadHeaderValue (IWMHeaderInfo3 *aHeaderInfo, const nsAString &aKey)

NS_METHOD	CreateWMPMediaItem (const nsAString &aFilePath, IWMPMedia3 **aMedia)

NS_METHOD	ReadMetadataWMFSDK (const nsAString &aFilePath, PRInt32 *_retval)

NS_METHOD	ReadMetadataWMP (const nsAString &aFilePath, PRInt32 *_retval)

NS_METHOD	ReadAlbumArtWMFSDK (const nsAString &aFilePath, nsACString &aMimeType, PRUint32 aDataLen, PRUint8 *aData)

NS_METHOD	ReadAlbumArtWMP (const nsAString &aFilePath, nsACString &aMimeType, PRUint32 aDataLen, PRUint8 *aData)

NS_METHOD	SetImageDataInternal (PRInt32 aType, const nsAString &aURL, IWMHeaderInfo3 *aHeader, PRBool &aSuccess)

Protected Attributes
nsCOMPtr< sbIMutablePropertyArray >	m_PropertyArray

nsCOMPtr< sbIMetadataChannel >	m_ChannelHandler

nsCOMPtr< nsIChannel >	m_Channel

nsString	m_FilePath

PRBool	m_Completed

Additional Inherited Members
Public Member Functions inherited from sbIMetadataHandler
PRInt32	vote (in AString aUrl)
	Vote to be the handler returned for the given url. More...

PRInt32	read ()
	Start the read operation. More...

PRInt32	write ()
	Start the write operation. More...

void	getImageData (in PRInt32 aType, out AUTF8String aMimeType, out unsigned long aDataLen, [array, retval, size_is(aDataLen)] out octet aData)

void	setImageData (in PRInt32 aType, in AString aUrl)

void	onChannelData (in nsISupports aChannel)
	Be thou informst that one's sbIMetadataChannel has just received data. More...

void	close ()
	Close down the internals of the handler, stop any asynchronous operations, free any allocations. More...

Public Member Functions inherited from sbIMetadataHandlerWMA
PRBool	isDRMProtected (in AString aPath)
	Check if a file is DRM protected. More...

Public Attributes inherited from sbIMetadataHandler
const PRUint32	METADATA_IMAGE_TYPE_OTHER = 0x00
	Constant for the type of image in the metadata, these are pulled from the taglib/attachedpictureframe.h. More...

const PRUint32	METADATA_IMAGE_TYPE_FILEICON = 0x01

const PRUint32	METADATA_IMAGE_TYPE_OTHERFILEICON = 0x02

const PRUint32	METADATA_IMAGE_TYPE_FRONTCOVER = 0x03

const PRUint32	METADATA_IMAGE_TYPE_BACKCOVER = 0x04

const PRUint32	METADATA_IMAGE_TYPE_LEAFLETPAGE = 0x05

const PRUint32	METADATA_IMAGE_TYPE_MEDIA = 0x06

const PRUint32	METADATA_IMAGE_TYPE_LEADARTIST = 0x07

const PRUint32	METADATA_IMAGE_TYPE_ARTIST = 0x08

const PRUint32	METADATA_IMAGE_TYPE_CONDUCTOR = 0x09

const PRUint32	METADATA_IMAGE_TYPE_BAND = 0x0A

const PRUint32	METADATA_IMAGE_TYPE_COMPOSER = 0x0B

const PRUint32	METADATA_IMAGE_TYPE_LYRICIST = 0x0C

const PRUint32	METADATA_IMAGE_TYPE_RECORDINGLOCATION = 0x0D

const PRUint32	METADATA_IMAGE_TYPE_DURINGRECORDING = 0x0E

const PRUint32	METADATA_IMAGE_TYPE_DURINGPERFORMANCE = 0x0F

const PRUint32	METADATA_IMAGE_TYPE_MOVIESCREENCAPTURE = 0x10

const PRUint32	METADATA_IMAGE_TYPE_COLOUREDFISH = 0x11

const PRUint32	METADATA_IMAGE_TYPE_ILLUSTRATION = 0x12

const PRUint32	METADATA_IMAGE_TYPE_BANDLOGO = 0x13

const PRUint32	METADATA_IMAGE_TYPE_PUBLISHERLOGO = 0x14

readonly attribute ACString	contractID
	The Contract ID for the metadata handler. More...

attribute sbIMutablePropertyArray	props
	An array of metadata properties. More...

readonly attribute PRBool	completed
	Whether or not the object has completed its read/write operation. More...

readonly attribute PRBool	requiresMainThread
	Whether or not this handler MUST be run on the main thread. More...

attribute nsIChannel	channel
	The object's nsIChannel. More...

Detailed Description

Definition at line 58 of file MetadataHandlerWMA.h.

Constructor & Destructor Documentation

sbMetadataHandlerWMA::~sbMetadataHandlerWMA ( )

protected

Definition at line 191 of file MetadataHandlerWMA.cpp.

Member Function Documentation

NS_METHOD sbMetadataHandlerWMA::CreateWMPMediaItem	(	const nsAString &	aFilePath,
		IWMPMedia3 **	aMedia
	)

protected

Utility function for the WMP metadata reading paths Given a (absolute native) file path, return a IWMPMedia3 that can be used to read metadata

Parameters

aFilePath	the path to the file to read
aMedia	[out] the media object

Definition at line 871 of file MetadataHandlerWMA.cpp.

Here is the caller graph for this function:

NS_METHOD sbMetadataHandlerWMA::ReadAlbumArtWMFSDK	(	const nsAString &	aFilePath,
		nsACString &	aMimeType,
		PRUint32 *	aDataLen,
		PRUint8 **	aData
	)

protected

Read album art meadata from a file, using the WMFSDK APIs

Parameters

aFilePath	the path of the file to read
aMimeType	[out] the mime type of the metadata
aDataLen	[out] the length of the image data stream
aData	[out] the raw image data

Definition at line 1101 of file MetadataHandlerWMA.cpp.

Here is the call graph for this function:

NS_METHOD sbMetadataHandlerWMA::ReadAlbumArtWMP	(	const nsAString &	aFilePath,
		nsACString &	aMimeType,
		PRUint32 *	aDataLen,
		PRUint8 **	aData
	)

protected

Read album art meadata from a file, using the WMP APIs

Parameters

aFilePath	the path of the file to read
aMimeType	[out] the mime type of the metadata
aDataLen	[out] the length of the image data stream
aData	[out] the raw image data

Definition at line 1193 of file MetadataHandlerWMA.cpp.

Here is the call graph for this function:

nsString sbMetadataHandlerWMA::ReadHeaderValue	(	IWMHeaderInfo3 *	aHeaderInfo,
		const nsAString &	aKey
	)

protected

Read a single string-based metadata (for the WMF API methods)

Parameters

aHeaderInfo	the header data to read from
aKey	the (WMF) metadata key name to read

Returns: the value of the metadata found in the file, or a void string if no values are found

Definition at line 728 of file MetadataHandlerWMA.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NS_METHOD sbMetadataHandlerWMA::ReadMetadataWMFSDK	(	const nsAString &	aFilePath,
		PRInt32 *	_retval
	)

protected

Read generic metadata from a file, using the WMFSDK APIs

Parameters

aFilePath	the path of the file to read
_retval	the number of metadata values read

See Also: sbIMetadataHandler::read()

Definition at line 932 of file MetadataHandlerWMA.cpp.

Here is the call graph for this function:

NS_METHOD sbMetadataHandlerWMA::ReadMetadataWMP	(	const nsAString &	aFilePath,
		PRInt32 *	_retval
	)

protected

Read generic metadata from a file, using the WMP APIs

Parameters

aFilePath	the path of the file to read
_retval	the number of metadata values read

See Also: sbIMetadataHandler::read()

Definition at line 1006 of file MetadataHandlerWMA.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbMetadataHandlerWMA::SetImageDataInternal	(	PRInt32	aType,
		const nsAString &	aURL,
		IWMHeaderInfo3 *	aHeader,
		PRBool &	aSuccess
	)

protected

Internal helper for writing the image data This is used because both SetImageData(0 and Write() may want to do this, but we can't have two IWMMetadataEditor instances open on the same file

Parameters

aType	the image type
aURL	the url of the image file (must be local file)
aHeader	a pre-opened IWMHeaderInfo3 to write to
aSuccess	[out] whether data was written

See Also: sbIMetadataHandler::SetImageData

Definition at line 541 of file MetadataHandlerWMA.cpp.

Here is the call graph for this function:

Member Data Documentation

nsCOMPtr<nsIChannel> sbMetadataHandlerWMA::m_Channel

protected

Definition at line 72 of file MetadataHandlerWMA.h.

nsCOMPtr<sbIMetadataChannel> sbMetadataHandlerWMA::m_ChannelHandler

protected

Definition at line 71 of file MetadataHandlerWMA.h.

PRBool sbMetadataHandlerWMA::m_Completed

protected

Definition at line 74 of file MetadataHandlerWMA.h.

nsString sbMetadataHandlerWMA::m_FilePath

protected

Definition at line 73 of file MetadataHandlerWMA.h.

nsCOMPtr<sbIMutablePropertyArray> sbMetadataHandlerWMA::m_PropertyArray

protected

Definition at line 70 of file MetadataHandlerWMA.h.

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

/home/martin/dev/nightingale-hacking/components/mediacore/metadata/handler/wma/src/MetadataHandlerWMA.h
/home/martin/dev/nightingale-hacking/components/mediacore/metadata/handler/wma/src/MetadataHandlerWMA.cpp

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation