MetaIO Class Reference

#include <metaio.h>

Inheritance diagram for MetaIO:

List of all members.

Public Member Functions
	MetaIO (void)
	Constructor.
virtual	~MetaIO (void)
	Destructor.
virtual bool	write (const Metadata *mdata)=0
	Writes all metadata back to a file.
virtual bool	writeVolatileMetadata (const Metadata *mdata)
	Writes rating and playcount back to a file.
virtual Metadata *	read (const QString &filename)=0
	Reads Metadata from a file.
virtual bool	supportsEmbeddedImages (void)
	Does the tag support embedded cover art.
virtual AlbumArtList	getAlbumArtList (const QString &filename)
	Reads the list of embedded images in the tag.
virtual bool	writeAlbumArt (const QString &filename, const AlbumArtImage *albumart)
virtual bool	removeAlbumArt (const QString &filename, const AlbumArtImage *albumart)
virtual bool	changeImageType (const QString &filename, const AlbumArtImage *albumart, ImageType newType)
virtual QImage *	getAlbumArt (const QString &filename, ImageType type)
void	readFromFilename (const QString &filename, QString &artist, QString &album, QString &title, QString &genre, int &tracknum)
	Reads Metadata based on the folder/filename.
Metadata *	readFromFilename (const QString &filename, bool blnLength=false)
	Reads Metadata based on the folder/filename.
void	readFromFilename (Metadata *metadata)
	Reads Metadata based on the folder/filename.
virtual bool	TagExists (const QString &filename)
Private Member Functions
virtual int	getTrackLength (const QString &filename)=0
Private Attributes
QString	mFilename
QString	mFilenameFormat

---

Detailed Description

Definition at line 12 of file metaio.h.

---

Constructor & Destructor Documentation

MetaIO::MetaIO

(

void

)

Constructor.

Definition at line 12 of file metaio.cpp.

MetaIO::~MetaIO

(

void

)

[virtual]

Destructor.

Definition at line 20 of file metaio.cpp.

---

Member Function Documentation

virtual bool MetaIO::write

(

const Metadata *

mdata

)

[pure virtual]

Writes all metadata back to a file.

Parameters:

mdata

A pointer to a Metadata object

Returns:

Boolean to indicate success/failure.

Implemented in MetaIOAVFComment, MetaIOFLACVorbis, MetaIOID3, MetaIOMP4, MetaIOOggVorbis, MetaIOTagLib, and MetaIOWavPack.

Referenced by Decoder::commitMetadata(), and EditMetadataCommon::saveAll().

virtual bool MetaIO::writeVolatileMetadata

(

const Metadata *

mdata

)

[inline, virtual]

Writes rating and playcount back to a file.

Parameters:

mdata

A pointer to a Metadata object

Returns:

Boolean to indicate success/failure.

Reimplemented in MetaIOID3.

Definition at line 32 of file metaio.h.

Referenced by Decoder::commitVolatileMetadata().

virtual Metadata* MetaIO::read

(

const QString &

filename

)

[pure virtual]

Reads Metadata from a file.

Parameters:

filename

The filename to read metadata from.

Returns:

Metadata pointer or NULL on error

Implemented in MetaIOAVFComment, MetaIOFLACVorbis, MetaIOID3, MetaIOMP4, MetaIOOggVorbis, MetaIOTagLib, and MetaIOWavPack.

Referenced by Decoder::readMetadata().

virtual bool MetaIO::supportsEmbeddedImages

(

void

)

[inline, virtual]

Does the tag support embedded cover art.

Returns:

true if reading/writing embedded images are supported

Reimplemented in MetaIOID3.

Definition at line 51 of file metaio.h.

Referenced by FileScanner::AddFileToDB(), AlbumArtImages::addImage(), ImportMusicDialog::addPressed(), EditAlbumartDialog::customEvent(), EditAlbumartDialog::doCopyImageToTag(), EditAlbumartDialog::doRemoveImageFromTag(), EditMetadataCommon::scanForImages(), and EditAlbumartDialog::showMenu().

virtual AlbumArtList MetaIO::getAlbumArtList

(

const QString &

filename

)

[inline, virtual]

Reads the list of embedded images in the tag.

Parameters:

filename

The filename to read images from.

Returns:

the list of embedded images

Reimplemented in MetaIOID3.

Definition at line 62 of file metaio.h.

Referenced by FileScanner::AddFileToDB(), ImportMusicDialog::addPressed(), and EditMetadataCommon::scanForImages().

virtual bool MetaIO::writeAlbumArt	(	const QString &	filename,
		const AlbumArtImage *	albumart
	)			[inline, virtual]

Reimplemented in MetaIOID3.

Definition at line 68 of file metaio.h.

Referenced by EditAlbumartDialog::doCopyImageToTag().

virtual bool MetaIO::removeAlbumArt	(	const QString &	filename,
		const AlbumArtImage *	albumart
	)			[inline, virtual]

Reimplemented in MetaIOID3.

Definition at line 76 of file metaio.h.

Referenced by EditAlbumartDialog::doRemoveImageFromTag().

virtual bool MetaIO::changeImageType	(	const QString &	filename,
		const AlbumArtImage *	albumart,
		ImageType	newType
	)			[inline, virtual]

Reimplemented in MetaIOID3.

Definition at line 84 of file metaio.h.

Referenced by EditAlbumartDialog::customEvent().

virtual QImage* MetaIO::getAlbumArt	(	const QString &	filename,
		ImageType	type
	)			[inline, virtual]

Reimplemented in MetaIOID3.

Definition at line 94 of file metaio.h.

Referenced by AlbumArtImages::addImage(), and Metadata::getAlbumArtFile().

void MetaIO::readFromFilename	(	const QString &	filename,
		QString &	artist,
		QString &	album,
		QString &	title,
		QString &	genre,
		int &	tracknum
	)

Reads Metadata based on the folder/filename.

Parameters:

filename

The filename to try and determine metadata for.

Returns:

Metadata Pointer, or NULL on error.

Definition at line 30 of file metaio.cpp.

Referenced by MetaIOMP4::read(), MetaIOAVFComment::read(), readFromFilename(), and Decoder::readMetadata().

Metadata * MetaIO::readFromFilename	(	const QString &	filename,
		bool	blnLength = false
	)

Reads Metadata based on the folder/filename.

Note:

Just an overloaded wrapper around the other method above.

Parameters:

filename

The filename to try and determine metadata for.

Returns:

Metadata Pointer, or NULL on error.

Definition at line 104 of file metaio.cpp.

void MetaIO::readFromFilename

(

Metadata *

metadata

)

Reads Metadata based on the folder/filename.

Parameters:

metadata

Metadata Pointer

Definition at line 125 of file metaio.cpp.

virtual bool MetaIO::TagExists

(

const QString &

filename

)

[inline, virtual]

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 109 of file metaio.h.

virtual int MetaIO::getTrackLength

(

const QString &

filename

)

[private, pure virtual]

Implemented in MetaIOAVFComment, MetaIOMP4, and MetaIOTagLib.

Referenced by readFromFilename().

---

Member Data Documentation

QString MetaIO::mFilename [private]

Definition at line 120 of file metaio.h.

QString MetaIO::mFilenameFormat [private]

Definition at line 121 of file metaio.h.

Referenced by MetaIO(), and readFromFilename().

---

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

• metaio.h
• metaio.cpp