Kwave::OggEncoder Class Reference

#include <OggEncoder.h>

Inheritance diagram for Kwave::OggEncoder:

Collaboration diagram for Kwave::OggEncoder:

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

Private Attributes
Kwave::VorbisCommentMap	m_comments_map

Detailed Description

Definition at line 34 of file OggEncoder.h.

Constructor & Destructor Documentation

OggEncoder()

Kwave::OggEncoder::OggEncoder

(

)

Constructor

Definition at line 42 of file OggEncoder.cpp.

References REGISTER_COMPRESSION_TYPE_OGG_OPUS, REGISTER_COMPRESSION_TYPE_OGG_VORBIS, REGISTER_OGG_OPUS_MIME_TYPES, and REGISTER_OGG_VORBIS_MIME_TYPES.

    :Kwave::Encoder(), m_comments_map()
{
#ifdef HAVE_OGG_OPUS
    REGISTER_OGG_OPUS_MIME_TYPES
    REGISTER_COMPRESSION_TYPE_OGG_OPUS
#endif /* HAVE_OGG_OPUS */

#ifdef HAVE_OGG_VORBIS
    REGISTER_OGG_VORBIS_MIME_TYPES
    REGISTER_COMPRESSION_TYPE_OGG_VORBIS
#endif /* HAVE_OGG_VORBIS */
}

~OggEncoder()

Kwave::OggEncoder::~OggEncoder ( )

virtual

Destructor

Definition at line 57 of file OggEncoder.cpp.

{
}

Member Function Documentation

encode()

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

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

Implements Kwave::Encoder.

Definition at line 74 of file OggEncoder.cpp.

References Kwave::FileInfo::contains(), Kwave::MessageBox::error(), Kwave::Compression::fromInt(), Kwave::FileInfo::get(), Kwave::INF_COMPRESSION, name, Kwave::Compression::NONE, Kwave::Compression::OGG_OPUS, and Kwave::Compression::OGG_VORBIS.

{
    const Kwave::FileInfo info(meta_data);
    QSharedPointer<Kwave::OggSubEncoder> sub_encoder;

    // determine which codec (sub encoder) to use,
    // by examining the compression type
    const Kwave::Compression::Type compression =
        info.contains(Kwave::INF_COMPRESSION) ? Kwave::Compression::fromInt(
        info.get(Kwave::INF_COMPRESSION).toInt()) : Kwave::Compression::NONE;

#ifdef HAVE_OGG_OPUS
    if (compression == Compression::OGG_OPUS) {
        qDebug("    OggEncoder: using Opus codec");
        sub_encoder =
            QSharedPointer<Kwave::OpusEncoder>(new Kwave::OpusEncoder());
    }
#endif /* HAVE_OGG_OPUS */
#ifdef HAVE_OGG_VORBIS
    if (compression == Compression::OGG_VORBIS) {
        qDebug("    OggEncoder: using Vorbis codec");
        sub_encoder =
            QSharedPointer<Kwave::VorbisEncoder>(new Kwave::VorbisEncoder());
    }
#endif /* HAVE_OGG_VORBIS */

    if (!sub_encoder) {
        qDebug("    OggEncoder: compression='%d'", compression);
        Kwave::MessageBox::error(widget, i18nc(
            "error in Ogg encoder, no support for a compression type "
            "(e.g. opus, vorbis etc)",
            "Error: No Codec for '%1' available",
            Kwave::Compression(compression).name()
        ));
        return false;
    }

    if (!sub_encoder->open(widget, info, src))
        return false;

    // open the output device
    if (!dst.open(QIODevice::ReadWrite | QIODevice::Truncate)) {
        Kwave::MessageBox::error(widget,
            i18n("Unable to open the file for saving."));
        return false;
    }

    if (!sub_encoder->writeHeader(dst))
        return false;

    if (!sub_encoder->encode(src, dst))
        return false;

    // clean up and exit.
    sub_encoder->close();

    // the sub encoder will be deleted automatically (QSharedPointer)

    return true;
}

Here is the call graph for this function:

instance()

Kwave::Encoder * Kwave::OggEncoder::instance ( )

virtual

Returns a new instance of the encoder

Implements Kwave::Encoder.

Definition at line 62 of file OggEncoder.cpp.

{
    return new Kwave::OggEncoder();
}

supportedProperties()

QList< Kwave::FileProperty > Kwave::OggEncoder::supportedProperties ( )

virtual

Returns a list of supported file properties

Reimplemented from Kwave::Encoder.

Definition at line 68 of file OggEncoder.cpp.

References m_comments_map.

{
    return m_comments_map.values();
}

Member Data Documentation

m_comments_map

Kwave::VorbisCommentMap Kwave::OggEncoder::m_comments_map

private

map for translating Opus comments to Kwave FileInfo

Definition at line 68 of file OggEncoder.h.

Referenced by supportedProperties().

---

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

• plugins/codec_ogg/OggEncoder.h
• plugins/codec_ogg/OggEncoder.cpp