Kwave::AsciiEncoder Class Reference

#include <AsciiEncoder.h>

Inheritance diagram for Kwave::AsciiEncoder:

Collaboration diagram for Kwave::AsciiEncoder:

Public Member Functions
	AsciiEncoder ()
virtual	~AsciiEncoder () 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
QTextStream	m_dst

Detailed Description

Definition at line 35 of file AsciiEncoder.h.

Constructor & Destructor Documentation

AsciiEncoder()

Kwave::AsciiEncoder::AsciiEncoder

(

)

Constructor

Definition at line 44 of file AsciiEncoder.cpp.

References LOAD_MIME_TYPES, m_dst, and REGISTER_COMPRESSION_TYPES.

    :Kwave::Encoder(), m_dst()
{
    m_dst.setCodec(QTextCodec::codecForName("UTF-8"));
    LOAD_MIME_TYPES
    REGISTER_COMPRESSION_TYPES
}

~AsciiEncoder()

Kwave::AsciiEncoder::~AsciiEncoder ( )

virtual

Destructor

Definition at line 53 of file AsciiEncoder.cpp.

{
}

Member Function Documentation

encode()

bool Kwave::AsciiEncoder::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 information about the file to be saved

Returns

true if succeeded, false on errors

Implements Kwave::Encoder.

Definition at line 72 of file AsciiEncoder.cpp.

References Kwave::FileInfo::bits(), Kwave::FileInfo::canLoadSave(), Kwave::SampleReader::eof(), Kwave::MessageBox::error(), Kwave::Parser::escape(), Kwave::MultiTrackReader::isCanceled(), Kwave::FileInfo::length(), m_dst, META_PREFIX, Kwave::Label::name(), Kwave::FileInfo::name(), Kwave::Label::pos(), Kwave::FileInfo::properties(), Kwave::FileInfo::rate(), supportedProperties(), and Kwave::FileInfo::tracks().

{
    bool result = true;

    qDebug("AsciiEncoder::encode()");

    // get info: tracks, sample rate
    const Kwave::FileInfo info(meta_data);
    unsigned int tracks = info.tracks();
    unsigned int bits   = info.bits();
    sample_index_t length = info.length();

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

        // output device successfully opened
        m_dst.setDevice(&dst);

        // write out the default properties:
        // sample rate, bits, tracks, length
        m_dst << META_PREFIX << "'rate'="   << info.rate() << endl;
        m_dst << META_PREFIX << "'tracks'=" << tracks << endl;
        m_dst << META_PREFIX << "'bits'="   << bits   << endl;
        m_dst << META_PREFIX << "'length'=" << length << endl;

        // write out all other, non-standard properties that we have
        QMap<Kwave::FileProperty, QVariant> properties = info.properties();
        QMap<Kwave::FileProperty, QVariant>::Iterator it;
        QList<Kwave::FileProperty> supported = supportedProperties();
        for (it=properties.begin(); it != properties.end(); ++it) {
            Kwave::FileProperty p = it.key();
            QVariant            v = it.value();

            if (!supported.contains(p))
                continue;
            if (!info.canLoadSave(p))
                continue;

            // write the property
            m_dst << META_PREFIX << "'" << info.name(p) << "'='"
                  << Kwave::Parser::escape(v.toString()).toUtf8()
                  << "'" << endl;
        }

        // write out all labels
        Kwave::LabelList labels(meta_data);
        foreach (const Kwave::Label &label, labels) {
            m_dst << META_PREFIX << "'label["
            << QString::number(label.pos()) << "]'='"
            << Kwave::Parser::escape(label.name()).toUtf8()
            << "'" << endl;
        }

        sample_index_t rest = length;
        sample_index_t pos  = 0;
        while (rest-- && !src.isCanceled()) {
            // write out one track per line
            for (unsigned int track=0; track < tracks; track++) {
                Kwave::SampleReader *reader = src[track];
                Q_ASSERT(reader);
                if (!reader) break;

                // read one single sample
                sample_t sample = 0;
                if (!reader->eof()) (*reader) >> sample;

                // print out the sample value
                m_dst.setFieldWidth(9);
                m_dst << sample;

                // comma as separator between the samples
                if (track != tracks-1)
                    m_dst << ", ";
            }

            // as comment: current position [samples]
            m_dst << " # ";
            m_dst.setFieldWidth(12);
            m_dst << pos;
            pos++;

            // end of line
            m_dst << endl;
        }

    } while (false);

    // end of file
    m_dst << "# EOF " << endl << endl;

    m_dst.setDevice(Q_NULLPTR);
    dst.close();

    return result;
}

Here is the call graph for this function:

instance()

Kwave::Encoder * Kwave::AsciiEncoder::instance ( )

virtual

Returns a new instance of the encoder

Implements Kwave::Encoder.

Definition at line 58 of file AsciiEncoder.cpp.

{
    return new Kwave::AsciiEncoder();
}

supportedProperties()

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

virtual

Returns a list of supported file properties

Reimplemented from Kwave::Encoder.

Definition at line 64 of file AsciiEncoder.cpp.

References Kwave::FileInfo::allKnownProperties().

Referenced by encode().

{
    // default is to support all known properties
    Kwave::FileInfo info;
    return info.allKnownProperties();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_dst

QTextStream Kwave::AsciiEncoder::m_dst

private

pointer to the QIODevice for storing, used while encoding

Definition at line 68 of file AsciiEncoder.h.

Referenced by AsciiEncoder(), and encode().

---

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

• plugins/codec_ascii/AsciiEncoder.h
• plugins/codec_ascii/AsciiEncoder.cpp