FileInfo.h

Go to the documentation of this file.

/***************************************************************************
             FileInfo.h  -  information about an audio file
                             -------------------
    begin                : Mar 13 2002
    copyright            : (C) 2002 by Thomas Eschenbacher
    email                : Thomas Eschenbacher <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 FILE_INFO_H
#define FILE_INFO_H

#include "config.h"

#include <QtGlobal>
#include <QFlags>
#include <QList>
#include <QMap>
#include <QString>
#include <QVariant>

#include "libkwave/MetaData.h"
#include "libkwave/Sample.h"
#include "libkwave/TypesMap.h"

namespace Kwave
{

    class MetaDataList;

    typedef enum {
        INF_UNKNOWN = -1,        
        // please sort in new items alphabetically...
        INF_ALBUM = 0,           
        INF_ANNOTATION,          
        INF_ARCHIVAL,            
        INF_AUTHOR,              
        INF_BITRATE_LOWER,       
        INF_BITRATE_MODE,        
        INF_BITRATE_NOMINAL,     
        INF_BITRATE_UPPER,       
        INF_BITS_PER_SAMPLE,     
        INF_CD,                  
        INF_CDS,                 
        INF_CHANNELS,            
        INF_COMMISSIONED,        
        INF_COMMENTS,            
        INF_COMPRESSION,         
        INF_CONTACT,             
        INF_COPYRIGHT,           
        INF_COPYRIGHTED,         
        INF_CREATION_DATE,       
        INF_ENGINEER,            
        INF_ESTIMATED_LENGTH,    
        INF_FILENAME,            
        INF_FILESIZE,            
        INF_GENRE,               
        INF_ISRC,                
        INF_KEYWORDS,            
        INF_LABELS,              
        INF_LENGTH,              
        INF_LICENSE,             
        INF_MEDIUM,              
        INF_MIMETYPE,            
        INF_MPEG_EMPHASIS,       
        INF_MPEG_LAYER,          
        INF_MPEG_MODEEXT,        
        INF_MPEG_VERSION,        
        INF_NAME,                
        INF_OPUS_FRAME_LEN,      
        INF_ORGANIZATION,        
        INF_ORIGINAL,            
        INF_PERFORMER,           
        INF_PRIVATE,             
        INF_PRODUCT,             
        INF_SAMPLE_FORMAT,       
        INF_SAMPLE_RATE,         
        INF_SOFTWARE,            
        INF_SOURCE,              
        INF_SOURCE_FORM,         
        INF_SUBJECT,             
        INF_TECHNICAN,           
        INF_TRACK,               
        INF_TRACKS,              
        INF_VBR_QUALITY,         
        INF_VERSION              
    } FileProperty;

    static inline FileProperty operator ++ (FileProperty &prop) {
        prop = static_cast<FileProperty>(static_cast<unsigned int>(prop) + 1);
        return prop;
    }

    class Q_DECL_EXPORT FileInfo: public Kwave::MetaData
    {
    public:
        typedef enum {
            FP_NONE           = 0,

            FP_INTERNAL       = 1,

            FP_READONLY       = 2,

            FP_NO_LOAD_SAVE   = 4,

            FP_FORMAT_NUMERIC = 8

        } Flag;

        Q_DECLARE_FLAGS(Flags, Flag)

        
        FileInfo();

        explicit FileInfo(const Kwave::MetaDataList &meta_data_list);

        virtual ~FileInfo() Q_DECL_OVERRIDE;

        static QString metaDataType() {
            return QString::fromLatin1("FILE INFO");
        }

        sample_index_t length() const;

        void setLength(sample_index_t length);

        double rate() const;

        void setRate(double rate);

        unsigned int bits() const;

        void setBits(unsigned int bits);

        unsigned int tracks() const;

        void setTracks(unsigned int tracks);

        bool contains(const FileProperty property) const;

        void set(FileProperty key, const QVariant &value);

        QVariant get(FileProperty key) const;

        inline Flags flags(FileProperty key) const {
            return m_property_map.data(key);
        }

        inline bool isInternal(FileProperty key) const {
            return (flags(key) & FP_INTERNAL);
        }

        inline bool canLoadSave(FileProperty key) const {
            return !(flags(key) & FP_NO_LOAD_SAVE);
        }

        inline QString name(FileProperty key) const {
            return m_property_map.name(key);
        }

        inline QString description(FileProperty key) const {
            return m_property_map.description(key, false);
        }

        inline FileProperty fromName(const QString &name) const {
            return m_property_map.findFromName(name);
        }

        const QMap<FileProperty, QVariant> properties() const;

        QList<FileProperty> allKnownProperties() const;

        virtual void dump() const Q_DECL_OVERRIDE;

    private:

        class PropertyTypesMap: public Kwave::TypesMap<FileProperty, Flags>
        {
        public:
            explicit PropertyTypesMap()
                :Kwave::TypesMap<FileProperty, Flags>()
            {
                fill();
            }

            virtual void fill() Q_DECL_OVERRIDE;

            virtual QList<FileProperty> all() const;
        };

        PropertyTypesMap m_property_map;

    };
}

Q_DECLARE_OPERATORS_FOR_FLAGS(Kwave::FileInfo::Flags)

#endif /* FILE_INFO_H */

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