RIFFParser.h

Go to the documentation of this file.

/*************************************************************************
           RIFFParser.h  -  parser for the RIFF format
                             -------------------
    begin                : Tue Mar 20 2002
    copyright            : (C) 2002 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef RIFF_PARSER_H
#define RIFF_PARSER_H

#include "config.h"

#include <QByteArray>
#include <QList>
#include <QObject>
#include <QStringList>

#include "libkwave/ByteOrder.h"

#include "RIFFChunk.h"

class QIODevice;

namespace Kwave
{
    class RIFFChunk;

    class RIFFParser: public QObject
    {
        Q_OBJECT
    public:

        RIFFParser(QIODevice &device, const QStringList &main_chunks,
                   const QStringList &known_subchunks);

        virtual ~RIFFParser();

        bool parse();

        bool parse(Kwave::RIFFChunk *parent,
                   quint32 offset, quint32 length);

        bool isSane();

        void dumpStructure();

        Kwave::RIFFChunk *findChunk(const QByteArray &path);

        unsigned int chunkCount(const QByteArray &path);

        Kwave::RIFFChunk *findMissingChunk(const QByteArray &name);

        void repair();

    public slots:

    void cancel();

    signals:

        void action(const QString &name);

        void progress(int percent);

    protected:

        QByteArray read4ByteString(qint64 offset);

        Kwave::RIFFChunk::ChunkType guessType(const QByteArray &name);

        bool isValidName(const char *name);

        bool isKnownName(const QByteArray &name);

        void detectEndianness();

        Kwave::RIFFChunk *addChunk(Kwave::RIFFChunk *parent,
                                   const QByteArray &name,
                                   const QByteArray &format,
                                   quint32 length,
                                   quint32 phys_offset,
                                   quint32 phys_length,
                                   Kwave::RIFFChunk::ChunkType type);

        bool addGarbageChunk(Kwave::RIFFChunk *parent, quint32 offset,
                             quint32 length);

        bool addEmptyChunk(Kwave::RIFFChunk *parent, const QByteArray &name,
                           quint32 offset);

        void listAllChunks(Kwave::RIFFChunk &parent,
                           Kwave::RIFFChunkList &list);

        Kwave::RIFFChunk *chunkAt(quint32 offset);

        QList<quint32> scanForName(const QByteArray &name, quint32 offset,
                                   quint32 length,
                                   int progress_start = 0,
                                   int progress_count = 1);

    private:

        void collectGarbage();

        bool joinGarbageToEmpty();

        void fixGarbageEnds();

        void discardGarbage(Kwave::RIFFChunk &chunk);

        QIODevice &m_dev;

        Kwave::RIFFChunk m_root;

        QStringList m_main_chunk_names;

        QStringList m_sub_chunk_names;

        Kwave::byte_order_t m_endianness;

        bool m_cancel;

    };
}

#endif /* RIFF_PARSER_H */

//***************************************************************************
//***************************************************************************