Kwave::Encoder Class Reference

#include <Encoder.h>

Inheritance diagram for Kwave::Encoder:

Collaboration diagram for Kwave::Encoder:

Public Member Functions
	Encoder ()
virtual	~Encoder ()
virtual Encoder *	instance ()=0
virtual bool	encode (QWidget *widget, Kwave::MultiTrackReader &src, QIODevice &dst, const Kwave::MetaDataList &meta_data)=0
virtual QList< Kwave::FileProperty >	supportedProperties ()
virtual QList< Kwave::FileProperty >	unsupportedProperties (const QList< Kwave::FileProperty > &properties_to_check)
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)

Detailed Description

Definition at line 38 of file Encoder.h.

Constructor & Destructor Documentation

Encoder()

Kwave::Encoder::Encoder

(

)

Constructor

Definition at line 21 of file Encoder.cpp.

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

~Encoder()

virtual Kwave::Encoder::~Encoder ( )

inlinevirtual

Destructor

Definition at line 46 of file Encoder.h.

{}

Member Function Documentation

encode()

virtual bool Kwave::Encoder::encode ( QWidget *  widget, Kwave::MultiTrackReader &  src, QIODevice &  dst, const Kwave::MetaDataList &  meta_data  )

pure virtual

Encodes a signal into a stream of bytes.

Parameters

widget	a widget that can be used for displaying message boxes or dialogs
src	MultiTrackReader used as source of the audio data
dst	file or other source to receive a stream of bytes
meta_data	meta data of the file to save

Returns

true if succeeded, false on errors

Implemented in Kwave::FlacEncoder, Kwave::MP3Encoder, Kwave::WavEncoder, Kwave::AsciiEncoder, and Kwave::OggEncoder.

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

Here is the caller graph for this function:

instance()

virtual Encoder* Kwave::Encoder::instance ( )

pure virtual

Returns a new instance of the encoder

Implemented in Kwave::FlacEncoder, Kwave::MP3Encoder, Kwave::WavEncoder, Kwave::AsciiEncoder, and Kwave::OggEncoder.

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

Here is the caller graph for this function:

supportedProperties()

virtual QList<Kwave::FileProperty> Kwave::Encoder::supportedProperties ( )

inlinevirtual

Returns a list of supported file properties

Reimplemented in Kwave::FlacEncoder, Kwave::MP3Encoder, Kwave::WavEncoder, Kwave::AsciiEncoder, and Kwave::OggEncoder.

Definition at line 66 of file Encoder.h.

Referenced by unsupportedProperties().

                                                               {
            QList<Kwave::FileProperty> empty;
            return empty;
        }

Here is the caller graph for this function:

unsupportedProperties()

QList< Kwave::FileProperty > Kwave::Encoder::unsupportedProperties ( const QList< Kwave::FileProperty > &  properties_to_check )

virtual

Returns a list of all properties within a list of properties which are not supported by this encoder

Parameters

properties_to_check

list of properties to check

Returns

list of unsupported properties (may be empty)

Definition at line 27 of file Encoder.cpp.

References Kwave::FileInfo::canLoadSave(), and supportedProperties().

Referenced by Kwave::K3BExportPlugin::saveBlocks(), and Kwave::SaveBlocksPlugin::start().

{
    QList<Kwave::FileProperty> unsupported;
    const QList<Kwave::FileProperty> supported(supportedProperties());
    const Kwave::FileInfo info;

    foreach (const Kwave::FileProperty &s, properties_to_check) {
        if (info.canLoadSave(s) && !supported.contains(s))
            unsupported.append(s);
    }

    return unsupported;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• libkwave/Encoder.h
• libkwave/Encoder.cpp