wscript

   1 #
   2 #    Copyright (C) 2012-2020 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]
  44 last_version = subprocess.Popen(shlex.split('git describe --tags --abbrev=0'), stdout=subprocess.PIPE).communicate()[0]
  45
  46 if this_version == '':
  47     VERSION = '%sdevel' % last_version[1:].strip()
  48 else:
  49     VERSION = this_version[1:].strip()
  50
  51 API_VERSION = '-1.0'
  52
  53 def options(opt):
  54     opt.load('compiler_cxx')
  55     opt.add_option('--target-windows', action='store_true', default=False, help='set up to do a cross-compile to Windows')
  56     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
  57     opt.add_option('--static', action='store_true', default=False, help='build libdcp statically, and link statically to openjpeg, cxml, asdcplib-carl')
  58     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
  59     opt.add_option('--disable-benchmarks', action='store_true', default=False, help='disable building of benchmarks')
  60     opt.add_option('--disable-gcov', action='store_true', default=False, help='don''t use gcov in tests')
  61     opt.add_option('--disable-examples', action='store_true', default=False, help='disable building of examples')
  62     opt.add_option('--enable-openmp', action='store_true', default=False, help='enable use of OpenMP')
  63     opt.add_option('--openmp', default='gomp', help='specify OpenMP Library to use: omp, gomp (default), iomp')
  64     opt.add_option('--jpeg', default='oj2', help='specify JPEG library to build with: oj1 or oj2 for OpenJPEG 1.5.x or OpenJPEG 2.1.x respectively')
  65
  66 def configure(conf):
  67     conf.load('compiler_cxx')
  68     conf.load('clang_compilation_database', tooldir=['waf-tools'])
  69     conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS', '-std=c++11'])
  70     gcc = conf.env['CC_VERSION']
  71     if int(gcc[0]) >= 4 and int(gcc[1]) > 1:
  72         conf.env.append_value('CXXFLAGS', ['-Wno-maybe-uninitialized'])
  73     conf.env.append_value('CXXFLAGS', ['-DLIBDCP_VERSION="%s"' % VERSION])
  74
  75     conf.env.TARGET_WINDOWS = conf.options.target_windows
  76     conf.env.TARGET_OSX = sys.platform == 'darwin'
  77     conf.env.TARGET_LINUX = not conf.env.TARGET_WINDOWS and not conf.env.TARGET_OSX
  78     conf.env.ENABLE_DEBUG = conf.options.enable_debug
  79     conf.env.DISABLE_TESTS = conf.options.disable_tests
  80     conf.env.DISABLE_BENCHMARKS = conf.options.disable_benchmarks
  81     conf.env.DISABLE_EXAMPLES = conf.options.disable_examples
  82     conf.env.STATIC = conf.options.static
  83     conf.env.API_VERSION = API_VERSION
  84
  85     if conf.env.TARGET_WINDOWS:
  86         conf.env.append_value('CXXFLAGS', '-DLIBDCP_WINDOWS')
  87     if conf.env.TARGET_OSX:
  88         conf.env.append_value('CXXFLAGS', '-DLIBDCP_OSX')
  89     if conf.env.TARGET_LINUX:
  90         conf.env.append_value('CXXFLAGS', '-DLIBDCP_LINUX')
  91
  92     if conf.env.TARGET_OSX:
  93         conf.env.append_value('CXXFLAGS', ['-Wno-unused-result', '-Wno-unused-parameter', '-Wno-unused-local-typedef'])
  94         conf.env.append_value('LINKFLAGS', '-headerpad_max_install_names')
  95     else:
  96         conf.env.append_value('CXXFLAGS', ['-Wsuggest-override'])
  97
  98     # Disable libxml++ deprecation warnings for now
  99     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
 100
 101     if conf.options.enable_openmp:
 102         conf.env.append_value('CXXFLAGS', ['-fopenmp', '-DLIBDCP_OPENMP'])
 103         conf.env.LIB_OPENMP = [conf.options.openmp]
 104         conf.env.append_value('LDFLAGS', ['-l%s' % conf.options.openmp])
 105         conf.check_cxx(cxxflags='-fopenmp', msg='Checking that compiler supports -fopenmp')
 106
 107     if not conf.env.TARGET_WINDOWS:
 108         conf.env.append_value('LINKFLAGS', '-pthread')
 109
 110     if conf.env.TARGET_LINUX:
 111         conf.check(lib='dl', uselib_store='DL', msg='Checking for library dl')
 112
 113     if conf.options.jpeg == 'oj1':
 114         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG1'])
 115     elif conf.options.jpeg == 'oj2':
 116         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG2'])
 117     else:
 118         Logs.error('Invalid --jpeg value %s' % conf.options.jpeg)
 119
 120     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
 121     conf.check_cfg(package='libxml++-2.6', args='--cflags --libs', uselib_store='LIBXML++', mandatory=True)
 122     conf.check_cfg(package='xmlsec1', args='--cflags --libs', uselib_store='XMLSEC1', mandatory=True)
 123     # Remove erroneous escaping of quotes from xmlsec1 defines
 124     conf.env.DEFINES_XMLSEC1 = [f.replace('\\', '') for f in conf.env.DEFINES_XMLSEC1]
 125
 126     # ImageMagick / GraphicsMagick
 127     if distutils.spawn.find_executable('Magick++-config'):
 128         conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True, msg='Checking for ImageMagick/GraphicsMagick')
 129     else:
 130         image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 131         graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 132         if image is None and graphics is None:
 133             Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required')
 134
 135     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=False)
 136
 137     if conf.options.static:
 138         if conf.options.jpeg == 'oj2':
 139             conf.check_cfg(package='libopenjp2', args='--cflags', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 140             conf.env.STLIB_OPENJPEG = ['openjp2']
 141         elif conf.options.jpeg == 'oj1':
 142             conf.check_cfg(package='libopenjpeg1', args='--cflags', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 143             conf.env.STLIB_OPENJPEG = ['openjpeg']
 144         conf.check_cfg(package='libasdcp-carl', atleast_version='0.1.3', args='--cflags', uselib_store='ASDCPLIB_CTH', mandatory=True)
 145         conf.env.HAVE_ASDCPLIB_CTH = 1
 146         conf.env.STLIB_ASDCPLIB_CTH = ['asdcp-carl', 'kumu-carl']
 147         conf.env.HAVE_CXML = 1
 148         conf.env.LIB_CXML = ['xml++-2.6', 'glibmm-2.4']
 149         conf.env.STLIB_CXML = ['cxml']
 150         conf.check_cfg(package='xerces-c', args='--cflags', uselib_store='XERCES', mandatory=True)
 151         conf.env.LIB_XERCES = ['xerces-c', 'icuuc', 'curl']
 152     else:
 153         if conf.options.jpeg == 'oj2':
 154             conf.check_cfg(package='libopenjp2', args='--cflags --libs', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 155         elif conf.options.jpeg == 'oj1':
 156             conf.check_cfg(package='libopenjpeg1', args='--cflags --libs', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 157         conf.check_cfg(package='libasdcp-carl', atleast_version='0.1.3', args='--cflags --libs', uselib_store='ASDCPLIB_CTH', mandatory=True)
 158         conf.check_cfg(package='libcxml', atleast_version='0.17.0', args='--cflags --libs', uselib_store='CXML', mandatory=True)
 159         conf.check_cfg(package='xerces-c', args='--cflags --libs', uselib_store='XERCES', mandatory=True)
 160
 161     if conf.options.target_windows:
 162         # XXX: it feels like there should be a more elegant way to get these included
 163         conf.env.LIB_XERCES.append('curl')
 164         conf.env.LIB_XERCES.append('ws2_32')
 165
 166     if conf.options.target_windows:
 167         boost_lib_suffix = '-mt'
 168     else:
 169         boost_lib_suffix = ''
 170
 171     if conf.options.enable_debug:
 172         conf.env.append_value('CXXFLAGS', '-g')
 173     else:
 174         # Somewhat experimental use of -O2 rather than -O3 to see if
 175         # Windows builds are any more reliable
 176         conf.env.append_value('CXXFLAGS', '-O2')
 177
 178     # We support older boosts on Linux so we can use the distribution-provided package
 179     # on Centos 7, but it's good if we can use 1.61 for boost::dll::program_location()
 180     boost_version = ('1.45', '104500') if conf.env.TARGET_LINUX else ('1.61', '106800')
 181
 182     conf.check_cxx(fragment="""
 183                             #include <boost/version.hpp>\n
 184                             #if BOOST_VERSION < %s\n
 185                             #error boost too old\n
 186                             #endif\n
 187                             int main(void) { return 0; }\n
 188                             """ % boost_version[1],
 189                    mandatory=True,
 190                    msg='Checking for boost library >= %s' % boost_version[0],
 191                    okmsg='yes',
 192                    errmsg='too old\nPlease install boost version %s or higher.' % boost_version[0])
 193
 194     conf.check_cxx(fragment="""
 195                             #include <boost/filesystem.hpp>\n
 196                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
 197                             """,
 198                    msg='Checking for boost filesystem library',
 199                    libpath='/usr/local/lib',
 200                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 201                    uselib_store='BOOST_FILESYSTEM')
 202
 203     conf.check_cxx(fragment="""
 204                             #include <boost/signals2.hpp>\n
 205                             int main() { boost::signals2::signal<void (int)> x; }\n
 206                             """,
 207                    msg='Checking for boost signals2 library',
 208                    uselib_store='BOOST_SIGNALS2')
 209
 210     conf.check_cxx(fragment="""
 211                             #include <boost/date_time.hpp>\n
 212                             int main() { boost::gregorian::day_clock::local_day(); }\n
 213                             """,
 214                    msg='Checking for boost datetime library',
 215                    libpath='/usr/local/lib',
 216                    lib=['boost_date_time%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 217                    uselib_store='BOOST_DATETIME')
 218
 219     if not conf.env.DISABLE_TESTS:
 220         conf.recurse('test')
 221         if not conf.options.disable_gcov:
 222             conf.check(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
 223             conf.env.append_value('LINKFLAGS', '-fprofile-arcs')
 224
 225 def build(bld):
 226     create_version_cc(bld, VERSION)
 227
 228     if bld.env.TARGET_WINDOWS:
 229         boost_lib_suffix = '-mt'
 230     else:
 231         boost_lib_suffix = ''
 232
 233     libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix)
 234     if bld.env.TARGET_LINUX:
 235         libs += " -ldl"
 236
 237     bld(source='libdcp%s.pc.in' % bld.env.API_VERSION,
 238         version=VERSION,
 239         includedir='%s/include/libdcp%s' % (bld.env.PREFIX, bld.env.API_VERSION),
 240         libs=libs,
 241         install_path='${LIBDIR}/pkgconfig')
 242
 243     bld.recurse('src')
 244     bld.recurse('tools')
 245     if not bld.env.DISABLE_TESTS:
 246         bld.recurse('test')
 247     if not bld.env.DISABLE_EXAMPLES:
 248         bld.recurse('examples')
 249     if not bld.env.DISABLE_BENCHMARKS:
 250         bld.recurse('benchmark')
 251
 252     for i in os.listdir('xsd'):
 253         bld.install_files('${PREFIX}/share/libdcp/xsd', os.path.join('xsd', i))
 254
 255     for i in ['language', 'region', 'script', 'variant', 'extlang', 'dcnc']:
 256         bld.install_files('${PREFIX}/share/libdcp/tags', os.path.join('tags', i))
 257
 258     bld.add_post_fun(post)
 259
 260 def dist(ctx):
 261     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
 262
 263 def create_version_cc(bld, version):
 264     if os.path.exists('.git'):
 265         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
 266         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
 267         o = output[0].decode('utf-8')
 268         commit = o.replace ("commit ", "")[0:10]
 269     else:
 270         commit = "release"
 271
 272     try:
 273         text =  '#include "version.h"\n'
 274         text += 'char const * dcp::git_commit = \"%s\";\n' % commit
 275         text += 'char const * dcp::version = \"%s\";\n' % version
 276         if bld.env.ENABLE_DEBUG:
 277             debug_string = 'true'
 278         else:
 279             debug_string = 'false'
 280         text += 'bool const dcp::built_with_debug = %s;\n' % debug_string
 281         print('Writing version information to src/version.cc')
 282         o = open('src/version.cc', 'w')
 283         o.write(text)
 284         o.close()
 285     except IOError:
 286         print('Could not open src/version.cc for writing\n')
 287         sys.exit(-1)
 288
 289 def post(ctx):
 290     if ctx.cmd == 'install':
 291         ctx.exec_command('/sbin/ldconfig')
 292
 293 def tags(bld):
 294     os.system('etags src/*.cc src/*.h')