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     conf.env.append_value('CXXFLAGS', ['-DLIBDCP_SHARE_PREFIX="%s/share/libdcp"' % conf.env['PREFIX']])
  75
  76     conf.env.TARGET_WINDOWS = conf.options.target_windows
  77     conf.env.TARGET_OSX = sys.platform == 'darwin'
  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.options.target_windows:
  86         conf.env.append_value('CXXFLAGS', '-DLIBDCP_WINDOWS')
  87     else:
  88         conf.env.append_value('CXXFLAGS', '-DLIBDCP_POSIX')
  89
  90     if conf.env.TARGET_OSX:
  91         conf.env.append_value('CXXFLAGS', ['-Wno-unused-result', '-Wno-unused-parameter', '-Wno-unused-local-typedef'])
  92
  93     # Disable libxml++ deprecation warnings for now
  94     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
  95
  96     if conf.options.enable_openmp:
  97         conf.env.append_value('CXXFLAGS', ['-fopenmp', '-DLIBDCP_OPENMP'])
  98         conf.env.LIB_OPENMP = [conf.options.openmp]
  99         conf.env.append_value('LDFLAGS', ['-l%s' % conf.options.openmp])
 100         conf.check_cxx(cxxflags='-fopenmp', msg='Checking that compiler supports -fopenmp')
 101
 102     if not conf.env.TARGET_WINDOWS:
 103         conf.env.append_value('LINKFLAGS', '-pthread')
 104
 105     if conf.options.jpeg == 'oj1':
 106         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG1'])
 107     elif conf.options.jpeg == 'oj2':
 108         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG2'])
 109     else:
 110         Logs.error('Invalid --jpeg value %s' % conf.options.jpeg)
 111
 112     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
 113     conf.check_cfg(package='libxml++-2.6', args='--cflags --libs', uselib_store='LIBXML++', mandatory=True)
 114     conf.check_cfg(package='xmlsec1', args='--cflags --libs', uselib_store='XMLSEC1', mandatory=True)
 115     # Remove erroneous escaping of quotes from xmlsec1 defines
 116     conf.env.DEFINES_XMLSEC1 = [f.replace('\\', '') for f in conf.env.DEFINES_XMLSEC1]
 117
 118     # ImageMagick / GraphicsMagick
 119     if distutils.spawn.find_executable('Magick++-config'):
 120         conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True, msg='Checking for ImageMagick/GraphicsMagick')
 121     else:
 122         image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 123         graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 124         if image is None and graphics is None:
 125             Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required')
 126
 127     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=False)
 128
 129     if conf.options.static:
 130         if conf.options.jpeg == 'oj2':
 131             conf.check_cfg(package='libopenjp2', args='--cflags', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 132             conf.env.STLIB_OPENJPEG = ['openjp2']
 133         elif conf.options.jpeg == 'oj1':
 134             conf.check_cfg(package='libopenjpeg1', args='--cflags', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 135             conf.env.STLIB_OPENJPEG = ['openjpeg']
 136         conf.check_cfg(package='libasdcp-carl', atleast_version='0.1.3', args='--cflags', uselib_store='ASDCPLIB_CTH', mandatory=True)
 137         conf.env.HAVE_ASDCPLIB_CTH = 1
 138         conf.env.STLIB_ASDCPLIB_CTH = ['asdcp-carl', 'kumu-carl']
 139         conf.env.HAVE_CXML = 1
 140         conf.env.LIB_CXML = ['xml++-2.6', 'glibmm-2.4']
 141         conf.env.STLIB_CXML = ['cxml']
 142         conf.check_cfg(package='xerces-c', args='--cflags', uselib_store='XERCES', mandatory=True)
 143         conf.env.LIB_XERCES = ['xerces-c', 'icuuc', 'curl']
 144     else:
 145         if conf.options.jpeg == 'oj2':
 146             conf.check_cfg(package='libopenjp2', args='--cflags --libs', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 147         elif conf.options.jpeg == 'oj1':
 148             conf.check_cfg(package='libopenjpeg1', args='--cflags --libs', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 149         conf.check_cfg(package='libasdcp-carl', atleast_version='0.1.3', args='--cflags --libs', uselib_store='ASDCPLIB_CTH', mandatory=True)
 150         conf.check_cfg(package='libcxml', atleast_version='0.17.0', args='--cflags --libs', uselib_store='CXML', mandatory=True)
 151         conf.check_cfg(package='xerces-c', args='--cflags --libs', uselib_store='XERCES', mandatory=True)
 152
 153     if conf.options.target_windows:
 154         # XXX: it feels like there should be a more elegant way to get these included
 155         conf.env.LIB_XERCES.append('curl')
 156         conf.env.LIB_XERCES.append('ws2_32')
 157
 158     if conf.options.target_windows:
 159         boost_lib_suffix = '-mt'
 160     else:
 161         boost_lib_suffix = ''
 162
 163     if conf.options.enable_debug:
 164         conf.env.append_value('CXXFLAGS', '-g')
 165     else:
 166         # Somewhat experimental use of -O2 rather than -O3 to see if
 167         # Windows builds are any more reliable
 168         conf.env.append_value('CXXFLAGS', '-O2')
 169
 170     conf.check_cxx(fragment="""
 171                             #include <boost/version.hpp>\n
 172                             #if BOOST_VERSION < 104500\n
 173                             #error boost too old\n
 174                             #endif\n
 175                             int main(void) { return 0; }\n
 176                             """,
 177                    mandatory=True,
 178                    msg='Checking for boost library >= 1.45',
 179                    okmsg='yes',
 180                    errmsg='too old\nPlease install boost version 1.45 or higher.')
 181
 182     conf.check_cxx(fragment="""
 183                             #include <boost/filesystem.hpp>\n
 184                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
 185                             """,
 186                    msg='Checking for boost filesystem library',
 187                    libpath='/usr/local/lib',
 188                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 189                    uselib_store='BOOST_FILESYSTEM')
 190
 191     conf.check_cxx(fragment="""
 192                             #include <boost/signals2.hpp>\n
 193                             int main() { boost::signals2::signal<void (int)> x; }\n
 194                             """,
 195                    msg='Checking for boost signals2 library',
 196                    uselib_store='BOOST_SIGNALS2')
 197
 198     conf.check_cxx(fragment="""
 199                             #include <boost/date_time.hpp>\n
 200                             int main() { boost::gregorian::day_clock::local_day(); }\n
 201                             """,
 202                    msg='Checking for boost datetime library',
 203                    libpath='/usr/local/lib',
 204                    lib=['boost_date_time%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 205                    uselib_store='BOOST_DATETIME')
 206
 207     if not conf.env.DISABLE_TESTS:
 208         conf.recurse('test')
 209         if not conf.options.disable_gcov:
 210             conf.check(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
 211             conf.env.append_value('LINKFLAGS', '-fprofile-arcs')
 212
 213 def build(bld):
 214     create_version_cc(bld, VERSION)
 215
 216     if bld.env.TARGET_WINDOWS:
 217         boost_lib_suffix = '-mt'
 218     else:
 219         boost_lib_suffix = ''
 220
 221     bld(source='libdcp%s.pc.in' % bld.env.API_VERSION,
 222         version=VERSION,
 223         includedir='%s/include/libdcp%s' % (bld.env.PREFIX, bld.env.API_VERSION),
 224         libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix),
 225         install_path='${LIBDIR}/pkgconfig')
 226
 227     bld.recurse('src')
 228     bld.recurse('tools')
 229     if not bld.env.DISABLE_TESTS:
 230         bld.recurse('test')
 231     if not bld.env.DISABLE_EXAMPLES:
 232         bld.recurse('examples')
 233     if not bld.env.DISABLE_BENCHMARKS:
 234         bld.recurse('benchmark')
 235
 236     for i in os.listdir('xsd'):
 237         bld.install_files('${PREFIX}/share/libdcp/xsd', os.path.join('xsd', i))
 238
 239     for i in ['language', 'region', 'script', 'variant', 'extlang']:
 240         bld.install_files('${PREFIX}/share/libdcp/tags', os.path.join('tags', i))
 241
 242     bld.add_post_fun(post)
 243
 244 def dist(ctx):
 245     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
 246
 247 def create_version_cc(bld, version):
 248     if os.path.exists('.git'):
 249         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
 250         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
 251         o = output[0].decode('utf-8')
 252         commit = o.replace ("commit ", "")[0:10]
 253     else:
 254         commit = "release"
 255
 256     try:
 257         text =  '#include "version.h"\n'
 258         text += 'char const * dcp::git_commit = \"%s\";\n' % commit
 259         text += 'char const * dcp::version = \"%s\";\n' % version
 260         if bld.env.ENABLE_DEBUG:
 261             debug_string = 'true'
 262         else:
 263             debug_string = 'false'
 264         text += 'bool const dcp::built_with_debug = %s;\n' % debug_string
 265         print('Writing version information to src/version.cc')
 266         o = open('src/version.cc', 'w')
 267         o.write(text)
 268         o.close()
 269     except IOError:
 270         print('Could not open src/version.cc for writing\n')
 271         sys.exit(-1)
 272
 273 def post(ctx):
 274     if ctx.cmd == 'install':
 275         ctx.exec_command('/sbin/ldconfig')
 276
 277 def tags(bld):
 278     os.system('etags src/*.cc src/*.h')