Read and write Vorbis (Xiph) tags in an Ogg container. More...

#include <libmythmetadata/metaiooggvorbis.h>

Inheritance diagram for MetaIOOggVorbis:

Collaboration diagram for MetaIOOggVorbis:

Public Member Functions
	MetaIOOggVorbis (void)=default

	~MetaIOOggVorbis (void) override=default

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

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

Public Member Functions inherited from MetaIOTagLib
	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	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 Private Member Functions
static TagLib::Ogg::Vorbis::File *	OpenFile (const QString &filename)
	Open the file to read 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 Member Functions inherited from MetaIOTagLib
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)

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

Static Protected Member Functions inherited from MetaIOTagLib
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...

Protected Attributes inherited from MetaIO
QString	m_filename

QString	m_filenameFormat

Detailed Description

Read and write Vorbis (Xiph) tags in an Ogg container.

Definition at line 18 of file metaiooggvorbis.h.

Constructor & Destructor Documentation

◆ MetaIOOggVorbis()

MetaIOOggVorbis::MetaIOOggVorbis ( void )

default

◆ ~MetaIOOggVorbis()

MetaIOOggVorbis::~MetaIOOggVorbis ( void )

overridedefault

Member Function Documentation

◆ OpenFile()

TagLib::Ogg::Vorbis::File * MetaIOOggVorbis::OpenFile ( const QString & filename )

staticprivate

Open the file to read the tag.

Parameters

filename The filename

Returns: A taglib file object for this format

Definition at line 13 of file metaiooggvorbis.cpp.

Referenced by read(), and write().

◆ read()

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

overridevirtual

Reads MusicMetadata from a file.

Parameters

filename The filename to read metadata from.

Returns: MusicMetadata pointer or nullptr on error

Implements MetaIOTagLib.

Definition at line 88 of file metaiooggvorbis.cpp.

◆ write()

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

overridevirtual

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

Definition at line 31 of file metaiooggvorbis.cpp.

Referenced by VorbisEncoder::~VorbisEncoder().

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

mythtv/libs/libmythmetadata/metaiooggvorbis.h
mythtv/libs/libmythmetadata/metaiooggvorbis.cpp

Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MetaIOOggVorbis()

◆ ~MetaIOOggVorbis()

Member Function Documentation

◆ OpenFile()

◆ read()

◆ write()