Merge lp:~uriboni/qt-halide/packaging into lp:qt-halide

[Ugo Riboni]

Add debian packaging and the ability to properly run when installed

[Florian Boucault (fboucault)]

- Does it work on armhf?
- Are tests run during build?

[Ugo Riboni (uriboni)]

> - Does it work on armhf?

It does build on armhf now.

When run on the device the sample app comes up and displays the parrot image, but you see only a corner of the image occupying the entire screen. I am still looking into fixing the demo app.

However replacing the sampleapp.qml with a minimal example doing a transform and rendering it works just fine, the transform is applied and rendered correctly on screen, so the library works fine.

> - Are tests run during build?

No. They look for x11 and there is no x11. I was told balloons would be able to help me but he is on vacation, so for the moment I disabled the tests when building.

[Ugo Riboni (uriboni)]

After doing some research on running the tests, it appears we can run them via xvfb, as the UI toolkit is doing.
However: xvfb is not supported on ARM, and does not support GL, which our tests seem to require (even if we are not actually explicitly using it in the tests, the library still tries to use it)

So I would prefer to leave the tests disabled for now, and at least commit the rest of the packaging work.

[Florian Boucault (fboucault)]

Wrong license, should be LGPL

review: Needs Fixing

[Florian Boucault (fboucault)]

debian/control

"QT Halide example app"
QT is written Qt

review: Needs Fixing

[Florian Boucault (fboucault)]

"An example application demostrating the QML Halide plugin."

*demonstrating*

review: Needs Fixing

[Florian Boucault (fboucault)]

Debian package version is 0.5, should match lib version 0.1

review: Needs Fixing

[lp:~uriboni/qt-halide/packaging]

315. By Ugo Riboni on 2015-04-08

Add version number in the pacakage name, per standards, and fix two spelling mistakes.

316. By Ugo Riboni on 2015-04-08

Revert changelog to a clean state and use the new package name

[Ugo Riboni (uriboni)]

Fixed all comments (between this MR and the copyright MR)
Package name now matches library version and has ~ubuntu1 suffix to allow clean versioning.

The package is still in the phablet-team PPA as Bill insisted for this even after I passed along to him your comments.
The PPA is https://launchpad.net/~phablet-team/+archive/ubuntu/ppa/+packages

[lp:~uriboni/qt-halide/packaging]

317. By Ugo Riboni on 2015-04-08

Rename install and overrides files to match package renaming

318. By Ugo Riboni on 2015-04-08

Fix debian/copyright

319. By Ugo Riboni on 2015-04-08

Bump version

=== modified file '.bzrignore'
--- .bzrignore	2015-04-02 15:30:17 +0000
+++ .bzrignore	2015-04-08 16:28:17 +0000
@@ -1,2 +1,2 @@
-src/QtHalide/generator_*.h
+examples/sampleapp/generator_*.h
 tests/unit/QtHalideTestHelper/generator_*.h

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-04-02 16:23:28 +0000
+++ CMakeLists.txt	2015-04-08 16:28:17 +0000
@@ -11,6 +11,9 @@
 pkg_check_modules(HALIDE Halide)
 pkg_check_modules(FFI libffi)
 
+# Standard install paths
+include(GNUInstallDirs)
+
 if(HALIDE_FOUND)
   MESSAGE("Found system wide installation of Halide")
 else()

=== modified file 'cmake/HalideGenerators.cmake'
--- cmake/HalideGenerators.cmake	2015-03-31 10:59:30 +0000
+++ cmake/HalideGenerators.cmake	2015-04-08 16:28:17 +0000
@@ -31,6 +31,18 @@
 endif()
 
 string(REPLACE "_" "-" TARGET_PROCESSOR ${TARGET_PROCESSOR})
+
+# CMAKE_SYSTEM_PROCESSOR is calling uname -p to get the value, which on our
+# device equals to armv7l and on our x86 build machines equals i686, none of
+# which is not supported by Halide, so we need to fix it.
+# FIXME: find a better way to retrieve the architecture.
+if(${TARGET_PROCESSOR} STREQUAL "armv7l")
+    set(TARGET_PROCESSOR "arm-32")
+endif()
+if(${TARGET_PROCESSOR} STREQUAL "i686")
+    set(TARGET_PROCESSOR "x86-64")
+endif()
+
 string(TOLOWER ${CMAKE_SYSTEM_NAME} TARGET_OS)
 set(TARGET ${TARGET_PROCESSOR}-${TARGET_OS})
 

=== added directory 'debian'
=== added file 'debian/changelog'
--- debian/changelog	1970-01-01 00:00:00 +0000
+++ debian/changelog	2015-04-08 16:28:17 +0000
@@ -0,0 +1,11 @@
+qt-halide (0.1~ubuntu2) vivid; urgency=medium
+
+  * Fix debian/copyright
+
+ -- Ugo Riboni <[e-mail]>  Wed, 08 Apr 2015 18:27:37 +0200
+
+qt-halide (0.1~ubuntu1) vivid; urgency=medium
+
+  * Initial release.
+
+ -- Ugo Riboni <[e-mail]>  Tue, 07 Apr 2015 15:09:53 +0200

=== added file 'debian/compat'
--- debian/compat	1970-01-01 00:00:00 +0000
+++ debian/compat	2015-04-08 16:28:17 +0000
@@ -0,0 +1,1 @@
+9

=== added file 'debian/control'
--- debian/control	1970-01-01 00:00:00 +0000
+++ debian/control	2015-04-08 16:28:17 +0000
@@ -0,0 +1,40 @@
+Source: qt-halide
+Section: libs
+Priority: optional
+Maintainer: Ubuntu Developers <[e-mail]>
+Build-Depends: cmake (>= 2.8.9),
+               debhelper (>= 9),
+               pkg-config,
+               halide-lang,
+               libffi-dev,
+               qml-module-qtquick2 (>= 5.4) | qtdeclarative5-qtquick2-plugin (>= 5.4),
+               qml-module-qttest | qtdeclarative5-test-plugin,
+               qt5-default,
+               qt5-qmake,
+               qtbase5-dev (>= 5.4),
+               qtbase5-dev-tools,
+               qtdeclarative5-dev,
+Standards-Version: 3.9.5
+Homepage: https://launchpad.net/qt-halide
+# If you aren't a member of ~phablet-team but need to upload packaging changes,
+# just go ahead.  ~phablet-team will notice and sync up the code again.
+Vcs-Bzr: https://code.launchpad.net/~phablet-team/qt-halide/trunk
+
+Package: qtdeclarative5-halide-plugin0.1
+Architecture: any
+Pre-Depends: ${misc:Pre-Depends}
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         qml-module-qtquick2 | qtdeclarative5-qtquick2-plugin,
+Description: Halide QML plugin
+ A plugin allowing access to Halide from QML.
+
+Package: qt-halide-sampleapp
+Architecture: any
+Pre-Depends: ${misc:Pre-Depends}
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         qtdeclarative5-halide-plugin0.1,
+         qtdeclarative5-ubuntu-ui-toolkit-plugin
+Description: Qt Halide example app
+ An example application demonstrating the QML Halide plugin.

=== added file 'debian/copyright'
--- debian/copyright	1970-01-01 00:00:00 +0000
+++ debian/copyright	2015-04-08 16:28:17 +0000
@@ -0,0 +1,41 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+Files: *
+Copyright: 2015 Canonical Ltd.
+License: LGPL-3
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; version 3.
+
+ This program 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 Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Files: */GenGen.cpp
+Copyright: 2012-2014 MIT CSAIL, Google Inc., and other contributors
+Copyright: 2015 Canonical Ltd.
+License: Expat
+ Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ "Software"), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+
+ The above copyright notice and this permission notice shall be included
+ in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

=== added file 'debian/qt-halide-sampleapp.install'
--- debian/qt-halide-sampleapp.install	1970-01-01 00:00:00 +0000
+++ debian/qt-halide-sampleapp.install	2015-04-08 16:28:17 +0000
@@ -0,0 +1,4 @@
+usr/bin/qt-halide-sampleapp
+usr/share/qt-halide-sampleapp/*.qml
+usr/share/qt-halide-sampleapp/*.png
+usr/share/qt-halide-sampleapp/*.jpg

=== added file 'debian/qt-halide-sampleapp.lintian-overrides'
--- debian/qt-halide-sampleapp.lintian-overrides	1970-01-01 00:00:00 +0000
+++ debian/qt-halide-sampleapp.lintian-overrides	2015-04-08 16:28:17 +0000
@@ -0,0 +1,1 @@
+qt-halide-sampleapp: binary-without-manpage

=== added file 'debian/qtdeclarative5-halide-plugin0.1.install'
--- debian/qtdeclarative5-halide-plugin0.1.install	1970-01-01 00:00:00 +0000
+++ debian/qtdeclarative5-halide-plugin0.1.install	2015-04-08 16:28:17 +0000
@@ -0,0 +1,1 @@
+usr/lib/*/qt5/qml/QtHalide/*

=== added file 'debian/qtdeclarative5-halide-plugin0.1.lintian-overrides'
--- debian/qtdeclarative5-halide-plugin0.1.lintian-overrides	1970-01-01 00:00:00 +0000
+++ debian/qtdeclarative5-halide-plugin0.1.lintian-overrides	2015-04-08 16:28:17 +0000
@@ -0,0 +1,3 @@
+qtdeclarative5-halide-plugin: pkg-has-shlibs-control-file-but-no-actual-shared-libs
+qtdeclarative5-halide-plugin: postinst-has-useless-call-to-ldconfig
+qtdeclarative5-halide-plugin: postrm-has-useless-call-to-ldconfig

=== added file 'debian/rules'
--- debian/rules	1970-01-01 00:00:00 +0000
+++ debian/rules	2015-04-08 16:28:17 +0000
@@ -0,0 +1,13 @@
+#!/usr/bin/make -f
+# -*- makefile -*-
+
+# Uncomment this to turn on verbose mode.
+# export DH_VERBOSE=1
+
+%:
+	dh $@ --parallel
+
+override_dh_install:
+	dh_install --fail-missing
+
+override_dh_auto_test:

=== added directory 'debian/source'
=== added file 'debian/source/format'
--- debian/source/format	1970-01-01 00:00:00 +0000
+++ debian/source/format	2015-04-08 16:28:17 +0000
@@ -0,0 +1,1 @@
+1.0

=== modified file 'examples/sampleapp/CMakeLists.txt'
--- examples/sampleapp/CMakeLists.txt	2015-04-02 16:23:28 +0000
+++ examples/sampleapp/CMakeLists.txt	2015-04-08 16:28:17 +0000
@@ -2,10 +2,14 @@
 find_package(Threads)
 
 include_directories(
+    ${CMAKE_CURRENT_BINARY_DIR}
     ${CMAKE_CURRENT_SOURCE_DIR}/../../src/QtHalide
     ${HALIDE_INCLUDE_DIRS}
 )
 
+set(QT_HALIDE_SAMPLE_DIR ${CMAKE_INSTALL_DATADIR}/qt-halide-sampleapp/)
+configure_file(config.h.in ${CMAKE_CURRENT_BINARY_DIR}/config.h @ONLY)
+
 set(SAMPLEAPP_SOURCES
     sampleapp.cpp
 
@@ -17,19 +21,19 @@
     generator_auto_enhance.cpp
 )
 
-add_executable(sampleapp ${SAMPLEAPP_SOURCES})
-add_dependencies(sampleapp qthalide-qml)
-add_dependencies(sampleapp sampleapp-qmlfiles)
+add_executable(qt-halide-sampleapp ${SAMPLEAPP_SOURCES})
+add_dependencies(qt-halide-sampleapp qthalide-qml)
+add_dependencies(qt-halide-sampleapp sampleapp-qmlfiles)
 
-compile_generators(${CMAKE_CURRENT_SOURCE_DIR} sampleapp)
-qt5_use_modules(sampleapp Gui Qml Quick Concurrent)
-target_link_libraries(sampleapp
+compile_generators(${CMAKE_CURRENT_SOURCE_DIR} qt-halide-sampleapp)
+qt5_use_modules(qt-halide-sampleapp Gui Qml Quick Concurrent)
+target_link_libraries(qt-halide-sampleapp
     ${HALIDE_LIBRARIES}
-    ${sampleapp_GENERATORS_OBJECTS}
+    ${qt-halide-sampleapp_GENERATORS_OBJECTS}
     ${CMAKE_THREAD_LIBS_INIT}
 )
 
-file(GLOB ASSETS_FILES *.qml *.js *.png *.jpg)
+file(GLOB ASSETS_FILES *.qml *.png *.jpg)
 
 # Copy assets files to the build directory
 add_custom_target(sampleapp-qmlfiles
@@ -41,3 +45,7 @@
 add_custom_target(sampleapp-qmlfiles-ide ALL
     SOURCES ${ASSETS_FILES}
 )
+
+# Install app
+install(TARGETS qt-halide-sampleapp RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+install(FILES ${ASSETS_FILES} DESTINATION ${QT_HALIDE_SAMPLE_DIR}/)

=== added file 'examples/sampleapp/config.h.in'
--- examples/sampleapp/config.h.in	1970-01-01 00:00:00 +0000
+++ examples/sampleapp/config.h.in	2015-04-08 16:28:17 +0000
@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+// Qt
+#include <QtCore/QCoreApplication>
+#include <QtCore/QDir>
+
+inline bool isRunningInstalled() {
+    static bool installed = (QCoreApplication::applicationDirPath() ==
+                             QDir(("@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_BINDIR@")).canonicalPath());
+    return installed;
+}
+
+inline QString sampleAppImportDirectory() {
+    if (isRunningInstalled()) {
+        return QString("@CMAKE_INSTALL_PREFIX@/@QT_HALIDE_SAMPLE_DIR@/");
+    } else {
+        return QString("@CMAKE_BINARY_DIR@/src");
+    }
+}
+
+inline QString sampleAppSourceQml() {
+    static QString qmlFile("sampleapp.qml");
+    if (isRunningInstalled()) {
+        return QString("@CMAKE_INSTALL_PREFIX@/@QT_HALIDE_SAMPLE_DIR@/") + qmlFile;
+    } else {
+        return QString("@CMAKE_BINARY_DIR@/examples/sampleapp/") + qmlFile;
+    }
+}

=== modified file 'examples/sampleapp/sampleapp.cpp'
--- examples/sampleapp/sampleapp.cpp	2015-04-02 15:52:34 +0000
+++ examples/sampleapp/sampleapp.cpp	2015-04-08 16:28:17 +0000
@@ -1,13 +1,15 @@
 #include <QtGui/QGuiApplication>
 #include <QtQml/QQmlEngine>
 #include <QtQuick/QQuickView>
+#include <QtCore/QDebug>
+#include "config.h"
 
 int main(int argc, char *argv[]) {
     QGuiApplication app(argc, argv);
     QQuickView view;
-    // FIXME: hack retrieval of path
-    view.engine()->addImportPath("../../src");
-    view.setSource(QUrl::fromLocalFile("sampleapp.qml"));
+
+    view.engine()->addImportPath(sampleAppImportDirectory());
+    view.setSource(QUrl::fromLocalFile(sampleAppSourceQml()));
     view.show();
     return app.exec();
 }

=== modified file 'src/QtHalide/CMakeLists.txt'
--- src/QtHalide/CMakeLists.txt	2015-04-06 10:45:45 +0000
+++ src/QtHalide/CMakeLists.txt	2015-04-08 16:28:17 +0000
@@ -3,6 +3,17 @@
     ${HALIDE_INCLUDE_DIRS}
 )
 
+# Qt5's cmake does not export QT_IMPORTS_DIR, lets query qmake on our own for now
+get_target_property(QMAKE_EXECUTABLE Qt5::qmake LOCATION)
+function(QUERY_QMAKE VAR RESULT)
+  exec_program(${QMAKE_EXECUTABLE} ARGS "-query ${VAR}" RETURN_VALUE return_code OUTPUT_VARIABLE output )
+  if(NOT return_code)
+    file(TO_CMAKE_PATH "${output}" output)
+    set(${RESULT} ${output} PARENT_SCOPE)
+  endif(NOT return_code)
+endfunction(QUERY_QMAKE)
+query_qmake(QT_INSTALL_QML QT_IMPORTS_DIR)
+
 # Make the files visible on qtcreator
 add_custom_target(QtHalide_OtherFiles ALL SOURCES
                   halide_generators_common.h

=== modified file 'src/QtHalide/halide_function.cpp'
--- src/QtHalide/halide_function.cpp	2015-04-02 11:21:00 +0000
+++ src/QtHalide/halide_function.cpp	2015-04-08 16:28:17 +0000
@@ -93,6 +93,8 @@
     return qmlType;
 }
 
+// FIXME: On architectures that are not 64 bits Halide::type_of<long> fails to
+// compile, therefore it has been disabled for now.
 Halide::Type qMetaTypeToHalideType(int qMetaType)
 {
     switch (qMetaType) {
@@ -109,9 +111,11 @@
     case QMetaType::Short:
         return Halide::type_of<short>();
         break;
+#if __WORDSIZE == 64
     case QMetaType::Long:
         return Halide::type_of<long>();
         break;
+#endif
     case QMetaType::LongLong:
         return Halide::type_of<int64_t>();
         break;
@@ -124,9 +128,11 @@
     case QMetaType::UShort:
         return Halide::type_of<unsigned short>();
         break;
+#if __WORDSIZE == 64
     case QMetaType::ULong:
         return Halide::type_of<unsigned long>();
         break;
+#endif
     case QMetaType::ULongLong:
         return Halide::type_of<uint64_t>();
         break;