qt5base-lts/tests/auto/gui/image/qimagewriter/tst_qimagewriter.cpp
Jani Heikkinen 83a5694dc2 Update copyright headers
Qt copyrights are now in The Qt Company, so we could update the source
code headers accordingly. In the same go we should also fix the links to
point to qt.io.

Outdated header.LGPL removed (use header.LGPL21 instead)

Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing
combination. New header.LGPL-COMM taken in the use file which were
using old header.LGPL3 (src/plugins/platforms/android/extract.cpp)

Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license
combination

Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe
Reviewed-by: Matti Paaso <matti.paaso@theqtcompany.com>
2015-02-11 06:49:51 +00:00

573 lines
18 KiB
C++

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <QtTest/QtTest>
#include <QDebug>
#include <QFile>
#include <QImage>
#include <QImageReader>
#include <QImageWriter>
#include <QPainter>
#include <QSet>
#include <QTemporaryDir>
#ifdef Q_OS_UNIX // for geteuid()
# include <sys/types.h>
# include <unistd.h>
#endif
#include <algorithm>
typedef QMap<QString, QString> QStringMap;
typedef QList<int> QIntList;
Q_DECLARE_METATYPE(QImageWriter::ImageWriterError)
Q_DECLARE_METATYPE(QImage::Format)
class tst_QImageWriter : public QObject
{
Q_OBJECT
public:
tst_QImageWriter();
virtual ~tst_QImageWriter();
public slots:
void init();
void initTestCase();
void cleanup();
private slots:
void getSetCheck();
void writeImage_data();
void writeImage();
void writeImage2_data();
void writeImage2();
void supportedFormats();
void supportedMimeTypes();
void writeToInvalidDevice();
void testCanWrite();
void supportsOption_data();
void supportsOption();
void saveWithNoFormat_data();
void saveWithNoFormat();
void saveToTemporaryFile();
private:
QString prefix;
QString writePrefix;
};
// helper to skip an autotest when the given image format is not supported
#define SKIP_IF_UNSUPPORTED(format) do { \
if (!QByteArray(format).isEmpty() && !QImageReader::supportedImageFormats().contains(format)) \
QSKIP("\"" + QByteArray(format) + "\" images are not supported"); \
} while (0)
static void initializePadding(QImage *image)
{
int effectiveBytesPerLine = (image->width() * image->depth() + 7) / 8;
int paddingBytes = image->bytesPerLine() - effectiveBytesPerLine;
if (paddingBytes == 0)
return;
for (int y = 0; y < image->height(); ++y) {
memset(image->scanLine(y) + effectiveBytesPerLine, 0, paddingBytes);
}
}
void tst_QImageWriter::initTestCase()
{
prefix = QFINDTESTDATA("images/");
if (prefix.isEmpty())
QFAIL("Can't find images directory!");
#if defined(Q_OS_ANDROID) && !defined(Q_OS_ANDROID_NO_SDK)
writePrefix = QDir::homePath();
#else
writePrefix = prefix;
#endif
}
// Testing get/set functions
void tst_QImageWriter::getSetCheck()
{
QImageWriter obj1;
// QIODevice * QImageWriter::device()
// void QImageWriter::setDevice(QIODevice *)
QFile *var1 = new QFile;
obj1.setDevice(var1);
QCOMPARE((QIODevice *) var1, obj1.device());
// The class should possibly handle a 0-pointer as a device, since
// there is a default contructor, so it's "handling" a 0 device by default.
// For example: QMovie::setDevice(0) works just fine
obj1.setDevice((QIODevice *)0);
QCOMPARE((QIODevice *) 0, obj1.device());
delete var1;
// int QImageWriter::quality()
// void QImageWriter::setQuality(int)
obj1.setQuality(0);
QCOMPARE(0, obj1.quality());
obj1.setQuality(INT_MIN);
QCOMPARE(INT_MIN, obj1.quality());
obj1.setQuality(INT_MAX);
QCOMPARE(INT_MAX, obj1.quality());
// int QImageWriter::compression()
// void QImageWriter::setCompression(int)
obj1.setCompression(0);
QCOMPARE(0, obj1.compression());
obj1.setCompression(INT_MIN);
QCOMPARE(INT_MIN, obj1.compression());
obj1.setCompression(INT_MAX);
QCOMPARE(INT_MAX, obj1.compression());
// float QImageWriter::gamma()
// void QImageWriter::setGamma(float)
obj1.setGamma(0.0f);
QCOMPARE(0.0f, obj1.gamma());
obj1.setGamma(1.1f);
QCOMPARE(1.1f, obj1.gamma());
}
tst_QImageWriter::tst_QImageWriter()
{
}
tst_QImageWriter::~tst_QImageWriter()
{
QDir dir(prefix);
QStringList filesToDelete = dir.entryList(QStringList() << "gen-*" , QDir::NoDotAndDotDot | QDir::Files);
foreach( QString file, filesToDelete) {
QFile::remove(dir.absoluteFilePath(file));
}
}
void tst_QImageWriter::init()
{
}
void tst_QImageWriter::cleanup()
{
}
void tst_QImageWriter::writeImage_data()
{
QTest::addColumn<QString>("fileName");
QTest::addColumn<bool>("lossy");
QTest::addColumn<QByteArray>("format");
QTest::newRow("BMP: colorful") << QString("colorful.bmp") << false << QByteArray("bmp");
QTest::newRow("BMP: font") << QString("font.bmp") << false << QByteArray("bmp");
QTest::newRow("XPM: marble") << QString("marble.xpm") << false << QByteArray("xpm");
QTest::newRow("PNG: kollada") << QString("kollada.png") << false << QByteArray("png");
QTest::newRow("PPM: teapot") << QString("teapot.ppm") << false << QByteArray("ppm");
QTest::newRow("PBM: ship63") << QString("ship63.pbm") << true << QByteArray("pbm");
QTest::newRow("XBM: gnus") << QString("gnus.xbm") << false << QByteArray("xbm");
QTest::newRow("JPEG: beavis") << QString("beavis.jpg") << true << QByteArray("jpeg");
}
void tst_QImageWriter::writeImage()
{
QFETCH(QString, fileName);
QFETCH(bool, lossy);
QFETCH(QByteArray, format);
SKIP_IF_UNSUPPORTED(format);
QImage image;
{
QImageReader reader(prefix + fileName);
image = reader.read();
QVERIFY2(!image.isNull(), qPrintable(reader.errorString()));
}
{
QImageWriter writer(writePrefix + "gen-" + fileName, format);
QVERIFY(writer.write(image));
}
{
bool skip = false;
#if defined(Q_OS_UNIX)
if (::geteuid() == 0)
skip = true;
#endif
if (!skip) {
// Shouldn't be able to write to read-only file
QFile sourceFile(writePrefix + "gen-" + fileName);
QFile::Permissions permissions = sourceFile.permissions();
QVERIFY(sourceFile.setPermissions(QFile::ReadOwner | QFile::ReadUser | QFile::ReadGroup | QFile::ReadOther));
QImageWriter writer(writePrefix + "gen-" + fileName, format);
QVERIFY(!writer.write(image));
QVERIFY(sourceFile.setPermissions(permissions));
}
}
QImage image2;
{
QImageReader reader(writePrefix + "gen-" + fileName);
image2 = reader.read();
QVERIFY(!image2.isNull());
}
if (!lossy) {
QCOMPARE(image, image2);
} else {
QCOMPARE(image.format(), image2.format());
QCOMPARE(image.depth(), image2.depth());
}
}
void tst_QImageWriter::writeImage2_data()
{
QTest::addColumn<QString>("fileName");
QTest::addColumn<QByteArray>("format");
QTest::addColumn<QImage>("image");
const QStringList formats = QStringList() << "bmp" << "xpm" << "png"
<< "ppm"; //<< "jpeg";
QImage image0(70, 70, QImage::Format_ARGB32);
image0.fill(QColor(Qt::red).rgb());
QImage::Format imgFormat = QImage::Format_Mono;
while (imgFormat != QImage::NImageFormats) {
QImage image = image0.convertToFormat(imgFormat);
initializePadding(&image);
foreach (const QString format, formats) {
const QString fileName = QString("solidcolor_%1.%2").arg(imgFormat)
.arg(format);
QTest::newRow(fileName.toLatin1()) << fileName
<< format.toLatin1()
<< image;
}
imgFormat = QImage::Format(int(imgFormat) + 1);
}
}
/*
Workaround for the equality operator for indexed formats
(which fails if the colortables are different).
Images must have the same format and size.
*/
static bool equalImageContents(const QImage &image1, const QImage &image2)
{
switch (image1.format()) {
case QImage::Format_Mono:
case QImage::Format_Indexed8:
for (int y = 0; y < image1.height(); ++y)
for (int x = 0; x < image1.width(); ++x)
if (image1.pixel(x, y) != image2.pixel(x, y))
return false;
return true;
default:
return (image1 == image2);
}
}
void tst_QImageWriter::writeImage2()
{
QFETCH(QString, fileName);
QFETCH(QByteArray, format);
QFETCH(QImage, image);
//we reduce the scope of writer so that it closes the associated file
// and QFile::remove can actually work
{
QImageWriter writer(fileName, format);
QVERIFY(writer.write(image));
}
QImage written;
//we reduce the scope of reader so that it closes the associated file
// and QFile::remove can actually work
{
QImageReader reader(fileName, format);
QVERIFY(reader.read(&written));
}
written = written.convertToFormat(image.format());
if (!equalImageContents(written, image)) {
qDebug() << "image" << image.format() << image.width()
<< image.height() << image.depth()
<< hex << image.pixel(0, 0);
qDebug() << "written" << written.format() << written.width()
<< written.height() << written.depth()
<< hex << written.pixel(0, 0);
}
QVERIFY(equalImageContents(written, image));
QVERIFY(QFile::remove(fileName));
}
void tst_QImageWriter::supportedFormats()
{
QList<QByteArray> formats = QImageWriter::supportedImageFormats();
QList<QByteArray> sortedFormats = formats;
std::sort(sortedFormats.begin(), sortedFormats.end());
// check that the list is sorted
QCOMPARE(formats, sortedFormats);
QSet<QByteArray> formatSet;
foreach (QByteArray format, formats)
formatSet << format;
// check that the list does not contain duplicates
QCOMPARE(formatSet.size(), formats.size());
}
void tst_QImageWriter::supportedMimeTypes()
{
QList<QByteArray> mimeTypes = QImageWriter::supportedMimeTypes();
QList<QByteArray> sortedMimeTypes = mimeTypes;
std::sort(sortedMimeTypes.begin(), sortedMimeTypes.end());
// check that the list is sorted
QCOMPARE(mimeTypes, sortedMimeTypes);
QSet<QByteArray> mimeTypeSet;
foreach (QByteArray mimeType, mimeTypes)
mimeTypeSet << mimeType;
// check the list as a minimum contains image/bmp
QVERIFY(mimeTypeSet.contains("image/bmp"));
// check that the list does not contain duplicates
QCOMPARE(mimeTypeSet.size(), mimeTypes.size());
}
void tst_QImageWriter::writeToInvalidDevice()
{
QLatin1String fileName("/these/directories/do/not/exist/001.png");
{
QImageWriter writer(fileName);
QVERIFY(!writer.canWrite());
QCOMPARE(writer.error(), QImageWriter::DeviceError);
}
{
QImageWriter writer(fileName);
writer.setFormat("png");
QVERIFY(!writer.canWrite());
QCOMPARE(writer.error(), QImageWriter::DeviceError);
}
{
QImageWriter writer(fileName);
QImage im(10, 10, QImage::Format_ARGB32);
QVERIFY(!writer.write(im));
QCOMPARE(writer.error(), QImageWriter::DeviceError);
}
{
QImageWriter writer(fileName);
writer.setFormat("png");
QImage im(10, 10, QImage::Format_ARGB32);
QVERIFY(!writer.write(im));
QCOMPARE(writer.error(), QImageWriter::DeviceError);
}
}
void tst_QImageWriter::testCanWrite()
{
{
// device is not set
QImageWriter writer;
QVERIFY(!writer.canWrite());
QCOMPARE(writer.error(), QImageWriter::DeviceError);
}
{
// check if canWrite won't leave an empty file
QTemporaryDir dir;
QVERIFY(dir.isValid());
QString fileName(dir.path() + QLatin1String("/001.garble"));
QVERIFY(!QFileInfo(fileName).exists());
QImageWriter writer(fileName);
QVERIFY(!writer.canWrite());
QCOMPARE(writer.error(), QImageWriter::UnsupportedFormatError);
QVERIFY(!QFileInfo(fileName).exists());
}
}
void tst_QImageWriter::supportsOption_data()
{
QTest::addColumn<QString>("fileName");
QTest::addColumn<QIntList>("options");
QTest::newRow("png") << QString("gen-black.png")
<< (QIntList() << QImageIOHandler::Gamma
<< QImageIOHandler::Description
<< QImageIOHandler::Quality
<< QImageIOHandler::Size
<< QImageIOHandler::ScaledSize);
}
void tst_QImageWriter::supportsOption()
{
SKIP_IF_UNSUPPORTED(QTest::currentDataTag());
QFETCH(QString, fileName);
QFETCH(QIntList, options);
QSet<QImageIOHandler::ImageOption> allOptions;
allOptions << QImageIOHandler::Size
<< QImageIOHandler::ClipRect
<< QImageIOHandler::Description
<< QImageIOHandler::ScaledClipRect
<< QImageIOHandler::ScaledSize
<< QImageIOHandler::CompressionRatio
<< QImageIOHandler::Gamma
<< QImageIOHandler::Quality
<< QImageIOHandler::Name
<< QImageIOHandler::SubType
<< QImageIOHandler::IncrementalReading
<< QImageIOHandler::Endianness
<< QImageIOHandler::Animation
<< QImageIOHandler::BackgroundColor;
QImageWriter writer(writePrefix + fileName);
for (int i = 0; i < options.size(); ++i) {
QVERIFY(writer.supportsOption(QImageIOHandler::ImageOption(options.at(i))));
allOptions.remove(QImageIOHandler::ImageOption(options.at(i)));
}
foreach (QImageIOHandler::ImageOption option, allOptions)
QVERIFY(!writer.supportsOption(option));
}
void tst_QImageWriter::saveWithNoFormat_data()
{
QTest::addColumn<QString>("fileName");
QTest::addColumn<QByteArray>("format");
QTest::addColumn<QImageWriter::ImageWriterError>("error");
QTest::newRow("garble") << writePrefix + QString("gen-out.garble") << QByteArray("jpeg") << QImageWriter::UnsupportedFormatError;
QTest::newRow("bmp") << writePrefix + QString("gen-out.bmp") << QByteArray("bmp") << QImageWriter::ImageWriterError(0);
QTest::newRow("xbm") << writePrefix + QString("gen-out.xbm") << QByteArray("xbm") << QImageWriter::ImageWriterError(0);
QTest::newRow("xpm") << writePrefix + QString("gen-out.xpm") << QByteArray("xpm") << QImageWriter::ImageWriterError(0);
QTest::newRow("png") << writePrefix + QString("gen-out.png") << QByteArray("png") << QImageWriter::ImageWriterError(0);
QTest::newRow("ppm") << writePrefix + QString("gen-out.ppm") << QByteArray("ppm") << QImageWriter::ImageWriterError(0);
QTest::newRow("pbm") << writePrefix + QString("gen-out.pbm") << QByteArray("pbm") << QImageWriter::ImageWriterError(0);
}
void tst_QImageWriter::saveWithNoFormat()
{
QFETCH(QString, fileName);
QFETCH(QByteArray, format);
QFETCH(QImageWriter::ImageWriterError, error);
SKIP_IF_UNSUPPORTED(format);
QImage niceImage(64, 64, QImage::Format_ARGB32);
memset(niceImage.bits(), 0, niceImage.byteCount());
QImageWriter writer(fileName /* , 0 - no format! */);
if (error != 0) {
QVERIFY(!writer.write(niceImage));
QCOMPARE(writer.error(), error);
return;
}
QVERIFY2(writer.write(niceImage), qPrintable(writer.errorString()));
QImageReader reader(fileName);
QCOMPARE(reader.format(), format);
QVERIFY(reader.canRead());
QImage outImage = reader.read();
QVERIFY2(!outImage.isNull(), qPrintable(reader.errorString()));
}
void tst_QImageWriter::saveToTemporaryFile()
{
QImage image(prefix + "kollada.png");
QVERIFY(!image.isNull());
{
// 1) Via QImageWriter's API, with a standard temp file name
QTemporaryFile file;
QVERIFY(file.open());
QImageWriter writer(&file, "PNG");
if (writer.canWrite())
QVERIFY(writer.write(image));
else
qWarning() << file.errorString();
#if defined(Q_OS_WINCE)
file.reset();
#endif
QCOMPARE(QImage(writer.fileName()), image);
}
{
// 2) Via QImage's API, with a standard temp file name
QTemporaryFile file;
QVERIFY(file.open());
QVERIFY(image.save(&file, "PNG"));
file.reset();
QImage tmp;
QVERIFY(tmp.load(&file, "PNG"));
QCOMPARE(tmp, image);
}
{
// 3) Via QImageWriter's API, with a named temp file
QTemporaryFile file("tempXXXXXX");
QVERIFY(file.open());
QImageWriter writer(&file, "PNG");
QVERIFY(writer.write(image));
#if defined(Q_OS_WINCE)
file.reset();
#endif
QCOMPARE(QImage(writer.fileName()), image);
}
{
// 4) Via QImage's API, with a named temp file
QTemporaryFile file("tempXXXXXX");
QVERIFY(file.open());
QVERIFY(image.save(&file, "PNG"));
file.reset();
QImage tmp;
QVERIFY(tmp.load(&file, "PNG"));
QCOMPARE(tmp, image);
}
}
QTEST_MAIN(tst_QImageWriter)
#include "tst_qimagewriter.moc"