Kwave::CodecBase Class Reference

#include <CodecBase.h>

Inheritance diagram for Kwave::CodecBase:

Collaboration diagram for Kwave::CodecBase:

Classes
struct	MimeType

Public Member Functions
	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
QList< MimeType >	m_supported_mime_types
QList< Kwave::Compression::Type >	m_supported_compression_types

Detailed Description

Definition at line 36 of file CodecBase.h.

Constructor & Destructor Documentation

CodecBase()

Kwave::CodecBase::CodecBase

(

)

Constructor

Definition at line 34 of file CodecBase.cpp.

    :m_supported_mime_types(), m_supported_compression_types()
{
}

~CodecBase()

Kwave::CodecBase::~CodecBase ( )

virtual

Destructor

Definition at line 40 of file CodecBase.cpp.

References m_supported_compression_types, and m_supported_mime_types.

{
    m_supported_mime_types.clear();
    m_supported_compression_types.clear();
}

Member Function Documentation

addCompression()

void Kwave::CodecBase::addCompression ( Kwave::Compression::Type  compression )

virtual

Adds a new compression type to the internal list of supported compression types.

Parameters

compression

the compression type

Definition at line 90 of file CodecBase.cpp.

References m_supported_compression_types.

{
    if (m_supported_compression_types.contains(compression)) return;

    m_supported_compression_types.append(compression);
    std::sort(m_supported_compression_types.begin(),
              m_supported_compression_types.end(), std::greater<int>());
}

addMimeType()

void Kwave::CodecBase::addMimeType ( const char *  name, const QString &  description, const char *  patterns  )

virtual

Adds a new mime type to the internal list of supported mime types. First it tries to find the mime type in the system, if none was found, a new mime type is created, using the passed parameters. The system's mime types are always preferred over the passed 'built-ins'.

Parameters

name	the mime type's name (may also be a comma separated list)
description	verbose description
patterns	list of file patterns, passed as a single string, separated by "; "

Definition at line 47 of file CodecBase.cpp.

References _, Kwave::CodecBase::MimeType::description, m_supported_mime_types, Kwave::CodecBase::MimeType::name, Kwave::CodecBase::MimeType::patterns, and supports().

Referenced by Kwave::AudiofileDecoder::AudiofileDecoder(), and Kwave::OggDecoder::OggDecoder().

{
    const QString type_name = _(name);
    if (type_name.contains(_(","))) {
        // list of mime types -> call recursively for each of them
        QStringList types = type_name.split(_(","), QString::SkipEmptyParts);
        foreach (const QString &mt, types) {
            addMimeType(mt.trimmed().toUtf8().data(), description, patterns);
        }
        return;
    }

    Kwave::CodecBase::MimeType type;
    QMimeDatabase db;
    QMimeType t = db.mimeTypeForName(type_name);

    if (t.isDefault() || t.name().isEmpty()) {
//      qWarning("mime type '%s' not registered, using built-in!", name);
        type.name        = type_name;
        type.description = description;
        type.patterns    = _(patterns).split(_("; "), QString::SkipEmptyParts);
    } else {
        type.description = t.comment();
        type.patterns    = t.globPatterns();

        if (t.name() != type_name) {
            // type has been translated (maybe un-alias'ed)
            // manually add the original name
            type.name    = type_name;
            m_supported_mime_types.append(type);
        }

        if  (!supports(t.name())) {
            // new type or new alias
            type.name    = t.name();
        }
    }
    m_supported_mime_types.append(type);
}

Here is the call graph for this function:

Here is the caller graph for this function:

compressionTypes()

const QList< Kwave::Compression::Type > Kwave::CodecBase::compressionTypes ( )

virtual

Returns a list of supported compression types

Definition at line 134 of file CodecBase.cpp.

References m_supported_compression_types.

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

{
    return m_supported_compression_types;
}

Here is the caller graph for this function:

extensions()

QStringList Kwave::CodecBase::extensions ( const QString &  mimetype_name ) const

virtual

Returns a list of supported file extensions

Definition at line 115 of file CodecBase.cpp.

References m_supported_mime_types, Kwave::CodecBase::MimeType::name, and Kwave::CodecBase::MimeType::patterns.

Referenced by Kwave::FileContext::saveFileAs().

{
    QStringList result;
    foreach (const Kwave::CodecBase::MimeType &mime, m_supported_mime_types) {
        if (mime.name == mimetype_name) {
            foreach (const QString &ext, mime.patterns)
                if (!result.contains(ext)) result.append(ext);
        }
    }
    return result;
}

Here is the caller graph for this function:

mimeTypeOf()

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

virtual

Tries to find the name of a mime type 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 140 of file CodecBase.cpp.

References _, m_supported_mime_types, Kwave::CodecBase::MimeType::name, and Kwave::CodecBase::MimeType::patterns.

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

{
    // get the extension of the file
    QFileInfo file(url.fileName());
    QString suffix = file.suffix();

    if (!suffix.length()) return QMimeType().name();
    suffix = _("*.") + suffix;

    // try to find in the list of supported mime types
    QListIterator<Kwave::CodecBase::MimeType> it(m_supported_mime_types);
    while (it.hasNext()) {
        Kwave::CodecBase::MimeType mime_type = it.next();
        if (mime_type.patterns.contains(suffix.toLower()))
            return mime_type.name;
    }
    return QMimeType().name();
}

Here is the caller graph for this function:

mimeTypes()

const QList< Kwave::CodecBase::MimeType > Kwave::CodecBase::mimeTypes ( )

virtual

Returns a list of supported mime types

Definition at line 128 of file CodecBase.cpp.

References m_supported_mime_types.

Referenced by Kwave::CodecManager::decodingFilter(), Kwave::CodecManager::encodingFilter(), and Kwave::CodecManager::encodingMimeTypes().

{
    return m_supported_mime_types;
}

Here is the caller graph for this function:

supports() [1/2]

bool Kwave::CodecBase::supports ( const QMimeType &  mimetype )

virtual

Returns true if the given mime type is supported

Definition at line 100 of file CodecBase.cpp.

Referenced by addMimeType(), Kwave::CodecManager::canDecode(), Kwave::CodecManager::decoder(), Kwave::CodecManager::encoder(), and Kwave::FileInfoDialog::setupFileInfoTab().

{
    return supports(mimetype.name());
}

Here is the caller graph for this function:

supports() [2/2]

bool Kwave::CodecBase::supports ( const QString &  mimetype_name )

virtual

Returns true if the given mime type is supported

Definition at line 106 of file CodecBase.cpp.

References m_supported_mime_types, and Kwave::CodecBase::MimeType::name.

{
    foreach (const Kwave::CodecBase::MimeType &mime, m_supported_mime_types) {
        if (mime.name == mimetype_name) return true;
    }
    return false;
}

Member Data Documentation

m_supported_compression_types

QList<Kwave::Compression::Type> Kwave::CodecBase::m_supported_compression_types

private

list of supported compression types

Definition at line 104 of file CodecBase.h.

Referenced by addCompression(), compressionTypes(), and ~CodecBase().

m_supported_mime_types

QList<MimeType> Kwave::CodecBase::m_supported_mime_types

private

list of supported mime types

Definition at line 101 of file CodecBase.h.

Referenced by addMimeType(), extensions(), mimeTypeOf(), mimeTypes(), supports(), and ~CodecBase().

---

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

• libkwave/CodecBase.h
• libkwave/CodecBase.cpp