#include <libmythmetadata/metaio.h>

Inheritance diagram for MetaIO:

Classes
struct	m_fileinfo

Public Member Functions
	MetaIO ()

virtual	~MetaIO (void)=default

virtual bool	write (const QString &filename, MusicMetadata *mdata)=0
	Writes all metadata back to a file. More...

virtual bool	writeVolatileMetadata (const QString &filename, MusicMetadata *mdata)
	Writes rating and playcount back to a file. More...

virtual MusicMetadata *	read (const QString &filename)=0
	Reads MusicMetadata from a file. More...

virtual bool	supportsEmbeddedImages (void)
	Does the tag support embedded cover art. More...

virtual AlbumArtList	getAlbumArtList (const QString &filename)
	Reads the list of embedded images in the tag. More...

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 MusicMetadata based on the folder/filename. More...

MusicMetadata *	readFromFilename (const QString &filename, bool blnLength=false)
	Reads MusicMetadata based on the folder/filename. More...

void	readFromFilename (MusicMetadata *metadata)
	Reads MusicMetadata based on the folder/filename. More...

virtual bool	TagExists (const QString &filename)

Static Public Member Functions
static MetaIO *	createTagger (const QString &filename)
	Finds an appropriate tagger for the given file. More...

static MusicMetadata *	readMetadata (const QString &filename)
	Read the metadata from `filename` directly. More...

static MusicMetadata *	getMetadata (const QString &filename)
	Get the metadata for `filename`. More...

Static Public Attributes
static const QString	kValidFileExtensions

Protected Member Functions
void	saveTimeStamps (void)

void	restoreTimeStamps (void)

virtual std::chrono::milliseconds	getTrackLength (const QString &filename)=0

Protected Attributes
QString	m_filename

QString	m_filenameFormat

Detailed Description

Definition at line 17 of file metaio.h.

Constructor & Destructor Documentation

◆ MetaIO()

MetaIO::MetaIO ( )

Definition at line 25 of file metaio.cpp.

◆ ~MetaIO()

virtual MetaIO::~MetaIO ( void )

virtualdefault

Member Function Documentation

◆ changeImageType()

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

inlinevirtual

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 85 of file metaio.h.

Referenced by MainServer::HandleMusicTagChangeImage().

◆ createTagger()

MetaIO * MetaIO::createTagger ( const QString & filename )

static

Finds an appropriate tagger for the given file.

Parameters

filename The filename to find a tagger for.

Returns: MetaIO Pointer, or nullptr if non found.

Note: The caller is responsible for freeing it when no longer required

Definition at line 31 of file metaio.cpp.

Referenced by MusicFileScanner::AddFileToDB(), ImportMusicDialog::addPressed(), MusicMetadata::getTagger(), readMetadata(), ImportMusicDialog::scanDirectory(), and EditAlbumartDialog::showMenu().

◆ getAlbumArt()

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

inlinevirtual

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 92 of file metaio.h.

Referenced by ExtractImage().

◆ getAlbumArtList()

virtual AlbumArtList MetaIO::getAlbumArtList ( const QString & filename )

inlinevirtual

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 MetaIOFLACVorbis, and MetaIOID3.

Definition at line 68 of file metaio.h.

Referenced by MusicFileScanner::AddFileToDB(), and MainServer::HandleMusicFindAlbumArt().

◆ getMetadata()

MusicMetadata * MetaIO::getMetadata ( const QString & filename )

static

Get the metadata for filename.

First tries to read the metadata from the database. If there is no database entry, it'll call MetaIO::readMetadata.

Parameters

filename The filename to get metadata for.

Returns: an instance of MusicMetadata owned by the caller

Definition at line 90 of file metaio.cpp.

Referenced by MusicFileScanner::UpdateFileInDB().

◆ getTrackLength()

virtual std::chrono::milliseconds MetaIO::getTrackLength ( const QString & filename )

protectedpure virtual

Implemented in MetaIOAVFComment, MetaIOMP4, and MetaIOTagLib.

Referenced by readFromFilename().

◆ read()

virtual MusicMetadata * MetaIO::read ( const QString & filename )

pure virtual

Reads MusicMetadata from a file.

Parameters

filename The filename to read metadata from.

Returns: MusicMetadata pointer or nullptr on error

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

Referenced by readMetadata(), and ImportMusicDialog::scanDirectory().

◆ readFromFilename() [1/3]

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

Reads MusicMetadata based on the folder/filename.

Parameters

filename	The filename to try and determine metadata for.
blnLength	If true, read the file length as well.

Returns: MusicMetadata Pointer, or nullptr on error.

Definition at line 169 of file metaio.cpp.

◆ readFromFilename() [2/3]

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

Reads MusicMetadata based on the folder/filename.

Parameters

[in]	filename	The filename to try and determine metadata for.
[out]	artist
[out]	album
[out]	title
[out]	genre
[out]	tracknum

Definition at line 101 of file metaio.cpp.

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

◆ readFromFilename() [3/3]

void MetaIO::readFromFilename ( MusicMetadata * metadata )

Reads MusicMetadata based on the folder/filename.

Parameters

metadata MusicMetadata Pointer

Definition at line 192 of file metaio.cpp.

◆ readMetadata()

MusicMetadata * MetaIO::readMetadata ( const QString & filename )

static

Read the metadata from filename directly.

Creates a MetaIO object using MetaIO::createTagger and uses the MetaIO object to read the metadata.

Parameters

filename The filename to read metadata from.

Returns: an instance of MusicMetadata owned by the caller

Definition at line 62 of file metaio.cpp.

Referenced by MusicFileScanner::AddFileToDB(), getMetadata(), handleMedia(), and MusicFileScanner::UpdateFileInDB().

◆ removeAlbumArt()

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

inlinevirtual

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 79 of file metaio.h.

Referenced by MainServer::HandleMusicTagRemoveImage().

◆ restoreTimeStamps()

void MetaIO::restoreTimeStamps ( void )

protected

Definition at line 232 of file metaio.cpp.

Referenced by MetaIOID3::SaveFile(), MetaIOFLACVorbis::write(), MetaIOOggVorbis::write(), MetaIOWavPack::write(), and MetaIOFLACVorbis::writeAlbumArt().

◆ saveTimeStamps()

void MetaIO::saveTimeStamps ( void )

protected

Definition at line 223 of file metaio.cpp.

Referenced by MetaIOID3::SaveFile(), MetaIOFLACVorbis::write(), MetaIOOggVorbis::write(), MetaIOWavPack::write(), and MetaIOFLACVorbis::writeAlbumArt().

◆ supportsEmbeddedImages()

virtual bool MetaIO::supportsEmbeddedImages ( void )

inlinevirtual

Does the tag support embedded cover art.

Returns: true if reading/writing embedded images are supported

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 57 of file metaio.h.

Referenced by MusicFileScanner::AddFileToDB(), ExtractImage(), MainServer::HandleMusicFindAlbumArt(), MainServer::HandleMusicTagAddImage(), MainServer::HandleMusicTagChangeImage(), MainServer::HandleMusicTagRemoveImage(), and EditAlbumartDialog::showMenu().

◆ TagExists()

virtual bool MetaIO::TagExists ( const QString & filename )

inlinevirtual

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 123 of file metaio.h.

◆ write()

virtual bool MetaIO::write	(	const QString &	filename,
		MusicMetadata *	mdata
	)

pure virtual

Writes all metadata back to a file.

Parameters

filename	The filename to write metadata to
mdata	A pointer to a MusicMetadata object

Returns: Boolean to indicate success/failure.

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

Referenced by ImportMusicDialog::addPressed(), MainServer::HandleMusicTagUpdateMetadata(), and UpdateMeta().

◆ writeAlbumArt()

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

inlinevirtual

Reimplemented in MetaIOFLACVorbis, and MetaIOID3.

Definition at line 73 of file metaio.h.

Referenced by MainServer::HandleMusicTagAddImage().

◆ writeVolatileMetadata()

virtual bool MetaIO::writeVolatileMetadata	(	const QString &	filename,
		MusicMetadata *	mdata
	)

inlinevirtual

Writes rating and playcount back to a file.

Parameters

filename	The filename to write metadata to
mdata	A pointer to a MusicMetadata object

Returns: Boolean to indicate success/failure.

Reimplemented in MetaIOID3.

Definition at line 38 of file metaio.h.

Member Data Documentation

◆ kValidFileExtensions

const QString MetaIO::kValidFileExtensions

static

Definition at line 160 of file metaio.h.

Referenced by MusicFileScanner::AddFileToDB(), createTagger(), avfDecoderFactory::extension(), GetMusicFilter(), MusicFileScanner::IsMusicFile(), and setupKeys().

◆ m_filename

QString MetaIO::m_filename

protected

Definition at line 168 of file metaio.h.

Referenced by MetaIOID3::CloseFile(), MetaIOID3::OpenFile(), restoreTimeStamps(), saveTimeStamps(), MetaIOFLACVorbis::write(), MetaIOOggVorbis::write(), MetaIOWavPack::write(), and MetaIOFLACVorbis::writeAlbumArt().

◆ m_filenameFormat

QString MetaIO::m_filenameFormat

protected

Definition at line 169 of file metaio.h.

Referenced by readFromFilename().

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

mythtv/libs/libmythmetadata/metaio.h
mythtv/libs/libmythmetadata/metaio.cpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MetaIO()

◆ ~MetaIO()

Member Function Documentation

◆ changeImageType()

◆ createTagger()

◆ getAlbumArt()

◆ getAlbumArtList()

◆ getMetadata()

◆ getTrackLength()

◆ read()

◆ readFromFilename() [1/3]

◆ readFromFilename() [2/3]

◆ readFromFilename() [3/3]

◆ readMetadata()

◆ removeAlbumArt()

◆ restoreTimeStamps()

◆ saveTimeStamps()

◆ supportsEmbeddedImages()

◆ TagExists()

◆ write()

◆ writeAlbumArt()

◆ writeVolatileMetadata()

Member Data Documentation

◆ kValidFileExtensions

◆ m_filename

◆ m_filenameFormat