kdelibs/kimgio/jpg.cpp

/*  This file is part of the KDE libraries
    Copyright (C) 2022 Ivailo Monev <xakepa10@gmail.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2, as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#include "jpg.h"

#include <QImage>
#include <QVariant>
#include <kdebug.h>

#include <turbojpeg.h>

static const char* const s_jpgpluginformat = "jpg";

static const ushort s_peekbuffsize = 32;
#if Q_BYTE_ORDER == Q_BIG_ENDIAN
static const TJPF s_jpegpf = TJPF_ARGB;
#else
static const TJPF s_jpegpf = TJPF_BGRA;
#endif
static const TJSAMP s_jpegsubsampling = TJSAMP_444;
static const int s_jpegflags = TJFLAG_FASTDCT;
// for reference:
// https://en.wikipedia.org/wiki/List_of_file_signatures
// https://dev.exiv2.org/projects/exiv2/wiki/The_Metadata_in_JPEG_files
static const uchar s_jpgjfifheader[] = { 0xFF, 0xD8, 0xFF, 0xE0, 0x00, 0x10, 0x4A, 0x46, 0x49, 0x46, 0x00, 0x01 };
static const uchar s_jpgheader[] = { 0xFF, 0xD8, 0xFF, 0xE0 };
static const uchar s_jpg2header[] = { 0xFF, 0xD8, 0xFF, 0xEE };
static const uchar s_jpegexifheader[] = { 0xFF, 0xD8, 0xFF, 0xE1 };
static const uchar s_jpegapp1header[] = { 0xFF, 0xD8, 0xFF, 0xED };

static const struct HeadersTblData {
    const uchar *header;
    const int headersize;
} HeadersTbl[] = {
    { s_jpgjfifheader, 12 },
    { s_jpgheader, 4 },
    { s_jpg2header, 4 },
    { s_jpegexifheader, 4 },
    { s_jpegapp1header, 4 }
};
static const qint16 HeadersTblSize = sizeof(HeadersTbl) / sizeof(HeadersTblData);

JPGHandler::JPGHandler()
    : m_quality(100)
{
}

bool JPGHandler::canRead() const
{
    if (canRead(device())) {
        setFormat(s_jpgpluginformat);
        return true;
    }
    return false;
}

bool JPGHandler::read(QImage *image)
{
    const QByteArray data = device()->readAll();

    if (Q_UNLIKELY(data.isEmpty())) {
        return false;
    }

    tjhandle jpegdecomp = tjInitDecompress();
    if (Q_UNLIKELY(!jpegdecomp)) {
        kWarning() << "Could not initialize decompressor" << tjGetErrorStr();
        return false;
    }

    int jpegwidth = 0;
    int jpegheight = 0;
    int jpegsubsamp = 0;
    int jpegcolorspace = 0;
    int jpegstatus = tjDecompressHeader3(
        jpegdecomp,
        reinterpret_cast<const uchar*>(data.constData()), data.size(),
        &jpegwidth, &jpegheight,
        &jpegsubsamp, &jpegcolorspace
    );
    if (Q_UNLIKELY(jpegstatus != 0)) {
        kWarning() << "Could not decompress header" << tjGetErrorStr2(jpegdecomp);
        (void)tjDestroy(jpegdecomp);
        return false;
    }

    *image = QImage(jpegwidth, jpegheight, QImage::Format_ARGB32);
    if (Q_UNLIKELY(image->isNull())) {
        kWarning() << "Could not create image";
        (void)tjDestroy(jpegdecomp);
        return false;
    }

    jpegstatus = tjDecompress2(
        jpegdecomp,
        reinterpret_cast<const uchar*>(data.constData()), data.size(),
        image->bits(),
        jpegwidth, 0 , jpegheight,
        s_jpegpf,
        s_jpegflags
    );
    if (Q_UNLIKELY(jpegstatus != 0)) {
        kWarning() << "Could not decompress" << tjGetErrorStr2(jpegdecomp);
        *image = QImage();
        (void)tjDestroy(jpegdecomp);
        return false;
    }

    (void)tjDestroy(jpegdecomp);

    return true;
}

bool JPGHandler::write(const QImage &image)
{
    if (Q_UNLIKELY(image.isNull())) {
        return false;
    }

    const QImage image32 = image.convertToFormat(QImage::Format_ARGB32);

    tjhandle jpegcomp = tjInitCompress();
    if (Q_UNLIKELY(!jpegcomp)) {
        kWarning() << "Could not initialize compressor" << tjGetErrorStr();
        return false;
    }

    ulong jpegbuffersize = (image32.width() * image32.height() * tjPixelSize[s_jpegpf]);
    uchar *jpegbuffer = tjAlloc(jpegbuffersize);
    if (Q_UNLIKELY(!jpegbuffer)) {
        kWarning() << "Could not allocate buffer" << tjGetErrorStr2(jpegcomp);
        (void)tjDestroy(jpegcomp);
        return false;
    }

    int jpegstatus = tjCompress2(
        jpegcomp,
        image32.constBits(),
        image32.width(), 0 , image32.height(),
        s_jpegpf,
        &jpegbuffer, &jpegbuffersize,
        s_jpegsubsampling,
        m_quality,
        s_jpegflags
    );
    if (Q_UNLIKELY(jpegstatus != 0)) {
        kWarning() << "Could not compress" << tjGetErrorStr2(jpegcomp);
        tjFree(jpegbuffer);
        (void)tjDestroy(jpegcomp);
        return false;
    }

    if (device()->write(reinterpret_cast<char*>(jpegbuffer), jpegbuffersize) != jpegbuffersize) {
        kWarning() << "Could not write data to device";
        tjFree(jpegbuffer);
        (void)tjDestroy(jpegcomp);
        return false;
    }

    tjFree(jpegbuffer);
    (void)tjDestroy(jpegcomp);

    return true;
}

QByteArray JPGHandler::name() const
{
    return s_jpgpluginformat;
}

bool JPGHandler::supportsOption(QImageIOHandler::ImageOption option) const
{
    return (option == QImageIOHandler::Quality);
}

QVariant JPGHandler::option(QImageIOHandler::ImageOption option) const
{
    switch (option) {
        case QImageIOHandler::Quality: {
            return m_quality;
        }
        default: {
            return QVariant();
        }
    }
    Q_UNREACHABLE();
}

void JPGHandler::setOption(QImageIOHandler::ImageOption option, const QVariant &value)
{
    if (option == QImageIOHandler::Quality) {
        const int newquality = value.toInt();
        // -1 means default
        if (newquality == -1) {
            m_quality = 100;
        } else {
            m_quality = qBound(0, newquality, 100);
        }
    }
}

bool JPGHandler::canRead(QIODevice *device)
{
    if (Q_UNLIKELY(!device)) {
        kWarning() << "Called with no device";
        return false;
    }

    const QByteArray data = device->peek(s_peekbuffsize);

    if (Q_UNLIKELY(data.isEmpty())) {
        return false;
    }

    for (int i = 0; i < HeadersTblSize; i++) {
        if (data.size() >= HeadersTbl[i].headersize &&
            ::memcmp(data.constData(), HeadersTbl[i].header, HeadersTbl[i].headersize) == 0) {
            kDebug() << "JPG header detected" << i;
            return true;
        }
    }

    return false;
}

QList<QByteArray> JPGPlugin::mimeTypes() const
{
    static const QList<QByteArray> list = QList<QByteArray>()
        << "image/jpeg";
    return list;
}

QImageIOPlugin::Capabilities JPGPlugin::capabilities(QIODevice *device, const QByteArray &format) const
{
    if (format == s_jpgpluginformat) {
        return QImageIOPlugin::Capabilities(QImageIOPlugin::CanRead | QImageIOPlugin::CanWrite);
    }
    if (!device || !device->isOpen()) {
        return 0;
    }
    QImageIOPlugin::Capabilities cap;
    if (device->isReadable() && JPGHandler::canRead(device)) {
        cap |= QImageIOPlugin::CanRead;
    }
    if (format == s_jpgpluginformat && device->isWritable()) {
        cap |= QImageIOPlugin::CanWrite;
    }
    return cap;
}

QImageIOHandler *JPGPlugin::create(QIODevice *device, const QByteArray &format) const
{
    QImageIOHandler *handler = new JPGHandler();
    handler->setDevice(device);
    handler->setFormat(format);
    return handler;
}

Q_EXPORT_PLUGIN(JPGPlugin)