RIFFChunk.h

Go to the documentation of this file.

/*************************************************************************
            RIFFChunk.h  -  information about a RIFF chunk
                             -------------------
    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_CHUNK_H
#define RIFF_CHUNK_H

#include "config.h"

#include <QByteArray>
#include <QList>
#include <QString>

namespace Kwave
{

    class RIFFChunk;

    typedef QList<Kwave::RIFFChunk *> RIFFChunkList;

    class RIFFChunk
    {
    public:
        typedef enum {
            Root,    
            Main,    
            Sub,     
            Garbage, 
            Empty    
        } ChunkType;

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

        virtual ~RIFFChunk();

        bool isSane() const;

        inline ChunkType type() const { return m_type; }

        inline void setType(ChunkType type) { m_type = type; }

        inline const QByteArray &name() const { return m_name; }

        inline const QByteArray &format() const { return m_format; }

        inline void setFormat(const QByteArray &format) { m_format = format; }

        inline Kwave::RIFFChunk *parent() const { return m_parent; }

        const QByteArray path() const;

        quint32 dataStart() const;

        quint32 dataLength() const;

        inline quint32 length() const { return m_chunk_length; }

        void setLength(quint32 length);

        inline quint32 physStart() const { return m_phys_offset; }

        quint32 physEnd() const;

        inline quint32 physLength() const { return m_phys_length; }

        inline Kwave::RIFFChunkList &subChunks() { return m_sub_chunks; }

        inline const Kwave::RIFFChunkList &subChunks() const {
            return m_sub_chunks;
        }

        bool isChildOf(Kwave::RIFFChunk *chunk);

        void fixSize();

        void dumpStructure();

    private:
        ChunkType m_type;

        QByteArray m_name;

        QByteArray m_format;

        Kwave::RIFFChunk *m_parent;

        quint32 m_chunk_length;

        quint32 m_phys_offset;

        quint32 m_phys_length;

        Kwave::RIFFChunkList m_sub_chunks;

    };
}

#endif /* RIFF_CHUNK_H */

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