Base for Taglib metadata classes. More...

#include <libmythmetadata/metaiotaglib.h>

Inheritance diagram for MetaIOTagLib:

Collaboration diagram for MetaIOTagLib:

Public Member Functions
	MetaIOTagLib (void)=default

	~MetaIOTagLib (void) override=default

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

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

Public Member Functions inherited from MetaIO
	MetaIO ()

virtual	~MetaIO (void)=default

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

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

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

virtual bool	writeAlbumArt ([[maybe_unused]] const QString &filename, [[maybe_unused]] const AlbumArtImage *albumart)

virtual bool	removeAlbumArt ([[maybe_unused]] const QString &filename, [[maybe_unused]] const AlbumArtImage *albumart)

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

virtual QImage *	getAlbumArt ([[maybe_unused]] const QString &filename, [[maybe_unused]] 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 ([[maybe_unused]] const QString &filename)

Protected Member Functions
std::chrono::milliseconds	getTrackLength (const QString &filename) override
	Find the length of the track (in milliseconds) More...

void	ReadGenericMetadata (TagLib::Tag tag, MusicMetadata metadata)
	Writes metadata common to all tag formats to the tag. More...

Protected Member Functions inherited from MetaIO
void	saveTimeStamps (void)

void	restoreTimeStamps (void)

Static Protected Member Functions
static std::chrono::milliseconds	getTrackLength (TagLib::File *file)
	Find the length of the track (in milliseconds) More...

static void	WriteGenericMetadata (TagLib::Tag tag, const MusicMetadata metadata)
	Writes metadata common to all tag formats to the tag. More...

Additional Inherited Members
Static Public Member Functions inherited from MetaIO
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 inherited from MetaIO
static const QString	kValidFileExtensions

Protected Attributes inherited from MetaIO
QString	m_filename

QString	m_filenameFormat

Detailed Description

Base for Taglib metadata classes.

Definition at line 20 of file metaiotaglib.h.

Constructor & Destructor Documentation

◆ MetaIOTagLib()

MetaIOTagLib::MetaIOTagLib ( void )

default

◆ ~MetaIOTagLib()

MetaIOTagLib::~MetaIOTagLib ( void )

overridedefault

Member Function Documentation

◆ write()

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

overridepure 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.

Implements MetaIO.

Implemented in MetaIOID3, MetaIOWavPack, MetaIOFLACVorbis, and MetaIOOggVorbis.

◆ read()

MusicMetadata* MetaIOTagLib::read ( const QString & filename )

overridepure virtual

Reads MusicMetadata from a file.

Parameters

filename The filename to read metadata from.

Returns: MusicMetadata pointer or nullptr on error

Implements MetaIO.

Implemented in MetaIOID3, MetaIOFLACVorbis, MetaIOWavPack, and MetaIOOggVorbis.

◆ getTrackLength() [1/2]

std::chrono::milliseconds MetaIOTagLib::getTrackLength ( TagLib::File * file )

staticprotected

Find the length of the track (in milliseconds)

Parameters

file	Pointer to file object

Returns: An integer (signed!) to represent the length in milliseconds.

Definition at line 89 of file metaiotaglib.cpp.

Referenced by MetaIOOggVorbis::read(), MetaIOWavPack::read(), MetaIOFLACVorbis::read(), and MetaIOID3::read().

◆ getTrackLength() [2/2]

std::chrono::milliseconds MetaIOTagLib::getTrackLength ( const QString & filename )

overrideprotectedvirtual

Find the length of the track (in milliseconds)

Parameters

filename The filename for which we want to find the length.

Returns: An integer (signed!) to represent the length in milliseconds.

Implements MetaIO.

Definition at line 105 of file metaiotaglib.cpp.

◆ ReadGenericMetadata()

void MetaIOTagLib::ReadGenericMetadata	(	TagLib::Tag *	tag,
		MusicMetadata *	metadata
	)

protected

Writes metadata common to all tag formats to the tag.

Parameters

tag	A pointer to the tag
metadata	Pointer to the MusicMetadata

Definition at line 54 of file metaiotaglib.cpp.

Referenced by MetaIOOggVorbis::read(), MetaIOWavPack::read(), MetaIOFLACVorbis::read(), and MetaIOID3::read().

◆ WriteGenericMetadata()

void MetaIOTagLib::WriteGenericMetadata	(	TagLib::Tag *	tag,
		const MusicMetadata *	metadata
	)

staticprotected

Writes metadata common to all tag formats to the tag.

Parameters

tag	A pointer to the tag
metadata	Pointer to the MusicMetadata

Definition at line 24 of file metaiotaglib.cpp.

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

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

mythtv/libs/libmythmetadata/metaiotaglib.h
mythtv/libs/libmythmetadata/metaiotaglib.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MetaIOTagLib()

◆ ~MetaIOTagLib()

Member Function Documentation

◆ write()

◆ read()

◆ getTrackLength() [1/2]

◆ getTrackLength() [2/2]

◆ ReadGenericMetadata()

◆ WriteGenericMetadata()