tools/qmlscene/main.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the tools applications of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include <QtCore/qdebug.h>
  43 #include <QtCore/qabstractanimation.h>
  44 #include <QtGui/qapplication.h>
  45 #include <QtDeclarative/qdeclarative.h>
  46 #include <QtDeclarative/qdeclarativeengine.h>
  47 #include <QtDeclarative/qdeclarativecomponent.h>
  48 #include <QtDeclarative/qdeclarativeview.h>
  49 #include <QtCore/qdir.h>
  50 #include <QtGui/QFormLayout>
  51 #include <QtGui/QComboBox>
  52 #include <QtGui/QCheckBox>
  53 #include <QtGui/QDialog>
  54 #include <QtGui/QDialogButtonBox>
  55 #include <QtGui/QFileDialog>
  56 #include <QtGui/QGraphicsView>
  57
  58 #include <QtDeclarative/qdeclarativeitem.h>
  59 #include <QtDeclarative/qdeclarativecontext.h>
  60 #include <private/qdeclarativedebughelper_p.h>
  61
  62 // ### This should be private API
  63 #include <qsgitem.h>
  64 #include <qsgview.h>
  65
  66 #define QT_NO_SCENEGRAPHITEM
  67
  68 #ifndef QT_NO_SCENEGRAPHITEM
  69 #include "scenegraphitem.h"
  70 #endif
  71
  72 #include <QtCore/qmath.h>
  73
  74 #ifdef QML_RUNTIME_TESTING
  75 class RenderStatistics
  76 {
  77 public:
  78     static void updateStats();
  79     static void printTotalStats();
  80 private:
  81     static QVector<qreal> timePerFrame;
  82     static QVector<int> timesPerFrames;
  83 };
  84
  85 QVector<qreal> RenderStatistics::timePerFrame;
  86 QVector<int> RenderStatistics::timesPerFrames;
  87
  88 void RenderStatistics::updateStats()
  89 {
  90     static QTime time;
  91     static int frames;
  92     static int lastTime;
  93
  94     if (frames == 0) {
  95         time.start();
  96     } else {
  97         int elapsed = time.elapsed();
  98         timesPerFrames.append(elapsed - lastTime);
  99         lastTime = elapsed;
 100
 101         if (elapsed > 5000) {
 102             qreal avgtime = elapsed / (qreal) frames;
 103             qreal var = 0;
 104             for (int i = 0; i < timesPerFrames.size(); ++i) {
 105                 qreal diff = timesPerFrames.at(i) - avgtime;
 106                 var += diff * diff;
 107             }
 108             var /= timesPerFrames.size();
 109
 110             qDebug("Average time per frame: %f ms (%i fps), std.dev: %f ms", avgtime, qRound(1000. / avgtime), qSqrt(var));
 111
 112             timePerFrame.append(avgtime);
 113             timesPerFrames.clear();
 114             time.start();
 115             lastTime = 0;
 116             frames = 0;
 117         }
 118     }
 119     ++frames;
 120 }
 121
 122 void RenderStatistics::printTotalStats()
 123 {
 124     int count = timePerFrame.count();
 125     if (count == 0)
 126         return;
 127
 128     qreal minTime = 0;
 129     qreal maxTime = 0;
 130     qreal avg = 0;
 131     for (int i = 0; i < count; ++i) {
 132         minTime = minTime == 0 ? timePerFrame.at(i) : qMin(minTime, timePerFrame.at(i));
 133         maxTime = qMax(maxTime, timePerFrame.at(i));
 134         avg += timePerFrame.at(i);
 135     }
 136     avg /= count;
 137
 138     qDebug(" ");
 139     qDebug("----- Statistics -----");
 140     qDebug("Average time per frame: %f ms (%i fps)", avg, qRound(1000. / avg));
 141     qDebug("Best time per frame: %f ms (%i fps)", minTime, int(1000 / minTime));
 142     qDebug("Worst time per frame: %f ms (%i fps)", maxTime, int(1000 / maxTime));
 143     qDebug("----------------------");
 144     qDebug(" ");
 145 }
 146 #endif
 147
 148
 149 static QGLFormat getFormat()
 150 {
 151     QGLFormat f = QGLFormat::defaultFormat();
 152     f.setSampleBuffers(!qApp->arguments().contains("--no-multisample"));
 153     f.setSwapInterval(qApp->arguments().contains("--nonblocking-swap") ? 0 : 1);
 154     f.setStereo(qApp->arguments().contains("--stereo"));
 155     return f;
 156 }
 157
 158 class MyQSGView : public QSGView
 159 {
 160 public:
 161     MyQSGView() : QSGView(getFormat())
 162     {
 163         setResizeMode(QSGView::SizeRootObjectToView);
 164     }
 165
 166 protected:
 167     void paintEvent(QPaintEvent *e) {
 168         QSGView::paintEvent(e);
 169
 170 #ifdef QML_RUNTIME_TESTING
 171 //        RenderStatistics::updateStats();
 172 #endif
 173
 174         static bool continuousUpdate = qApp->arguments().contains("--continuous-update");
 175         if (continuousUpdate)
 176             update();
 177     }
 178 };
 179
 180 class MyDeclarativeView: public QDeclarativeView
 181 {
 182 public:
 183     MyDeclarativeView(QWidget *parent = 0) : QDeclarativeView(parent)
 184     {
 185         setResizeMode(QDeclarativeView::SizeRootObjectToView);
 186     }
 187
 188 protected:
 189     void paintEvent(QPaintEvent *event)
 190     {
 191         QDeclarativeView::paintEvent(event);
 192
 193 #ifdef QML_RUNTIME_TESTING
 194         RenderStatistics::updateStats();
 195 #endif
 196
 197         static bool continuousUpdate = qApp->arguments().contains("--continuous-update");
 198         if (continuousUpdate)
 199             scene()->update();
 200     }
 201 };
 202
 203 #ifndef QT_NO_SCENEGRAPHITEM
 204 class MyGraphicsView: public QGraphicsView
 205 {
 206 public:
 207     MyGraphicsView(bool clip, QWidget *parent = 0) : QGraphicsView(parent)
 208     {
 209         setViewport(new QGLWidget(getFormat()));
 210         setScene(&scene);
 211         scene.addItem(&item);
 212         item.setFlag(QGraphicsItem::ItemClipsToShape, clip);
 213         QGraphicsTextItem *text;
 214         text = scene.addText(QLatin1String("Scene graph on graphics view."), QFont(QLatin1String("Times"), 10));
 215         text->setX(5);
 216         text->setY(5);
 217         text->setDefaultTextColor(Qt::black);
 218         text = scene.addText(QLatin1String("Scene graph on graphics view."), QFont(QLatin1String("Times"), 10));
 219         text->setX(4);
 220         text->setY(4);
 221         text->setDefaultTextColor(Qt::yellow);
 222     }
 223
 224     SceneGraphItem *sceneGraphItem() { return &item; }
 225
 226 protected:
 227     void paintEvent(QPaintEvent *event)
 228     {
 229         QGraphicsView::paintEvent(event);
 230
 231 #ifdef QML_RUNTIME_TESTING
 232         RenderStatistics::updateStats();
 233 #endif
 234
 235         static bool continuousUpdate = qApp->arguments().contains("--continuous-update");
 236         if (continuousUpdate)
 237             QGraphicsView::scene()->update();
 238     }
 239
 240     QGraphicsScene scene;
 241     SceneGraphItem item;
 242 };
 243 #endif
 244
 245 struct Options
 246 {
 247     Options()
 248         : originalQml(false)
 249         , originalQmlRaster(false)
 250         , maximized(false)
 251         , fullscreen(false)
 252         , scenegraphOnGraphicsview(false)
 253         , clip(false)
 254         , versionDetection(true)
 255         , vsync(true)
 256     {
 257     }
 258
 259     QUrl file;
 260     bool originalQml;
 261     bool originalQmlRaster;
 262     bool maximized;
 263     bool fullscreen;
 264     bool scenegraphOnGraphicsview;
 265     bool clip;
 266     bool versionDetection;
 267     bool vsync;
 268 };
 269
 270 #if defined(QMLSCENE_BUNDLE)
 271 Q_DECLARE_METATYPE(QFileInfo);
 272 QFileInfoList findQmlFiles(const QString &dirName)
 273 {
 274     QDir dir(dirName);
 275
 276     QFileInfoList ret;
 277     if (dir.exists()) {
 278         QFileInfoList fileInfos = dir.entryInfoList(QStringList() << "*.qml",
 279                                                     QDir::Files | QDir::AllDirs | QDir::NoDotAndDotDot);
 280
 281         foreach (QFileInfo fileInfo, fileInfos) {
 282             if (fileInfo.isDir())
 283                 ret += findQmlFiles(fileInfo.filePath());
 284             else if (fileInfo.fileName().length() > 0 && fileInfo.fileName().at(0).isLower())
 285                 ret.append(fileInfo);
 286         }
 287     }
 288
 289     return ret;
 290 }
 291
 292 static int displayOptionsDialog(Options *options)
 293 {
 294     QDialog dialog;
 295
 296     QFormLayout *layout = new QFormLayout(&dialog);
 297
 298     QComboBox *qmlFileComboBox = new QComboBox(&dialog);
 299     QFileInfoList fileInfos = findQmlFiles(":/bundle") + findQmlFiles("./qmlscene-resources");
 300
 301     foreach (QFileInfo fileInfo, fileInfos)
 302         qmlFileComboBox->addItem(fileInfo.dir().dirName() + "/" + fileInfo.fileName(), QVariant::fromValue(fileInfo));
 303
 304     QCheckBox *originalCheckBox = new QCheckBox(&dialog);
 305     originalCheckBox->setText("Use original QML viewer");
 306     originalCheckBox->setChecked(options->originalQml);
 307
 308     QCheckBox *fullscreenCheckBox = new QCheckBox(&dialog);
 309     fullscreenCheckBox->setText("Start fullscreen");
 310     fullscreenCheckBox->setChecked(options->fullscreen);
 311
 312     QCheckBox *maximizedCheckBox = new QCheckBox(&dialog);
 313     maximizedCheckBox->setText("Start maximized");
 314     maximizedCheckBox->setChecked(options->maximized);
 315
 316     QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel,
 317                                                        Qt::Horizontal,
 318                                                        &dialog);
 319     QObject::connect(buttonBox, SIGNAL(accepted()), &dialog, SLOT(accept()));
 320     QObject::connect(buttonBox, SIGNAL(rejected()), &dialog, SLOT(reject()));
 321
 322     layout->addRow("Qml file:", qmlFileComboBox);
 323     layout->addWidget(originalCheckBox);
 324     layout->addWidget(maximizedCheckBox);
 325     layout->addWidget(fullscreenCheckBox);
 326     layout->addWidget(buttonBox);
 327
 328     int result = dialog.exec();
 329     if (result == QDialog::Accepted) {
 330         QVariant variant = qmlFileComboBox->itemData(qmlFileComboBox->currentIndex());
 331         QFileInfo fileInfo = variant.value<QFileInfo>();
 332
 333         if (fileInfo.canonicalFilePath().startsWith(":"))
 334             options->file = QUrl("qrc" + fileInfo.canonicalFilePath());
 335         else
 336             options->file = QUrl::fromLocalFile(fileInfo.canonicalFilePath());
 337         options->originalQml = originalCheckBox->isChecked();
 338         options->maximized = maximizedCheckBox->isChecked();
 339         options->fullscreen = fullscreenCheckBox->isChecked();
 340     }
 341     return result;
 342 }
 343 #endif
 344
 345 static void checkAndAdaptVersion(const QUrl &url)
 346 {
 347     if (!qgetenv("QMLSCENE_IMPORT_NAME").isEmpty()) {
 348         return;
 349     }
 350
 351     QString fileName = url.toLocalFile();
 352     if (fileName.isEmpty())
 353         return;
 354
 355     QFile f(fileName);
 356     if (!f.open(QFile::ReadOnly | QFile::Text)) {
 357         qWarning("qmlscene: failed to check version of file '%s', could not open...",
 358                  qPrintable(fileName));
 359         return;
 360     }
 361
 362     QRegExp quick1("import +QtQuick +1\\.");
 363     QRegExp qt47("import +Qt +4\\.7");
 364
 365     QString envToWrite;
 366     QString compat;
 367
 368     QTextStream stream(&f);
 369     bool codeFound= false;
 370     while (!codeFound && envToWrite.isEmpty()) {
 371         QString line = stream.readLine();
 372         if (line.contains("{"))
 373             codeFound = true;
 374         if (quick1.indexIn(line) >= 0) {
 375             envToWrite = QLatin1String("quick1");
 376             compat = QLatin1String("QtQuick 1.0");
 377         } else if (qt47.indexIn(line) >= 0) {
 378             envToWrite = QLatin1String("qt");
 379             compat = QLatin1String("Qt 4.7");
 380         }
 381     }
 382
 383     if (!envToWrite.isEmpty()) {
 384         qWarning("qmlscene: Autodetecting compatibility import \"%s\"...", qPrintable(compat));
 385         if (qgetenv("QMLSCENE_IMPORT_NAME").isEmpty())
 386             qputenv("QMLSCENE_IMPORT_NAME", envToWrite.toLatin1().constData());
 387     }
 388 }
 389
 390 static void displayFileDialog(Options *options)
 391 {
 392     QString fileName = QFileDialog::getOpenFileName(0, "Open QML file", QString(), "QML Files (*.qml)");
 393     if (!fileName.isEmpty()) {
 394         QFileInfo fi(fileName);
 395         options->file = QUrl::fromLocalFile(fi.canonicalFilePath());
 396     }
 397 }
 398
 399 static void loadDummyDataFiles(QDeclarativeEngine &engine, const QString& directory)
 400 {
 401     QDir dir(directory+"/dummydata", "*.qml");
 402     QStringList list = dir.entryList();
 403     for (int i = 0; i < list.size(); ++i) {
 404         QString qml = list.at(i);
 405         QFile f(dir.filePath(qml));
 406         f.open(QIODevice::ReadOnly);
 407         QByteArray data = f.readAll();
 408         QDeclarativeComponent comp(&engine);
 409         comp.setData(data, QUrl());
 410         QObject *dummyData = comp.create();
 411
 412         if(comp.isError()) {
 413             QList<QDeclarativeError> errors = comp.errors();
 414             foreach (const QDeclarativeError &error, errors) {
 415                 qWarning() << error;
 416             }
 417         }
 418
 419         if (dummyData) {
 420             qWarning() << "Loaded dummy data:" << dir.filePath(qml);
 421             qml.truncate(qml.length()-4);
 422             engine.rootContext()->setContextProperty(qml, dummyData);
 423             dummyData->setParent(&engine);
 424         }
 425     }
 426 }
 427
 428 static void usage()
 429 {
 430     qWarning("Usage: qmlscene [options] <filename>");
 431     qWarning(" ");
 432     qWarning(" options:");
 433     qWarning("  --maximized ............................... run maximized");
 434     qWarning("  --fullscreen .............................. run fullscreen");
 435     qWarning("  --original-qml ............................ run using QGraphicsView instead of scenegraph (OpenGL engine)");
 436     qWarning("  --original-qml-raster ..................... run using QGraphicsView instead of scenegraph (Raster engine)");
 437     qWarning("  --no-multisample .......................... Disable multisampling (anti-aliasing)");
 438     qWarning("  --continuous-update ....................... Continuously render the scene");
 439     qWarning("  --nonblocking-swap ........................ Do not wait for v-sync to swap buffers");
 440     qWarning("  --stereo .................................. Enable stereo on the GL context");
 441 #ifndef QT_NO_SCENEGRAPHITEM
 442     qWarning("  --sg-on-gv [--clip] ....................... Scenegraph on graphicsview (and clip to item)");
 443 #endif
 444     qWarning("  --no-version-detection .................... Do not try to detect the version of the .qml file");
 445     qWarning("  --no-vsync-animations ..................... Do not use vsync based animations");
 446
 447     qWarning(" ");
 448     exit(1);
 449 }
 450
 451 int main(int argc, char ** argv)
 452 {
 453 #ifdef Q_WS_X11
 454     QApplication::setAttribute(Qt::AA_X11InitThreads);
 455 #endif
 456
 457     Options options;
 458
 459     QDeclarativeDebugHelper::enableDebugging();
 460     QStringList imports;
 461     for (int i = 1; i < argc; ++i) {
 462         if (*argv[i] != '-' && QFileInfo(argv[i]).exists())
 463             options.file = QUrl::fromLocalFile(argv[i]);
 464         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--original-qml"))
 465             options.originalQml = true;
 466         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--original-qml-raster"))
 467             options.originalQmlRaster = true;
 468         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--maximized"))
 469             options.maximized = true;
 470         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--fullscreen"))
 471             options.fullscreen = true;
 472         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--sg-on-gv"))
 473             options.scenegraphOnGraphicsview = true;
 474         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--clip"))
 475             options.clip = true;
 476         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--no-version-detection"))
 477             options.versionDetection = false;
 478         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("-i") && i + 1 < argc)
 479             imports.append(QString::fromLatin1(argv[++i]));
 480         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--no-vsync-animations"))
 481             options.vsync = false;
 482         else if (QString::fromLatin1(argv[i]).toLower() == QLatin1String("--help")
 483                  || QString::fromLatin1(argv[i]).toLower() == QLatin1String("-help")
 484                  || QString::fromLatin1(argv[i]).toLower() == QLatin1String("--h")
 485                  || QString::fromLatin1(argv[i]).toLower() == QLatin1String("-h"))
 486             usage();
 487     }
 488
 489     QApplication::setGraphicsSystem("raster");
 490
 491     QApplication app(argc, argv);
 492     app.setApplicationName("QtQmlViewer");
 493     app.setOrganizationName("Nokia");
 494     app.setOrganizationDomain("nokia.com");
 495
 496     if (options.file.isEmpty())
 497 #if defined(QMLSCENE_BUNDLE)
 498         displayOptionsDialog(&options);
 499 #else
 500         displayFileDialog(&options);
 501 #endif
 502
 503     QWidget *view = 0;
 504     QDeclarativeEngine *engine = 0;
 505
 506     int exitCode = 0;
 507
 508     if (!options.file.isEmpty()) {
 509 #ifndef QT_NO_SCENEGRAPHITEM
 510         if (options.scenegraphOnGraphicsview) {
 511             MyGraphicsView *gvView = new MyGraphicsView(options.clip);
 512             SceneGraphItem *item = gvView->sceneGraphItem();
 513             engine = item->engine();
 514             for (int i = 0; i < imports.size(); ++i)
 515                 engine->addImportPath(imports.at(i));
 516             view = gvView;
 517             if (options.file.isLocalFile()) {
 518                 QFileInfo fi(options.file.toLocalFile());
 519                 loadDummyDataFiles(*engine, fi.path());
 520             }
 521             item->setSource(options.file);
 522         } else
 523 #endif
 524         if (!options.originalQml && !options.originalQmlRaster) {
 525             if (options.versionDetection)
 526                 checkAndAdaptVersion(options.file);
 527             QSGView *qxView = new MyQSGView();
 528             qxView->setVSyncAnimations(options.vsync);
 529             engine = qxView->engine();
 530             for (int i = 0; i < imports.size(); ++i)
 531                 engine->addImportPath(imports.at(i));
 532             view = qxView;
 533             if (options.file.isLocalFile()) {
 534                 QFileInfo fi(options.file.toLocalFile());
 535                 loadDummyDataFiles(*engine, fi.path());
 536             }
 537             qxView->setSource(options.file);
 538
 539         } else {
 540             MyDeclarativeView *gvView = new MyDeclarativeView();
 541             engine = gvView->engine();
 542             for (int i = 0; i < imports.size(); ++i)
 543                 engine->addImportPath(imports.at(i));
 544             view = gvView;
 545             if (options.file.isLocalFile()) {
 546                 QFileInfo fi(options.file.toLocalFile());
 547                 loadDummyDataFiles(*engine, fi.path());
 548             }
 549             gvView->setSource(options.file);
 550             if (!options.originalQmlRaster) {
 551                 QGLWidget *viewport = new QGLWidget(getFormat());
 552                 gvView->setViewport(viewport);
 553             }
 554         }
 555
 556         QObject::connect(engine, SIGNAL(quit()), QCoreApplication::instance(), SLOT(quit()));
 557
 558         if (options.fullscreen)
 559             view->showFullScreen();
 560         else if (options.maximized)
 561             view->showMaximized();
 562         else
 563             view->show();
 564
 565 #ifdef Q_WS_MAC
 566         view->raise();
 567 #endif
 568
 569         exitCode = app.exec();
 570
 571         delete view;
 572
 573 #ifdef QML_RUNTIME_TESTING
 574         RenderStatistics::printTotalStats();
 575 #endif
 576     }
 577
 578     return exitCode;
 579 }
 580