imagetypes.h

Go to the documentation of this file.

 
#ifndef IMAGETYPES_H
#define IMAGETYPES_H
 
#include <QStringList>
#include <QSharedPointer>
#include <QPair>
#include <QList>
#include <QHash>
#include <QMap>
#include <QMetaType>
 
#include "libmythbase/mythchrono.h"
#include "mythmetaexp.h"
 
// Define this to log/count creation/deletion of ImageItem heap objects.
// These are created liberally when processing images and are liable to leak.
// At idle there should be precisely 1 ImageItem for every image/dir displayed.
//#define MEMORY_DEBUG active
#ifdef MEMORY_DEBUG
#include <QDebug>
#endif
 
// Id of the (virtual) Gallery root node
static constexpr int GALLERY_DB_ID { 0 };
// Id of the Storage Group (Photographs) node
static constexpr int PHOTO_DB_ID { 1 };
 
 
// We need to use other names to avoid getting coflicts with the videolist.h file
enum ImageNodeType : std::uint8_t {
    kUnknown   = 0, 
    kDevice    = 1, 
    kCloneDir  = 2, 
    kDirectory = 3, 
    kImageFile = 4, 
    kVideoFile = 5  
};
 
 
enum ImageSortOrder : std::uint8_t {
    kSortByNameAsc     = 1, 
    kSortByNameDesc    = 2, 
    kSortByModTimeAsc  = 3, 
    kSortByModTimeDesc = 4, 
    kSortByExtAsc      = 5, 
    kSortByExtDesc     = 6, 
    kSortBySizeAsc     = 7, 
    kSortBySizeDesc    = 8, 
    kSortByDateAsc     = 9, 
    kSortByDateDesc    = 10 
};
 
 
// Convenience types
using ImageIdList = QList<int>;
using StringPair  = QPair<QString, QString>;
using NameHash    = QHash<QString, QString>;
using StringMap   = QMap<int, QString>;
using ThumbPair   = QPair<int, QString>;
 
 
class META_PUBLIC ImageItem
{
public:
    explicit ImageItem(int id = 0)
        : m_id(id)
#ifndef MEMORY_DEBUG
    {}
#else
    { qDebug() << QString("Created %1 (%2)").arg(m_id).arg(++GetItemCount()); }
 
    ~ImageItem()
    { qDebug() << QString("Deleted %1 (%2)").arg(m_id).arg(--GetItemCount()); }
 
    // Embeds a static var in header to avoid the need for a cpp
    static int& GetItemCount() { static int count; return count; }
#endif
 
 
    int              m_id;
 
    // Db File attributes
    QString          m_baseName;    
    QString          m_filePath;    
    QString          m_extension;   
    int              m_device      { 0 }; 
    int              m_parentId    { 0 }; 
    int              m_type        { 0 }; 
    std::chrono::seconds m_modTime { 0s }; 
    int              m_size        { 0 }; 
    std::chrono::seconds m_date    { 0s }; 
    int              m_orientation { 0 }; 
    QString          m_comment;     
 
    // Db User attributes
    bool             m_isHidden      { false }; 
    int              m_userThumbnail {     0 }; 
 
    // Derived attributes
    QString          m_url;        
    QString          m_thumbPath;  
    QList<ThumbPair> m_thumbNails; 
    int              m_dirCount  { 0 }; 
    int              m_fileCount { 0 }; 
 
    // Convenience functions
    bool IsDevice()     const { return m_type == kDevice; }
    bool IsDirectory()  const { return m_type <= kDirectory; }
    bool IsFile()       const { return m_type >  kDirectory; }
    bool IsLocal()      const { return IsLocalId(m_id); }
 
    static bool    IsLocalId(int id)     { return id < GALLERY_DB_ID; }
    static bool    IsLocalParent(int id) { return id <= GALLERY_DB_ID; }
 
    static int     ToLocalId(int id)     { return -id; }
    static QString ToLocalId(const QString &id) { return "-" + id; }
 
    static int     ToDbId(int id)        { return abs(id); }
    static QString ToDbId(QString ids)   { return ids.remove("-"); }
 
 
    static StringPair PartitionIds(const ImageIdList &ids)
    {
        QStringList local;
        QStringList remote;
        for (int id : std::as_const(ids))
        {
            if (ImageItem::IsLocalId(id))
                local << QString::number(id);
            else
                remote << QString::number(id);
        }
        return qMakePair(local.join(","), remote.join(","));
    }
 
private:
    Q_DISABLE_COPY(ImageItem)
};
 
// Convenience containers
using ImagePtr  = QSharedPointer<ImageItem>;
using ImageList = QVector<ImagePtr>;
using ImageHash = QHash<QString, ImagePtr>;
 
// Read-only images alias
using ImageItemK = const ImageItem;
using ImagePtrK  = QSharedPointer<ImageItemK>;
using ImageListK = QList<ImagePtrK>;
 
Q_DECLARE_METATYPE(ImagePtrK)
 
#endif // IMAGETYPES_H