mythimage.cpp

Go to the documentation of this file.

// Own header
#include "mythimage.h"
 
// C++ headers
#include <cstdint>
#include <iostream>
 
// QT headers
#include <QImageReader>
#include <QNetworkReply>
#include <QPainter>
#include <QRgb>
 
// libmythbase headers
#include "libmythbase/mythdownloadmanager.h"
#include "libmythbase/mythlogging.h"
#include "libmythbase/remotefile.h"
 
// MythUI headers
#include "mythuihelper.h"
#include "mythmainwindow.h"
 
MythUIHelper *MythImage::s_ui = nullptr;
 
MythImage::MythImage(MythPainter *parent, const char *name) :
    ReferenceCounter(name)
{
    if (!parent)
        LOG(VB_GENERAL, LOG_ERR, "Image created without parent!");
 
    m_parent = parent;
    m_fileName = "";
 
    if (!s_ui)
        s_ui = GetMythUI();
}
 
MythImage::~MythImage()
{
    if (m_parent)
        m_parent->DeleteFormatImage(this);
}
 
int MythImage::IncrRef(void)
{
    int cnt = ReferenceCounter::IncrRef();
    if ((2 == cnt) && s_ui && m_cached)
        s_ui->ExcludeFromCacheSize(this);
    return cnt;
}
 
int MythImage::DecrRef(void)
{
    bool cached = m_cached;
    int cnt = ReferenceCounter::DecrRef();
    if (cached)
    {
        if (s_ui && (1 == cnt))
            s_ui->IncludeInCacheSize(this);
 
        if (0 == cnt)
        {
            LOG(VB_GENERAL, LOG_INFO,
                "Image should be removed from cache prior to deletion.");
        }
    }
    return cnt;
}
 
void MythImage::SetIsInCache(bool bCached)
{
    IncrRef();
    m_cached = bCached;
    DecrRef();
}
 
void MythImage::Assign(const QImage &img)
{
    if (m_cached)
    {
        SetIsInCache(false);
        *(static_cast<QImage*>(this)) = img;
        SetIsInCache(m_cached);
    }
    else
    {
        *(static_cast<QImage*>(this)) = img;
    }
    SetChanged();
}
 
void MythImage::Assign(const QPixmap &pix)
{
    Assign(pix.toImage());
}
 
QImage MythImage::ApplyExifOrientation(QImage &image, int orientation)
{
    QTransform transform;
 
    switch (orientation)
    {
    case 1: // normal
        return image;
    case 2: // mirror horizontal
#if QT_VERSION < QT_VERSION_CHECK(6,9,0)
        return image.mirrored(true, false);
#else
        return image.flipped(Qt::Horizontal);
#endif
    case 3: // rotate 180
        transform.rotate(180);
        return image.transformed(transform);
    case 4: // mirror vertical
#if QT_VERSION < QT_VERSION_CHECK(6,9,0)
        return image.mirrored(false, true);
#else
        return image.flipped(Qt::Vertical);
#endif
    case 5: // mirror horizontal and rotate 270 CCW
        transform.rotate(270);
#if QT_VERSION < QT_VERSION_CHECK(6,9,0)
        return image.mirrored(true, false).transformed(transform);
#else
        return image.flipped(Qt::Horizontal).transformed(transform);
#endif
    case 6: // rotate 90 CW
        transform.rotate(90);
        return image.transformed(transform);
    case 7: // mirror horizontal and rotate 90 CW
        transform.rotate(90);
#if QT_VERSION < QT_VERSION_CHECK(6,9,0)
        return image.mirrored(true, false).transformed(transform);
#else
        return image.flipped(Qt::Horizontal).transformed(transform);
#endif
    case 8: // rotate 270 CW
        transform.rotate(270);
        return image.transformed(transform);
    }
    return image;
}
 
void MythImage::Orientation(int orientation)
{
    if (!m_isOriented)
    {
        Assign(ApplyExifOrientation(*this, orientation));
        m_isOriented = true;
    }
}
 
void MythImage::Resize(QSize newSize, bool preserveAspect)
{
    if ((size() == newSize) && !isNull())
        return;
 
    if (m_isGradient)
    {
        *(static_cast<QImage *> (this)) = QImage(newSize, QImage::Format_ARGB32);
        MakeGradient(*this, m_gradBegin, m_gradEnd, m_gradAlpha,
                     BoundaryWanted::Yes, m_gradDirection);
        SetChanged();
    }
    else
    {
        Qt::AspectRatioMode mode = Qt::IgnoreAspectRatio;
        if (preserveAspect)
            mode = Qt::KeepAspectRatio;
 
        Assign(scaled(newSize, mode, Qt::SmoothTransformation));
    }
}
 
void MythImage::Reflect(ReflectAxis axis, int shear, int scale, int length,
                        int spacing)
{
    if (m_isReflected)
        return;
 
    QImage mirrorImage;
    FillDirection fillDirection = FillDirection::TopToBottom;
    if (axis == ReflectAxis::Vertical)
    {
#if QT_VERSION < QT_VERSION_CHECK(6,9,0)
        mirrorImage = mirrored(false,true);
#else
        mirrorImage = flipped(Qt::Vertical);
#endif
        if (length < 100)
        {
            int height = (int)((float)mirrorImage.height() * (float)length/100);
            mirrorImage = mirrorImage.copy(0,0,mirrorImage.width(),height);
        }
        fillDirection = FillDirection::TopToBottom;
    }
    else if (axis == ReflectAxis::Horizontal)
    {
#if QT_VERSION < QT_VERSION_CHECK(6,9,0)
        mirrorImage = mirrored(true,false);
#else
        mirrorImage = flipped(Qt::Horizontal);
#endif
        if (length < 100)
        {
            int width = (int)((float)mirrorImage.width() * (float)length/100);
            mirrorImage = mirrorImage.copy(0,0,width,mirrorImage.height());
        }
        fillDirection = FillDirection::LeftToRight;
    }
 
    QImage alphaChannel(mirrorImage.size(), QImage::Format_ARGB32);
    MakeGradient(alphaChannel, QColor(0xAA, 0xAA, 0xAA), QColor(0x00, 0x00, 0x00), 255,
                 BoundaryWanted::No, fillDirection);
    mirrorImage.setAlphaChannel(alphaChannel);
 
    QTransform shearTransform;
    if (axis == ReflectAxis::Vertical)
    {
        shearTransform.scale(1,static_cast<qreal>(scale)/100);
        shearTransform.shear(static_cast<qreal>(shear)/100,0);
    }
    else if (axis == ReflectAxis::Horizontal)
    {
        shearTransform.scale(static_cast<qreal>(scale)/100,1);
        shearTransform.shear(0,static_cast<qreal>(shear)/100);
    }
 
    mirrorImage = mirrorImage.transformed(shearTransform, Qt::SmoothTransformation);
 
    QSize newsize;
    if (axis == ReflectAxis::Vertical)
        newsize = QSize(mirrorImage.width(), height()+spacing+mirrorImage.height());
    else if (axis == ReflectAxis::Horizontal)
        newsize = QSize(width()+spacing+mirrorImage.width(), mirrorImage.height());
 
    QImage temp(newsize, QImage::Format_ARGB32);
    temp.fill(Qt::transparent);
 
    QPainter newpainter(&temp);
    newpainter.setCompositionMode(QPainter::CompositionMode_SourceOver);
    if (axis == ReflectAxis::Vertical)
    {
        if (shear < 0)
        {
            newpainter.drawImage(mirrorImage.width()-width(), 0,
                                 *(static_cast<QImage*>(this)));
        }
        else
        {
            newpainter.drawImage(0, 0, *(static_cast<QImage*>(this)));
        }
 
        newpainter.drawImage(0, height()+spacing, mirrorImage);
    }
    else if (axis == ReflectAxis::Horizontal)
    {
        if (shear < 0)
        {
            newpainter.drawImage(0, mirrorImage.height()-height(),
                                 *(static_cast<QImage*>(this)));
        }
        else
        {
            newpainter.drawImage(0, 0, *(static_cast<QImage*>(this)));
        }
 
        newpainter.drawImage(width()+spacing, 0, mirrorImage);
    }
 
    newpainter.end();
 
    Assign(temp);
 
    m_isReflected = true;
}
 
void MythImage::ToGreyscale()
{
    if (isGrayscale())
        return;
 
    for (int y = 0; y < height(); ++y)
    {
        for (int x = 0; x < width(); ++x)
        {
            QRgb oldPixel = pixel(x, y);
            int greyVal = qGray(oldPixel);
            setPixel(x, y, qRgba(greyVal, greyVal, greyVal, qAlpha(oldPixel)));
        }
    }
}
 
bool MythImage::Load(MythImageReader *reader)
{
    if (!reader || !reader->canRead())
        return false;
 
    auto *im = new QImage;
 
    if (im && reader->read(im))
    {
        Assign(*im);
        delete im;
        return true;
    }
 
    delete im;
    return false;
}
 
bool MythImage::Load(const QString &filename)
{
    if (filename.isEmpty())
        return false;
 
    QImage *im = nullptr;
    if (filename.startsWith("myth://"))
    {
        // Attempting a file transfer on a file that doesn't exist throws
        // a lot of noisy warnings on the backend and frontend, so to avoid
        // that first check it's there
        QUrl url(filename);
        QString fname = url.path();
 
        if (url.hasFragment())
            fname += '#' + url.fragment();
 
        QString mythUrl = RemoteFile::FindFile(fname, url.host(), url.userName());
        if (!mythUrl.isEmpty())
        {
            auto *rf = new RemoteFile(mythUrl, false, false, 0ms);
 
            QByteArray data;
            bool ret = rf->SaveAs(data);
 
            delete rf;
 
            if (ret)
            {
                im = new QImage();
                im->loadFromData(data);
            }
        }
#if 0
        else
            LOG(VB_GENERAL, LOG_ERR,
                QString("MythImage::Load failed to load remote image %1")
                    .arg(filename));
#endif
 
    }
    else if ((filename.startsWith("http://")) ||
                (filename.startsWith("https://")) ||
                (filename.startsWith("ftp://")))
    {
        QByteArray data;
        if (GetMythDownloadManager()->download(filename, &data))
        {
            im = new QImage();
            im->loadFromData(data);
        }
    }
    else
    {
        QString path = filename;
        if (path.startsWith('/') ||
            GetMythUI()->FindThemeFile(path))
            im = new QImage(path);
    }
 
    if (im && im->isNull())
    {
        delete im;
        im = nullptr;
    }
 
    SetFileName(filename);
    if (im)
    {
        Assign(*im);
        delete im;
        return true;
    }
    LOG(VB_GUI, LOG_WARNING, QString("MythImage::Load(%1) failed").arg(filename));
 
    return false;
}
 
void MythImage::MakeGradient(QImage &image, const QColor &begin,
                             const QColor &end, int alpha,
                             BoundaryWanted drawBoundary,
                             FillDirection direction)
{
    // Gradient fill colours
    QColor startColor = begin;
    QColor endColor = end;
    startColor.setAlpha(alpha);
    endColor.setAlpha(alpha);
 
    // Define Gradient
    QPoint pointA(0,0);
    QPoint pointB;
    if (direction == FillDirection::TopToBottom)
    {
        pointB = QPoint(0,image.height());
    }
    else if (direction == FillDirection::LeftToRight)
    {
        pointB = QPoint(image.width(),0);
    }
 
    QLinearGradient gradient(pointA, pointB);
    gradient.setColorAt(0, startColor);
    gradient.setColorAt(1, endColor);
 
    // Draw Gradient
    QPainter painter(&image);
    painter.setCompositionMode(QPainter::CompositionMode_Source);
    painter.fillRect(0, 0, image.width(), image.height(), gradient);
 
    if (drawBoundary == BoundaryWanted::Yes)
    {
        // Draw boundary rect
        QColor black(0, 0, 0, alpha);
        painter.setPen(black);
        QPen pen = painter.pen();
        pen.setWidth(1);
        painter.drawRect(image.rect());
    }
    painter.end();
}
 
MythImage *MythImage::Gradient(MythPainter *painter,
                               QSize size, const QColor &begin,
                               const QColor &end, uint alpha,
                               FillDirection direction)
{
    QImage img(size.width(), size.height(), QImage::Format_ARGB32);
 
    MakeGradient(img, begin, end, alpha, BoundaryWanted::Yes, direction);
 
    MythImage *ret = painter->GetFormatImage();
    ret->Assign(img);
    ret->m_isGradient = true;
    ret->m_gradBegin = begin;
    ret->m_gradEnd = end;
    ret->m_gradAlpha = alpha;
    ret->m_gradDirection = direction;
    return ret;
}
 
MythImageReader::MythImageReader(QString fileName)
  : m_fileName(std::move(fileName))
{
    if ((m_fileName.startsWith("http://")) ||
        (m_fileName.startsWith("https://")) ||
        (m_fileName.startsWith("ftp://")))
    {
        m_networkReply = GetMythDownloadManager()->download(m_fileName);
        if (m_networkReply)
            setDevice(m_networkReply);
    }
    else if (!m_fileName.isEmpty())
    {
        if (!m_fileName.startsWith("/") && !QFile::exists(m_fileName))
        {
            QString tmpFile = GetMythUI()->GetThemeDir() + '/' + m_fileName;
            if (QFile::exists(tmpFile))
                m_fileName = tmpFile;
        }
        setFileName(m_fileName);
    }
}
 
MythImageReader::~MythImageReader()
{
    if (m_networkReply)
    {
        setDevice(nullptr);
        m_networkReply->deleteLater();
        m_networkReply = nullptr;
    }
}