MetaData.h

Go to the documentation of this file.

/***************************************************************************
            MetaData.h  -  base class for associated meta data
                             -------------------
    begin                : Sat Jan 23 2010
    copyright            : (C) 2010 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 META_DATA_H
#define META_DATA_H

#include "config.h"

#include <QtGlobal>
#include <QList>
#include <QMap>
#include <QMutex>
#include <QSharedData>
#include <QSharedDataPointer>
#include <QString>
#include <QStringList>
#include <QVariant>

#include "libkwave/Sample.h"

namespace Kwave
{

    class Q_DECL_EXPORT MetaData
    {
    public:
        static const QString STDPROP_TYPE;

        static const QString STDPROP_TRACKS;

        static const QString STDPROP_START;

        static const QString STDPROP_END;

        static const QString STDPROP_POS;

        static const QString STDPROP_DESCRIPTION;

        typedef enum
        {
            None     = 0,

            Signal   = (1 << 0),

            Track    = (1 << 1),

            Range    = (1 << 2),

            Position = (1 << 3),

            All      = ~0
        } Scope;

        typedef QMap<QString, QVariant> PropertyList;

        MetaData();

        MetaData(const MetaData &other);

        explicit MetaData(Scope scope);

        virtual ~MetaData();

        virtual void clear();

        virtual bool isNull() const;

        QString id() const;

        Scope scope() const;

        void setScope(Scope scope);

        void setProperty(const QString &p, const QVariant &value);

        bool hasProperty(const QString &p) const;

        QVariant property(const QString &p) const;

        inline QVariant operator [] (const QString p) const
        {
            return property(p);
        }

        QVariant &property(const QString &p);

        inline QVariant &operator [] (const QString p)
        {
            return property(p);
        }

        bool operator == (const MetaData &other) const;

        inline bool operator != (const MetaData &other) const
        {
            return !(operator == (other));
        }

        QStringList keys() const;

        static QStringList positionBoundPropertyNames();

        sample_index_t firstSample() const;

        sample_index_t lastSample() const;

        QList<unsigned int> boundTracks() const;

        virtual void dump() const;

    private:

        class MetaDataPriv: public QSharedData
        {
        public:

            MetaDataPriv();

            MetaDataPriv(const MetaDataPriv &other);

            virtual ~MetaDataPriv();

            QString m_id;

            Scope m_scope;

            PropertyList m_properties;

        private:

            static QString newUid();

            static quint64 m_id_counter;

            static QMutex m_id_lock;
        };

        QSharedDataPointer<MetaDataPriv> m_data;
    };
}

#endif /* META_DATA_H */

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