#include <decoder.h>

Inheritance diagram for Decoder:

Public Member Functions
virtual	~Decoder ()
virtual bool	initialize ()=0
virtual void	seek (double)=0
virtual void	stop ()=0
DecoderFactory *	factory () const
QIODevice *	input ()
AudioOutput *	output ()
void	setInput (QIODevice *)
void	setOutput (AudioOutput *)
void	setFilename (const QString &newName)
virtual void	lock (void)
virtual void	unlock (void)
virtual bool	tryLock (void)
QWaitCondition *	cond ()
QString	getFilename (void) const
virtual Metadata *	readMetadata (void)
	Read the metadata from `filename` directly.
virtual Metadata *	getMetadata (void)
	Get the metadata for `filename`.
virtual MetaIO *	doCreateTagger (void)
	Create a `MetaIO` object for the format.
virtual void	commitMetadata (Metadata *mdata)
	Write the given metadata to the `filename`.
virtual void	commitVolatileMetadata (const Metadata *mdata)
	Write the changable metadata, e.g.
Static Public Member Functions
static QStringList	all ()
static bool	supports (const QString &)
static void	registerFactory (DecoderFactory *)
static Decoder *	create (const QString &, QIODevice , AudioOutput , bool=false)
static void	SetLocationFormatUseTags (void)
Protected Member Functions
	Decoder (DecoderFactory , QIODevice , AudioOutput *)
QMutex *	getMutex (void)
void	error (const QString &)
Protected Attributes
QString	filename
Static Protected Attributes
static QString	filename_format
static int	ignore_id3 = 0
static QString	musiclocation
Private Attributes
DecoderFactory *	fctry
QIODevice *	in
AudioOutput *	out
QMutex	mtx
QWaitCondition	cnd

Detailed Description

Definition at line 66 of file mythplugins/mythmusic/mythmusic/decoder.h.

Constructor & Destructor Documentation

Decoder::~Decoder ( ) [virtual]

Definition at line 32 of file decoder.cpp.

Decoder::Decoder	(	DecoderFactory *	d,
		QIODevice *	i,
		AudioOutput *	o
	)		`[protected]`

Definition at line 27 of file decoder.cpp.

Member Function Documentation

virtual bool Decoder::initialize ( ) [pure virtual]

Implemented in CdDecoder, and avfDecoder.

Referenced by MusicPlayer::decoderHandlerReady().

virtual void Decoder::seek ( double ) [pure virtual]

Implemented in CdDecoder, and avfDecoder.

Referenced by MusicCommon::seek(), and MusicPlayer::seek().

virtual void Decoder::stop ( ) [pure virtual]

Implemented in CdDecoder, and avfDecoder.

Referenced by DecoderHandler::stop().

DecoderFactory* Decoder::factory ( ) const [inline]

Definition at line 75 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by DecoderHandler::doConnectDecoder().

QIODevice* Decoder::input ( ) [inline]

Definition at line 77 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by avfDecoder::initialize(), and CdDecoder::initialize().

AudioOutput* Decoder::output ( ) [inline]

Definition at line 78 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by avfDecoder::initialize(), CdDecoder::initialize(), avfDecoder::run(), CdDecoder::run(), CdDecoder::seek(), avfDecoder::writeBlock(), and CdDecoder::writeBlock().

void Decoder::setInput ( QIODevice * i )

Definition at line 39 of file decoder.cpp.

Referenced by CdDecoderFactory::create(), avfDecoderFactory::create(), avfDecoder::deinit(), CdDecoder::deinit(), and DecoderHandler::doConnectDecoder().

void Decoder::setOutput ( AudioOutput * o )

Definition at line 46 of file decoder.cpp.

Referenced by CdDecoderFactory::create(), avfDecoderFactory::create(), MusicPlayer::decoderHandlerReady(), avfDecoder::deinit(), and CdDecoder::deinit().

void Decoder::setFilename ( const QString & newName ) [inline]

Definition at line 81 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by avfDecoder::avfDecoder(), CdDecoder::CdDecoder(), CdDecoderFactory::create(), DecoderHandler::doConnectDecoder(), CdDecoder::getMetadata(), and CdDecoder::initialize().

virtual void Decoder::lock ( void ) [inline, virtual]

Definition at line 83 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by CdDecoder::commitMetadata(), CdDecoder::deinit(), CdDecoder::getMetadata(), CdDecoder::getNumCDAudioTracks(), CdDecoder::getNumTracks(), CdDecoder::initialize(), MusicPlayer::pause(), CdDecoder::run(), MusicCommon::seek(), CdDecoder::setCDSpeed(), setInput(), setOutput(), and DecoderHandler::stop().

virtual void Decoder::unlock ( void ) [inline, virtual]

Definition at line 84 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by MusicPlayer::pause(), MusicCommon::seek(), setInput(), setOutput(), and DecoderHandler::stop().

virtual bool Decoder::tryLock ( void ) [inline, virtual]

Definition at line 85 of file mythplugins/mythmusic/mythmusic/decoder.h.

QWaitCondition* Decoder::cond ( ) [inline]

Definition at line 88 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by MusicPlayer::pause(), and DecoderHandler::stop().

QString Decoder::getFilename ( void ) const [inline]

Definition at line 90 of file mythplugins/mythmusic/mythmusic/decoder.h.

Referenced by CdDecoder::getMetadata(), and CdDecoder::initialize().

Metadata * Decoder::readMetadata ( void ) [virtual]

Read the metadata from filename directly.

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

Returns:: an instance of Metadata owned by the caller

Definition at line 67 of file decoder.cpp.

Referenced by FileScanner::AddFileToDB(), getMetadata(), and FileScanner::UpdateFileInDB().

Metadata * Decoder::getMetadata ( void ) [virtual]

Get the metadata for filename.

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

Returns:: an instance of Metadata owned by the caller

Reimplemented in CdDecoder.

Definition at line 102 of file decoder.cpp.

Referenced by ImportMusicDialog::scanDirectory(), and FileScanner::UpdateFileInDB().

MetaIO * Decoder::doCreateTagger ( void ) [virtual]

Create a MetaIO object for the format.

This method should be overwritten by subclasses to return an instance of the appropriate MetaIO subtype. It is used by Decoder::getMetadata, Decoder::readMetadata and Decoder::commitMetadata.

The default implementation returns a NULL pointer, which essentially means, that if the decoder does not overrider this method or all of the users (see previous paragraph), files that the decoder supports cannot be indexed using metadata in the file.

e.g. the avf decoder (AvfDecoder) implements this, whereas the audio CD decoder (CdDecoder) does not.