Kwave::CodecManager Class Reference

#include <CodecManager.h>

Inheritance diagram for Kwave::CodecManager:

Collaboration diagram for Kwave::CodecManager:

Public Member Functions
	CodecManager ()
virtual	~CodecManager ()

Static Public Member Functions
static void	registerEncoder (Kwave::Encoder &encoder)
static void	unregisterEncoder (Kwave::Encoder *encoder)
static void	registerDecoder (Kwave::Decoder &decoder)
static void	unregisterDecoder (Kwave::Decoder *decoder)
static bool	canDecode (const QString &mimetype_name)
static Kwave::Decoder *	decoder (const QString &mimetype_name)
static Kwave::Encoder *	encoder (const QString &mimetype_name)
static QString	encodingFilter ()
static QString	decodingFilter ()
static QString	mimeTypeOf (const QUrl &url)
static QStringList	encodingMimeTypes ()

Static Private Attributes
static QList< Kwave::Encoder * >	m_encoders
static QList< Kwave::Decoder * >	m_decoders

Detailed Description

Definition at line 35 of file CodecManager.h.

Constructor & Destructor Documentation

CodecManager()

Kwave::CodecManager::CodecManager

(

)

Constructor

Definition at line 38 of file CodecManager.cpp.

{
}

~CodecManager()

Kwave::CodecManager::~CodecManager ( )

virtual

Destructor

Definition at line 43 of file CodecManager.cpp.

References m_decoders, and m_encoders.

{
    Q_ASSERT(m_encoders.isEmpty());
    Q_ASSERT(m_decoders.isEmpty());
}

Member Function Documentation

canDecode()

bool Kwave::CodecManager::canDecode ( const QString &  mimetype_name )

static

Returns true if a decoder for the given mime type is known.

Parameters

mimetype_name

name of the mime type

Returns

true if format is supported, false if not

Definition at line 78 of file CodecManager.cpp.

References m_decoders, and Kwave::CodecBase::supports().

Referenced by Kwave::FileDrag::canDecode(), Kwave::Drag::canDecode(), Kwave::MimeData::decode(), Kwave::TopWidget::dropEvent(), Kwave::SignalView::dropEvent(), and Kwave::ClipBoard::isEmpty().

{
    foreach (Kwave::Decoder *d, m_decoders)
        if (d && d->supports(mimetype_name)) return true;
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

decoder()

Kwave::Decoder * Kwave::CodecManager::decoder ( const QString &  mimetype_name )

static

Tries to find a decoder that matches to a given mime type.

Parameters

mimetype_name

name of the mime type

Returns

a new decoder for the mime type or null if none found.

Definition at line 121 of file CodecManager.cpp.

References Kwave::Decoder::instance(), m_decoders, and Kwave::CodecBase::supports().

Referenced by Kwave::MimeData::decode(), and Kwave::SignalManager::loadFile().

{
    foreach (Kwave::Decoder *d, m_decoders)
        if (d && d->supports(mimetype_name)) return d->instance();
    return Q_NULLPTR;
}

Here is the call graph for this function:

Here is the caller graph for this function:

decodingFilter()

QString Kwave::CodecManager::decodingFilter ( )

static

Returns a string with a list of all file types that can be used for loading. The string is localized and can be used as a filter for a KFileDialog. The entries are unique (by file extension) but not sorted alphabetically.

Definition at line 171 of file CodecManager.cpp.

References _, DBG, Kwave::CodecBase::MimeType::description, m_decoders, Kwave::CodecBase::mimeTypes(), and Kwave::CodecBase::MimeType::patterns.

Referenced by Kwave::FileDialog::guessFilterFromFileExt(), and Kwave::TopWidget::openFile().

{
    QStringList list;
    QStringList all_extensions;

    foreach (Kwave::Decoder *d, m_decoders) {
        // loop over all mime types that the decoder supports
        QList<Kwave::CodecBase::MimeType> types = d->mimeTypes();
        QListIterator<Kwave::CodecBase::MimeType> ti(types);
        while (ti.hasNext()) {
            Kwave::CodecBase::MimeType type = ti.next();
            QString extensions = type.patterns.join(_(" "));

            // skip if extensions are already known/present
            if (!list.isEmpty() && list.join(_("\n")).contains(extensions))
                continue;

            // otherwise append to the list
            all_extensions += type.patterns;
            QString entry = extensions;
            QString comment =
                type.description.replace(QRegExp(_("/")), _(","));
            entry += _("|") + comment;
            list.append(entry + _(" (") + extensions + _(")"));
        }
    }

    // builtin type for macro files
    all_extensions += _("*.kwave");
    list.append(_("*.kwave|") + i18n("Kwave Macro Files") + _(" (*.kwave)"));

    // special entries for "all" and "all supported"
    list.sort();
    list.prepend(_("*|") + i18n("All Files"));
    list.prepend(all_extensions.join(_(" ")) + _("|") +
                 i18n("All Supported Files"));

    QString str_list = list.join(_("\n"));
    Q_ASSERT(!str_list.contains(QLatin1Char('/')));
    if (str_list.contains(QLatin1Char('/'))) {
        qWarning("CodecManager::decodingFilter() -> '%s'", DBG(str_list));
    }

    return str_list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

encoder()

Kwave::Encoder * Kwave::CodecManager::encoder ( const QString &  mimetype_name )

static

Tries to find an encoder that matches to a given mime type.

Parameters

mimetype_name

name of the mime type of the destination

Returns

a new encoder for the mime type or null if none found.

Definition at line 129 of file CodecManager.cpp.

References Kwave::Encoder::instance(), m_encoders, and Kwave::CodecBase::supports().

Referenced by Kwave::FileInfoDialog::compressionChanged(), Kwave::MimeData::encode(), Kwave::SignalManager::save(), Kwave::K3BExportPlugin::saveBlocks(), Kwave::FileContext::saveFileAs(), Kwave::FileInfoDialog::setupFileInfoTab(), Kwave::SaveBlocksPlugin::start(), and Kwave::FileInfoDialog::updateAvailableCompressions().

{
    foreach (Kwave::Encoder *e, m_encoders)
        if (e && e->supports(mimetype_name)) return e->instance();
    return Q_NULLPTR;
}

Here is the call graph for this function:

Here is the caller graph for this function:

encodingFilter()

QString Kwave::CodecManager::encodingFilter ( )

static

Returns a string with a list of all file types that can be used for saving. The string is localized and can be used as a filter for a KFileDialog. The entries are unique (by file extension) but not sorted alphabetically.

Definition at line 137 of file CodecManager.cpp.

References _, DBG, Kwave::CodecBase::MimeType::description, m_encoders, Kwave::CodecBase::mimeTypes(), and Kwave::CodecBase::MimeType::patterns.

Referenced by Kwave::FileDialog::guessFilterFromFileExt(), Kwave::FileContext::saveFileAs(), and Kwave::SaveBlocksPlugin::setup().

{
    QStringList list;
    foreach (Kwave::Encoder *e, m_encoders) {
        // loop over all mime types that the encoder supports
        QList<Kwave::CodecBase::MimeType> types = e->mimeTypes();
        QListIterator<Kwave::CodecBase::MimeType> ti(types);
        while (ti.hasNext()) {
            Kwave::CodecBase::MimeType type = ti.next();
            QString extensions = type.patterns.join(_(" "));

            // skip if extensions are already known/present
            if (!list.isEmpty() && list.join(_("\n")).contains(extensions))
                continue;

            // otherwise append to the list
            QString entry = extensions;
            QString comment = type.description.replace(
                QRegExp(_("/")), _(","));
            entry += _("|") + comment;
            list.append(entry + _(" (") + extensions + _(")"));
        }
    }
    list.sort();
    QString str_list = list.join(_("\n"));
    Q_ASSERT(!str_list.contains(QLatin1Char('/')));
    if (str_list.contains(QLatin1Char('/'))) {
        qWarning("CodecManager::encodingFilter() -> '%s'", DBG(str_list));
    }

    return str_list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

encodingMimeTypes()

QStringList Kwave::CodecManager::encodingMimeTypes ( )

static

Returns a list of supported mime types for encoding

Definition at line 106 of file CodecManager.cpp.

References m_encoders, Kwave::CodecBase::mimeTypes(), Kwave::CodecBase::MimeType::name, and name.

Referenced by Kwave::FileInfoDialog::compressionChanged(), and Kwave::FileInfoDialog::updateAvailableCompressions().

{
    QStringList list;
    foreach (Kwave::Encoder *e, m_encoders) {
        if (!e) continue;
        foreach (const Kwave::CodecBase::MimeType &mime_type, e->mimeTypes()) {
            QString name = mime_type.name;
            if (list.isEmpty() || !list.contains(name))
                list.append(name);
        }
    }
    return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mimeTypeOf()

QString Kwave::CodecManager::mimeTypeOf ( const QUrl &  url )

static

Tries to find the name of a mime type of a decoder by a URL. If not found, it returns the default mime type, never an empty string.

Parameters

url	a QUrl, only the filename's extension will be inspected

Returns

name of the mime type or the default mime type

Definition at line 86 of file CodecManager.cpp.

References m_decoders, m_encoders, and Kwave::CodecBase::mimeTypeOf().

Referenced by Kwave::FileDrag::canDecode(), Kwave::TopWidget::dropEvent(), Kwave::SignalView::dropEvent(), Kwave::SignalManager::loadFile(), Kwave::SignalManager::save(), Kwave::K3BExportPlugin::saveBlocks(), Kwave::FileContext::saveFileAs(), Kwave::FileInfoDialog::setupFileInfoTab(), and Kwave::SaveBlocksPlugin::start().

{
    const QString default_mime_type = QMimeType().name();

    foreach (Kwave::Decoder *d, m_decoders) {
        if (!d) continue;
        QString mime_type = d->mimeTypeOf(url);
        if (mime_type != default_mime_type) return mime_type;
    }
    foreach (Kwave::Encoder *e, m_encoders) {
        if (!e) continue;
        QString mime_type = e->mimeTypeOf(url);
        if (mime_type != default_mime_type) return mime_type;
    }

    QMimeDatabase db;
    return db.mimeTypeForUrl(url).name();
}

Here is the call graph for this function:

Here is the caller graph for this function:

registerDecoder()

void Kwave::CodecManager::registerDecoder ( Kwave::Decoder &  decoder )

static

Registers a new decoder.

Parameters

decoder

a KwaveDecoder that will be used as template for creating new decoder instances (used as factory)

Definition at line 64 of file CodecManager.cpp.

References m_decoders.

Referenced by Kwave::CodecPlugin::load().

{
    if (m_decoders.contains(&decoder)) return; /* already known */
    m_decoders.append(&decoder);
}

Here is the caller graph for this function:

registerEncoder()

void Kwave::CodecManager::registerEncoder ( Kwave::Encoder &  encoder )

static

Registers a new encoder.

Parameters

encoder

a KwaveEncoder that will be used as template for creating new encoder instances (used as factory)

Definition at line 50 of file CodecManager.cpp.

References m_encoders.

Referenced by Kwave::CodecPlugin::load().

{
    if (m_encoders.contains(&encoder)) return; /* already known */
    m_encoders.append(&encoder);
}

Here is the caller graph for this function:

unregisterDecoder()

void Kwave::CodecManager::unregisterDecoder ( Kwave::Decoder *  decoder )

static

Un-registers an decoder previously registered with registerDecoder.

Parameters

decoder

a KwaveDecoder

Definition at line 71 of file CodecManager.cpp.

References m_decoders.

Referenced by Kwave::CodecPlugin::unload().

{
    if (!m_decoders.contains(decoder)) return; /* unknown */
    m_decoders.removeAll(decoder);
}

Here is the caller graph for this function:

unregisterEncoder()

void Kwave::CodecManager::unregisterEncoder ( Kwave::Encoder *  encoder )

static

Un-registers an encoder previously registered with registerEncoder.

Parameters

encoder

a KwaveEncoder

Definition at line 57 of file CodecManager.cpp.

References m_encoders.

Referenced by Kwave::CodecPlugin::unload().

{
    if (!m_encoders.contains(encoder)) return; /* unknown */
    m_encoders.removeAll(encoder);
}

Here is the caller graph for this function:

Member Data Documentation

m_decoders

QList< Kwave::Decoder * > Kwave::CodecManager::m_decoders

staticprivate

list of decoders

Definition at line 125 of file CodecManager.h.

Referenced by canDecode(), decoder(), decodingFilter(), mimeTypeOf(), registerDecoder(), unregisterDecoder(), and ~CodecManager().

m_encoders

QList< Kwave::Encoder * > Kwave::CodecManager::m_encoders

staticprivate

list of all encoders

Definition at line 122 of file CodecManager.h.

Referenced by encoder(), encodingFilter(), encodingMimeTypes(), mimeTypeOf(), registerEncoder(), unregisterEncoder(), and ~CodecManager().

---

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

• libkwave/CodecManager.h
• libkwave/CodecManager.cpp