Kwave::Decoder Class Reference

#include <Decoder.h>

Inheritance diagram for Kwave::Decoder:

Collaboration diagram for Kwave::Decoder:

Signals
void	sourceProcessed (quint64 pos)

Public Member Functions
	Decoder ()
virtual	~Decoder ()
virtual Decoder *	instance ()=0
virtual bool	open (QWidget *widget, QIODevice &source)=0
virtual bool	decode (QWidget *widget, Kwave::MultiWriter &dst)=0
virtual void	close ()=0
virtual Kwave::MetaDataList &	metaData ()
Public Member Functions inherited from Kwave::CodecBase
	CodecBase ()
virtual	~CodecBase ()
virtual bool	supports (const QMimeType &mimetype)
virtual bool	supports (const QString &mimetype_name)
virtual QStringList	extensions (const QString &mimetype_name) const
virtual const QList< CodecBase::MimeType >	mimeTypes ()
virtual const QList< Kwave::Compression::Type >	compressionTypes ()
virtual void	addMimeType (const char *name, const QString &description, const char *patterns)
virtual void	addCompression (Kwave::Compression::Type compression)
virtual QString	mimeTypeOf (const QUrl &url)

Protected Attributes
Kwave::MetaDataList	m_meta_data

Detailed Description

Definition at line 37 of file Decoder.h.

Constructor & Destructor Documentation

Decoder()

Kwave::Decoder::Decoder

(

)

Constructor

Definition at line 22 of file Decoder.cpp.

    :QObject(), Kwave::CodecBase()
{
}

~Decoder()

Kwave::Decoder::~Decoder ( )

virtual

Destructor

Definition at line 28 of file Decoder.cpp.

{
}

Member Function Documentation

close()

virtual void Kwave::Decoder::close ( )

pure virtual

Closes the io device.

Implemented in Kwave::FlacDecoder, Kwave::WavDecoder, Kwave::MP3Decoder, Kwave::AsciiDecoder, Kwave::AudiofileDecoder, and Kwave::OggDecoder.

decode()

virtual bool Kwave::Decoder::decode ( QWidget *  widget, Kwave::MultiWriter &  dst  )

pure virtual

Decodes a stream of bytes into a signal

Parameters

widget	a widget that can be used for displaying message boxes or dialogs
dst	writer that receives the audio data

Returns

true if succeeded, false on errors

Implemented in Kwave::FlacDecoder, Kwave::WavDecoder, Kwave::MP3Decoder, Kwave::AsciiDecoder, Kwave::AudiofileDecoder, and Kwave::OggDecoder.

Referenced by Kwave::MimeData::decode().

Here is the caller graph for this function:

instance()

virtual Decoder* Kwave::Decoder::instance ( )

pure virtual

Returns a new instance of the decoder

Implemented in Kwave::FlacDecoder, Kwave::WavDecoder, Kwave::MP3Decoder, Kwave::AsciiDecoder, Kwave::AudiofileDecoder, and Kwave::OggDecoder.

Referenced by Kwave::CodecManager::decoder().

Here is the caller graph for this function:

metaData()

virtual Kwave::MetaDataList& Kwave::Decoder::metaData ( )

inlinevirtual

Returns the meta data of the file, only valid after open() has successfully been called.

Definition at line 78 of file Decoder.h.

Referenced by Kwave::OggDecoder::decode(), Kwave::AudiofileDecoder::decode(), Kwave::AsciiDecoder::decode(), Kwave::WavDecoder::decode(), Kwave::FlacDecoder::decode(), Kwave::MimeData::decode(), Kwave::OggDecoder::open(), Kwave::AudiofileDecoder::open(), Kwave::AsciiDecoder::open(), Kwave::MP3Decoder::open(), Kwave::WavDecoder::open(), Kwave::FlacDecoder::open(), Kwave::OggDecoder::parseHeader(), Kwave::MP3Decoder::parseID3Tags(), Kwave::MP3Decoder::parseMp3Header(), Kwave::FlacDecoder::parseStreamInfo(), Kwave::FlacDecoder::parseVorbisComments(), and Kwave::FlacDecoder::write_callback().

{ return m_meta_data; }

Here is the caller graph for this function:

open()

virtual bool Kwave::Decoder::open ( QWidget *  widget, QIODevice &  source  )

pure virtual

Opens the source and decodes the header information.

Parameters

widget	a widget that can be used for displaying message boxes or dialogs
source	file or other source with a stream of bytes

Returns

true if succeeded, false on errors

Implemented in Kwave::FlacDecoder, Kwave::WavDecoder, Kwave::MP3Decoder, Kwave::AsciiDecoder, Kwave::AudiofileDecoder, and Kwave::OggDecoder.

Referenced by Kwave::MimeData::decode().

Here is the caller graph for this function:

sourceProcessed

void Kwave::Decoder::sourceProcessed ( quint64  pos )

signal

Can be used to signal the current position within the source when a stream without info about the resulting signal is processed.

Parameters

pos	current position within the source, in bytes!

Referenced by Kwave::OggDecoder::decode().

Here is the caller graph for this function:

Member Data Documentation

m_meta_data

Kwave::MetaDataList Kwave::Decoder::m_meta_data

protected

meta data of the file

Definition at line 93 of file Decoder.h.

---

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

• libkwave/Decoder.h
• libkwave/Decoder.cpp