Kwave::AsciiDecoder Class Reference

#include <AsciiDecoder.h>

Inheritance diagram for Kwave::AsciiDecoder:

Collaboration diagram for Kwave::AsciiDecoder:

Public Member Functions
	AsciiDecoder ()
virtual	~AsciiDecoder () Q_DECL_OVERRIDE
virtual Kwave::Decoder *	instance () Q_DECL_OVERRIDE
virtual bool	open (QWidget *widget, QIODevice &source) Q_DECL_OVERRIDE
virtual bool	decode (QWidget *widget, Kwave::MultiWriter &dst) Q_DECL_OVERRIDE
virtual void	close () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::Decoder
	Decoder ()
virtual	~Decoder ()
virtual Kwave::MetaDataList &	metaData ()
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 Member Functions
bool	readNextLine ()

Private Attributes
QTextStream	m_source
Kwave::MultiWriter *	m_dest
QQueue< QString >	m_queue_input
quint64	m_line_nr

Additional Inherited Members
Signals inherited from Kwave::Decoder
void	sourceProcessed (quint64 pos)
Protected Attributes inherited from Kwave::Decoder
Kwave::MetaDataList	m_meta_data

Detailed Description

Definition at line 35 of file AsciiDecoder.h.

Constructor & Destructor Documentation

AsciiDecoder()

Kwave::AsciiDecoder::AsciiDecoder

(

)

Constructor

Definition at line 44 of file AsciiDecoder.cpp.

References LOAD_MIME_TYPES, m_source, and REGISTER_COMPRESSION_TYPES.

    :Kwave::Decoder(),
     m_source(),
     m_dest(Q_NULLPTR),
     m_queue_input(),
     m_line_nr(0)
{
    LOAD_MIME_TYPES
    REGISTER_COMPRESSION_TYPES
    m_source.setCodec("UTF-8");
}

~AsciiDecoder()

Kwave::AsciiDecoder::~AsciiDecoder ( )

virtual

Destructor

Definition at line 57 of file AsciiDecoder.cpp.

References close(), and m_source.

{
    if (m_source.device()) close();
}

Here is the call graph for this function:

Member Function Documentation

close()

void Kwave::AsciiDecoder::close ( )

virtual

Closes the source.

Implements Kwave::Decoder.

Definition at line 289 of file AsciiDecoder.cpp.

References m_source.

Referenced by ~AsciiDecoder().

{
    m_source.reset();
    m_source.setDevice(Q_NULLPTR);
}

Here is the caller graph for this function:

decode()

bool Kwave::AsciiDecoder::decode ( QWidget *  widget, Kwave::MultiWriter &  dst  )

virtual

Decodes a stream of bytes into a MultiWriter

Parameters

widget	a widget that can be used for displaying message boxes or dialogs
dst	MultiWriter that receives the audio data

Returns

true if succeeded, false on errors

Implements Kwave::Decoder.

Definition at line 235 of file AsciiDecoder.cpp.

References Kwave::MultiWriter::isCanceled(), Kwave::MultiWriter::last(), m_dest, m_queue_input, m_source, Kwave::Decoder::metaData(), readNextLine(), Kwave::MetaDataList::replace(), Kwave::FileInfo::setLength(), and Kwave::FileInfo::tracks().

{
    Q_UNUSED(widget);

    Q_ASSERT(m_source.device());
    if (!m_source.device()) return false;

    m_dest = &dst;

    // for the moment: use a comma as separator <= TODO
    const char separators[] = {',', '\0' };

    Kwave::FileInfo info(metaData());
    unsigned int channels = info.tracks();
    QVector<sample_t> frame(channels);

    // read in all remaining data until EOF or user cancel
    qDebug("AsciiDecoder::decode(...)");
    while (readNextLine() && !dst.isCanceled()) {
        QByteArray d  = m_queue_input.dequeue().toLatin1();
        char *line    = d.data();
        char *saveptr = Q_NULLPTR;

        frame.fill(0);
        for (unsigned int channel = 0; channel < channels; channel++) {
            sample_t  s = 0;

            char *token = strtok_r(line, separators, &saveptr);
            line = Q_NULLPTR;
            if (token) {
                // skip whitespace at the start
                while (*token && isspace(*token)) ++token;
                if (*token) {
                    char *p = token + 1;
                    while (isdigit(*p) || (*p == '+') || (*p == '-')) ++p;
                    *p = 0;
                    if (*token) s = atoi(token);
                    Kwave::Writer *w = dst[channel];
                    if (w) (*w) << s;
                }
            }
        }
    }

    m_dest = Q_NULLPTR;
    info.setLength(dst.last() ? (dst.last() + 1) : 0);
    metaData().replace(Kwave::MetaDataList(info));

    // return with a valid Signal, even if the user pressed cancel !
    return true;
}

Here is the call graph for this function:

instance()

Kwave::Decoder * Kwave::AsciiDecoder::instance ( )

virtual

Returns a new instance of the decoder

Implements Kwave::Decoder.

Definition at line 63 of file AsciiDecoder.cpp.

{
    return new Kwave::AsciiDecoder();
}

open()

bool Kwave::AsciiDecoder::open ( QWidget *  widget, QIODevice &  source  )

virtual

Opens the source and decodes the header information.

Parameters

widget	a widget that can be used for displaying message boxes or dialogs
source	file or other source with a stream of bytes

Returns

true if succeeded, false on errors

Implements Kwave::Decoder.

Definition at line 69 of file AsciiDecoder.cpp.

References _, Kwave::MetaDataList::add(), Kwave::FileInfo::allKnownProperties(), Kwave::FileInfo::contains(), DBG, Kwave::FileInfo::get(), Kwave::INF_BITS_PER_SAMPLE, Kwave::INF_CHANNELS, Kwave::INF_SAMPLE_RATE, Kwave::INF_TRACK, Kwave::INF_TRACKS, m_line_nr, m_queue_input, m_source, MAX_LINE_LEN, Kwave::Decoder::metaData(), Kwave::FileInfo::name(), name, Kwave::MetaDataList::replace(), Kwave::FileInfo::set(), Kwave::LabelList::toMetaDataList(), Kwave::FileInfo::tracks(), and Kwave::Parser::unescape().

{
    Q_UNUSED(widget);

    metaData().clear();
    Q_ASSERT(!m_source.device());
    if (m_source.device()) qWarning("AsciiDecoder::open(), already open !");

    // try to open the source
    if (!src.open(QIODevice::ReadOnly)) {
        qWarning("failed to open source !");
        return false;
    }

    // take over the source
    m_source.setDevice(&src);

    Kwave::FileInfo info(metaData());
    Kwave::LabelList labels;

    /********** Decoder setup ************/
    qDebug("--- AsciiDecoder::open() ---");

    // read in all metadata until start of samples, EOF or user cancel
    qDebug("AsciiDecoder::open(...)");

    m_line_nr = 0;
    while (!m_source.atEnd()) {
        QString line = m_source.readLine(MAX_LINE_LEN).simplified();
        m_line_nr++;
        if (!line.length())
            continue; // skip empty line

        QRegExp regex(_(
            "(^##\\s*)"                  // 1 start of meta data line
            "([\\'\\\"])?"               // 2 property, quote start (' or ")
            "\\s*(\\w+[\\s\\w]*\\w)\\s*" // 3 property
            "(\\[\\d*\\])?"              // 4 index (optional)
            "(\\2)"                      // 5 property, quote end
            "(\\s*=\\s*)"                // 6 assignment '='
            "(.*)"                       // 7 rest, up to end of line
        ));
        if (regex.exactMatch(line)) {
            // meta data entry: "## 'Name' = value"
            QString name = Kwave::Parser::unescape(regex.cap(3) + regex.cap(4));
            QString v    = regex.cap(7);

            QString value;
            if (v.length()) {
                // remove quotes from the value
                bool is_escaped = false;
                char quote = v[0].toLatin1();
                if ((quote != '\'') && (quote != '"'))
                    quote = -1;

                for (QString::ConstIterator it = v.begin(); it != v.end(); ++it)
                {
                    const char c = QChar(*it).toLatin1();

                    if ((c == '\\') && !is_escaped) {
                        is_escaped = true;   // next char is escaped
                        continue;
                    }
                    if (is_escaped) {
                        value += *it;        // escaped char
                        is_escaped = false;
                        continue;
                    }

                    if (c == quote) {
                        if (!value.length())
                            continue;        // starting quote
                        else
                            break;           // ending quote
                    }

                    if ((quote == -1) && (c == '#'))
                        break;               // comment in unquoted text

                    // otherwise: normal character, part of text
                    value += *it;
                }

                // if the text was unquoted, remove leading/trailing spaces
                if (quote == -1)
                    value = value.trimmed();
            }

            // handle some well known aliases
            if (name == _("rate")) name = info.name(INF_SAMPLE_RATE);
            if (name == _("bits")) name = info.name(INF_BITS_PER_SAMPLE);

            // handle labels
            QRegExp regex_label(_("label\\[(\\d*)\\]"));
            if (regex_label.exactMatch(name)) {
                bool ok = false;
                sample_index_t pos = regex_label.cap(1).toULongLong(&ok);
                if (!ok) {
                    qWarning("line %llu: malformed label position: '%s'",
                              m_line_nr, DBG(name));
                    continue; // skip it
                }
                Kwave::Label label(pos, value);
                labels.append(label);
                continue;
            }

            bool found = false;
            foreach (const Kwave::FileProperty &p, info.allKnownProperties()) {
                if (info.name(p).toLower() == name.toLower()) {
                    found = true;
                    info.set(p, QVariant(value));
                }
            }
            if (!found) {
                qWarning("line %llu: unknown meta data entry: '%s' = '%s'",
                         m_line_nr, DBG(name), DBG(value));
            }
        } else if (line.startsWith(QLatin1Char('#'))) {
            continue; // skip comment lines
        } else {
            // reached end of metadata:
            // -> push back the line into the queue
            m_queue_input.enqueue(line);
            break;
        }
    }

    // if the number of channels is not known, but "tracks" is given and
    // "track" is not present: old syntax has been used
    if ((info.tracks() < 1) && info.contains(INF_TRACKS) &&
        !info.contains(INF_TRACK))
    {
        info.set(INF_CHANNELS, info.get(INF_TRACKS));
        info.set(INF_TRACKS, QVariant());
    }

    metaData().replace(Kwave::MetaDataList(info));
    metaData().add(labels.toMetaDataList());

    return (info.tracks() >= 1);
}

Here is the call graph for this function:

readNextLine()

bool Kwave::AsciiDecoder::readNextLine ( )

private

try to read a complete line from the source, skip empty lines and comments

Returns

true if one line was read, false if EOF was reached before one line was complete

Definition at line 213 of file AsciiDecoder.cpp.

References m_line_nr, m_queue_input, m_source, and MAX_LINE_LEN.

Referenced by decode().

{
    if (!m_queue_input.isEmpty())
        return true; // there is still something in the queue

    while (!m_source.atEnd()) {
        QString line = m_source.readLine(MAX_LINE_LEN).simplified();
        m_line_nr++;
        if (!line.length()) {
            continue; // skip empty line
        } else if (line.startsWith(QLatin1Char('#'))) {
            continue; // skip comment lines
        } else {
            // -> push back the line into the queue
            m_queue_input.enqueue(line);
            return true;
        }
    }
    return false;
}

Here is the caller graph for this function:

Member Data Documentation

m_dest

Kwave::MultiWriter* Kwave::AsciiDecoder::m_dest

private

destination of the audio data

Definition at line 87 of file AsciiDecoder.h.

Referenced by decode().

m_line_nr

quint64 Kwave::AsciiDecoder::m_line_nr

private

last read line number, starting with 1

Definition at line 93 of file AsciiDecoder.h.

Referenced by open(), and readNextLine().

m_queue_input

QQueue<QString> Kwave::AsciiDecoder::m_queue_input

private

queue for buffering strings read from the file

Definition at line 90 of file AsciiDecoder.h.

Referenced by decode(), open(), and readNextLine().

m_source

QTextStream Kwave::AsciiDecoder::m_source

private

source of the audio data

Definition at line 84 of file AsciiDecoder.h.

Referenced by AsciiDecoder(), close(), decode(), open(), readNextLine(), and ~AsciiDecoder().

---

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

• plugins/codec_ascii/AsciiDecoder.h
• plugins/codec_ascii/AsciiDecoder.cpp