wscript

   1 #
   2 #    Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
   3 #
   4 #    This file is part of libdcp.
   5 #
   6 #    libdcp is free software; you can redistribute it and/or modify
   7 #    it under the terms of the GNU General Public License as published by
   8 #    the Free Software Foundation; either version 2 of the License, or
   9 #    (at your option) any later version.
  10 #
  11 #    libdcp is distributed in the hope that it will be useful,
  12 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #    GNU General Public License for more details.
  15 #
  16 #    You should have received a copy of the GNU General Public License
  17 #    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19 #    In addition, as a special exception, the copyright holders give
  20 #    permission to link the code of portions of this program with the
  21 #    OpenSSL library under certain conditions as described in each
  22 #    individual source file, and distribute linked combinations
  23 #    including the two.
  24 #
  25 #    You must obey the GNU General Public License in all respects
  26 #    for all of the code used other than OpenSSL.  If you modify
  27 #    file(s) with this exception, you may extend this exception to your
  28 #    version of the file(s), but you are not obligated to do so.  If you
  29 #    do not wish to do so, delete this exception statement from your
  30 #    version.  If you delete this exception statement from all source
  31 #    files in the program, then also delete it here.
  32 #
  33
  34 import subprocess
  35 import os
  36 import sys
  37 import shlex
  38 import distutils.spawn
  39 from waflib import Logs, Context
  40
  41 APPNAME = 'libdcp'
  42
  43 this_version = subprocess.Popen(shlex.split('git tag -l --points-at HEAD'), stdout=subprocess.PIPE).communicate()[0].decode('UTF-8')
  44 last_version = subprocess.Popen(shlex.split('git describe --tags --abbrev=0'), stdout=subprocess.PIPE).communicate()[0].decode('UTF-8')
  45
  46 if this_version == '':
  47     VERSION = '%sdevel' % last_version[1:].strip()
  48 else:
  49     VERSION = this_version[1:].strip()
  50
  51 if sys.version_info.major == 2:
  52     # Handle Python 2 (for Ubuntu 16.04)
  53     VERSION = VERSION.encode('UTF-8')
  54
  55 API_VERSION = '-1.0'
  56
  57 def options(opt):
  58     opt.load('compiler_cxx')
  59     opt.add_option('--target-windows-64', action='store_true', default=False, help='set up to do a cross-compile to Windows 64-bit')
  60     opt.add_option('--target-windows-32', action='store_true', default=False, help='set up to do a cross-compile to Windows 32-bit')
  61     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
  62     opt.add_option('--static', action='store_true', default=False, help='build libdcp statically, and link statically to openjpeg, cxml, asdcplib-dcpomatic')
  63     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
  64     opt.add_option('--disable-benchmarks', action='store_true', default=False, help='disable building of benchmarks')
  65     opt.add_option('--enable-gcov', action='store_true', default=False, help='use gcov in tests')
  66     opt.add_option('--disable-examples', action='store_true', default=False, help='disable building of examples')
  67     opt.add_option('--disable-dumpimage', action='store_true', default=False, help='disable building of dcpdumpimage')
  68     opt.add_option('--enable-openmp', action='store_true', default=False, help='enable use of OpenMP')
  69     opt.add_option('--openmp', default='gomp', help='specify OpenMP Library to use: omp, gomp (default), iomp')
  70     opt.add_option('--c++17', action='store_true', default=False, help='build with C++17 and libxml++-4.0')
  71
  72 def configure(conf):
  73     conf.load('compiler_cxx')
  74     conf.load('clang_compilation_database', tooldir=['waf-tools'])
  75
  76     if vars(conf.options)['c++17']:
  77         cpp_std = '17'
  78         conf.env.XMLPP_API = '4.0'
  79     else:
  80         cpp_std = '11'
  81         conf.env.XMLPP_API = '2.6'
  82
  83     conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS', '-std=c++' + cpp_std])
  84     gcc = conf.env['CC_VERSION']
  85     if int(gcc[0]) >= 4 and int(gcc[1]) > 1:
  86         conf.env.append_value('CXXFLAGS', ['-Wno-maybe-uninitialized'])
  87     conf.env.append_value('CXXFLAGS', ['-DLIBDCP_VERSION="%s"' % VERSION])
  88
  89     conf.env.TARGET_WINDOWS_64 = conf.options.target_windows_64
  90     conf.env.TARGET_WINDOWS_32 = conf.options.target_windows_32
  91     conf.env.TARGET_OSX = sys.platform == 'darwin'
  92     conf.env.TARGET_LINUX = not conf.env.TARGET_WINDOWS and not conf.env.TARGET_OSX
  93     conf.env.ENABLE_DEBUG = conf.options.enable_debug
  94     conf.env.DISABLE_TESTS = conf.options.disable_tests
  95     conf.env.DISABLE_BENCHMARKS = conf.options.disable_benchmarks
  96     conf.env.DISABLE_EXAMPLES = conf.options.disable_examples
  97     conf.env.DISABLE_DUMPIMAGE = conf.options.disable_dumpimage
  98     conf.env.STATIC = conf.options.static
  99     conf.env.API_VERSION = API_VERSION
 100
 101     if conf.env.TARGET_WINDOWS_64 or conf.env.TARGET_WINDOWS_32:
 102         conf.env.append_value('CXXFLAGS', '-DLIBDCP_WINDOWS')
 103     if conf.env.TARGET_OSX:
 104         conf.env.append_value('CXXFLAGS', '-DLIBDCP_OSX')
 105     if conf.env.TARGET_LINUX:
 106         conf.env.append_value('CXXFLAGS', '-DLIBDCP_LINUX')
 107
 108     if conf.env.TARGET_OSX:
 109         conf.env.append_value('CXXFLAGS', ['-Wno-unused-result', '-Wno-unused-parameter', '-Wno-unused-local-typedef'])
 110         conf.env.append_value('LINKFLAGS', '-headerpad_max_install_names')
 111     elif int(gcc[0]) > 4:
 112         conf.env.append_value('CXXFLAGS', ['-Wsuggest-override'])
 113
 114     # Disable libxml++ deprecation warnings for now
 115     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
 116
 117     if conf.options.enable_openmp:
 118         conf.env.append_value('CXXFLAGS', ['-fopenmp', '-DLIBDCP_OPENMP'])
 119         conf.env.LIB_OPENMP = [conf.options.openmp]
 120         conf.env.append_value('LDFLAGS', ['-l%s' % conf.options.openmp])
 121         conf.check_cxx(cxxflags='-fopenmp', msg='Checking that compiler supports -fopenmp')
 122
 123     if not conf.env.TARGET_WINDOWS_64 and not conf.env.TARGET_WINDOWS_32:
 124         conf.env.append_value('LINKFLAGS', '-pthread')
 125
 126     if conf.env.TARGET_LINUX:
 127         conf.check(lib='dl', uselib_store='DL', msg='Checking for library dl')
 128
 129     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
 130     conf.check_cfg(package='libxml++-' + conf.env.XMLPP_API, args='--cflags --libs', uselib_store='LIBXML++', mandatory=True)
 131     conf.check_cfg(package='xmlsec1', args='--cflags --libs', uselib_store='XMLSEC1', mandatory=True)
 132     # Remove erroneous escaping of quotes from xmlsec1 defines
 133     conf.env.DEFINES_XMLSEC1 = [f.replace('\\', '') for f in conf.env.DEFINES_XMLSEC1]
 134
 135     # ImageMagick / GraphicsMagick
 136     if (not conf.options.disable_examples) and (not conf.options.disable_dumpimage):
 137         if distutils.spawn.find_executable('Magick++-config'):
 138             conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True, msg='Checking for ImageMagick/GraphicsMagick')
 139         else:
 140             image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 141             graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 142             if image is None and graphics is None:
 143                 Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required unless you ./waf configure --disable-examples --disable-dumpimage')
 144                 sys.exit(1)
 145
 146     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=False)
 147
 148     # Find openjpeg so that we can test to see if it's the right version
 149     if conf.options.static:
 150         conf.check_cfg(package='libopenjp2', args='--cflags', uselib_store='OPENJPEG', mandatory=True, msg='Checking for any version of libopenjp2')
 151     else:
 152         conf.check_cfg(package='libopenjp2', args='--cflags --libs', uselib_store='OPENJPEG', mandatory=True, msg='Checking for any version of libopenjp2')
 153
 154     patched_openjpeg = conf.check_cxx(fragment="""
 155                    #include <openjpeg.h>
 156                    int main() { opj_cparameters_t p; p.numgbits = 2; }\n
 157                    """,
 158                    msg='Checking for numgbits in opj_cparameters_t',
 159                    use='OPENJPEG',
 160                    mandatory=False,
 161                    define_name='LIBDCP_HAVE_NUMGBITS')
 162
 163     if not patched_openjpeg:
 164         # We don't have our patched version so we need 2.5.0 to get the GUARD_BITS option
 165         conf.check_cfg(package='libopenjp2', args='libopenjp2 >= 2.5.0 --cflags --libs', uselib_store='OPENJPEG', mandatory=True, msg='Checking for libopenjp2 >= 2.5.0')
 166
 167     if conf.options.static:
 168         conf.env.STLIB_OPENJPEG = ['openjp2']
 169         conf.check_cfg(package='libasdcp-dcpomatic', args='libasdcp-dcpomatic >= 0.1.3 --cflags', uselib_store='ASDCPLIB_DCPOMATIC', mandatory=True)
 170         conf.env.HAVE_ASDCPLIB_DCPOMATIC = 1
 171         conf.env.STLIB_ASDCPLIB_DCPOMATIC = ['asdcp-dcpomatic', 'kumu-dcpomatic']
 172         conf.env.HAVE_CXML = 1
 173         conf.env.LIB_CXML = ['xml++-' + conf.env.XMLPP_API, 'glibmm-2.4']
 174         conf.env.STLIB_CXML = ['cxml']
 175         conf.check_cfg(package='xerces-c', args='--cflags', uselib_store='XERCES', mandatory=True)
 176         conf.env.LIB_XERCES = ['xerces-c', 'icuuc', 'curl']
 177     else:
 178         conf.check_cfg(package='libasdcp-dcpomatic', args='libasdcp-dcpomatic >= 0.1.3 --cflags --libs', uselib_store='ASDCPLIB_DCPOMATIC', mandatory=True)
 179         conf.check_cfg(package='libcxml', args='libcxml >= 0.17.0 --cflags --libs', uselib_store='CXML', mandatory=True)
 180         conf.check_cfg(package='xerces-c', args='--cflags --libs', uselib_store='XERCES', mandatory=True)
 181
 182     if conf.env.TARGET_WINDOWS_64 or conf.env.TARGET_WINDOWS_32:
 183         # XXX: it feels like there should be a more elegant way to get these included
 184         conf.env.LIB_XERCES.append('curl')
 185         conf.env.LIB_XERCES.append('ws2_32')
 186
 187     if conf.options.target_windows_64:
 188         boost_lib_suffix = '-mt-x64'
 189     elif conf.options.target_windows_32:
 190         boost_lib_suffix = '-mt-x32'
 191     else:
 192         boost_lib_suffix = ''
 193
 194     if conf.options.enable_debug:
 195         conf.env.append_value('CXXFLAGS', '-g')
 196     else:
 197         # Somewhat experimental use of -O2 rather than -O3 to see if
 198         # Windows builds are any more reliable
 199         conf.env.append_value('CXXFLAGS', '-O2')
 200
 201     # We support older boosts on Linux so we can use the distribution-provided package
 202     # on Centos 7, but it's good if we can use 1.61 for boost::dll::program_location()
 203     boost_version = ('1.45', '104500') if conf.env.TARGET_LINUX else ('1.61', '106800')
 204
 205     conf.check_cxx(fragment="""
 206                             #include <boost/version.hpp>\n
 207                             #if BOOST_VERSION < %s\n
 208                             #error boost too old\n
 209                             #endif\n
 210                             int main(void) { return 0; }\n
 211                             """ % boost_version[1],
 212                    mandatory=True,
 213                    msg='Checking for boost library >= %s' % boost_version[0],
 214                    okmsg='yes',
 215                    errmsg='too old\nPlease install boost version %s or higher.' % boost_version[0])
 216
 217     conf.check_cxx(fragment="""
 218                             #include <boost/filesystem.hpp>\n
 219                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
 220                             """,
 221                    msg='Checking for boost filesystem library',
 222                    libpath='/usr/local/lib',
 223                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 224                    uselib_store='BOOST_FILESYSTEM')
 225
 226     conf.check_cxx(fragment="""
 227                    #include <boost/filesystem.hpp>\n
 228                    int main() { boost::filesystem::weakly_canonical("a/b/c"); }\n
 229                    """,
 230                    mandatory=False,
 231                    msg='Checking for boost::filesystem::weakly_canonical',
 232                    uselib='BOOST_FILESYSTEM',
 233                    define_name='LIBDCP_HAVE_WEAKLY_CANONICAL')
 234
 235     conf.check_cxx(fragment="""
 236                             #include <boost/signals2.hpp>\n
 237                             int main() { boost::signals2::signal<void (int)> x; }\n
 238                             """,
 239                    msg='Checking for boost signals2 library',
 240                    uselib_store='BOOST_SIGNALS2')
 241
 242     conf.check_cxx(fragment="""
 243                             #include <boost/date_time.hpp>\n
 244                             int main() { boost::gregorian::day_clock::local_day(); }\n
 245                             """,
 246                    msg='Checking for boost datetime library',
 247                    libpath='/usr/local/lib',
 248                    lib=['boost_date_time%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 249                    uselib_store='BOOST_DATETIME')
 250
 251     if not conf.env.DISABLE_TESTS:
 252         conf.recurse('test')
 253         if conf.options.enable_gcov:
 254             conf.check(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
 255             conf.env.append_value('LINKFLAGS', '-fprofile-arcs')
 256
 257 def build(bld):
 258     create_version_cc(bld, VERSION)
 259
 260     if bld.env.TARGET_WINDOWS_64:
 261         boost_lib_suffix = '-mt-x64'
 262     elif bld.env.TARGET_WINDOWS_32:
 263         boost_lib_suffix = '-mt-x32'
 264     else:
 265         boost_lib_suffix = ''
 266
 267     libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix)
 268     if bld.env.TARGET_LINUX:
 269         libs += " -ldl"
 270
 271     bld(source='libdcp%s.pc.in' % bld.env.API_VERSION,
 272         version=VERSION,
 273         includedir='%s/include/libdcp%s' % (bld.env.PREFIX, bld.env.API_VERSION),
 274         libs=libs,
 275         install_path='${LIBDIR}/pkgconfig',
 276         xmlpp_api=bld.env.XMLPP_ABI)
 277
 278     bld.recurse('src')
 279     bld.recurse('tools')
 280     if not bld.env.DISABLE_TESTS:
 281         bld.recurse('test')
 282     if not bld.env.DISABLE_EXAMPLES:
 283         bld.recurse('examples')
 284     if not bld.env.DISABLE_BENCHMARKS:
 285         bld.recurse('benchmark')
 286
 287     for i in os.listdir('xsd'):
 288         bld.install_files('${PREFIX}/share/libdcp/xsd', os.path.join('xsd', i))
 289
 290     for i in ['language', 'region', 'script', 'variant', 'extlang', 'dcnc']:
 291         bld.install_files('${PREFIX}/share/libdcp/tags', os.path.join('tags', i))
 292
 293     bld.install_files('${PREFIX}/share/libdcp', 'ratings')
 294
 295     bld.add_post_fun(post)
 296
 297 def dist(ctx):
 298     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
 299
 300 def create_version_cc(bld, version):
 301     if os.path.exists('.git'):
 302         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
 303         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
 304         o = output[0].decode('utf-8')
 305         commit = o.replace ("commit ", "")[0:10]
 306     else:
 307         commit = "release"
 308
 309     try:
 310         text =  '#include "version.h"\n'
 311         text += 'char const * dcp::git_commit = \"%s\";\n' % commit
 312         text += 'char const * dcp::version = \"%s\";\n' % version
 313         if bld.env.ENABLE_DEBUG:
 314             debug_string = 'true'
 315         else:
 316             debug_string = 'false'
 317         text += 'bool const dcp::built_with_debug = %s;\n' % debug_string
 318         print('Writing version information to src/version.cc')
 319         o = open('src/version.cc', 'w')
 320         o.write(text)
 321         o.close()
 322     except IOError:
 323         print('Could not open src/version.cc for writing\n')
 324         sys.exit(-1)
 325
 326 def post(ctx):
 327     if ctx.cmd == 'install':
 328         ctx.exec_command('/sbin/ldconfig')
 329
 330 def tags(bld):
 331     os.system('etags src/*.cc src/*.h')